#include <environmentEntitiesCommands.h>

Inheritance diagram for conscience_core::bridging::commands::environment_entities::CommandEntityToPositionGetClosestValidPosition:

Public Member Functions
	CommandEntityToPositionGetClosestValidPosition (const CscPoint3d targetPosition, ptr< CscEntityReflexion > entityReflexion, CscArea3d zone=nullptr, optional< double > distanceWithObjectAutorized={}, optional< int > matrixSize={}, const CscPoint3d startPosition=nullptr, optional< bool > useGnssCoordinates={}, const vector< string > placeModelIdsToIgnore=nullptr, optional< CommandEntityToPositionAlgorithm > algorithm={})

	~CommandEntityToPositionGetClosestValidPosition () override

Public Member Functions inherited from conscience_core::bridging::commands::CscCommand
const CscCommandExecutionResult *	_execute (CscEnvironmentSimulator &environmentSimulator)

template<class TResult = CscCommandExecutionResult>
const TResult *	execute (CscEnvironmentSimulator &environmentSimulator)

const CommandTypeId &	getTypeId () const

virtual	~CscCommand ()

void	setOriginalCommandString (string command)

Static Public Attributes
static const CommandTypeId	COMMAND_ID = "ENTITY_TO_POSITION_GET_CLOSEST_VALID_POSITION"

Protected Member Functions
const CscCommandExecutionResultObject< EntityToPositionGetClosestValidPositionResult > *	doExecute (CscEnvironmentSimulator &environmentSimulator) override

ptr< CscEntityReflexion >	getEntityReflexion () const override

Protected Member Functions inherited from conscience_core::bridging::commands::CscCommand
	CscCommand (const CommandTypeId &typeId)

const CscCommandExecutionResultNone *	resultNone ()

const CscCommandExecutionResultSequence *	resultSequence (CscSequence *sequence, const string &entitySerialNumber, bool doNotPlay=false)

const CscCommandExecutionResultFile *	resultFile (const fs::path &resultingFilePath)

template<class TResult >
const CscCommandExecutionResultObject< TResult > *	resultObject (TResult *result)

const CscWorldElementId	getEntityId () const

Additional Inherited Members
Public Types inherited from conscience_core::bridging::commands::CscCommand
typedef function< void(CscCommand *command)>	CommandExecutedListener

Static Public Member Functions inherited from conscience_core::bridging::commands::CscCommand
static void	addCommandExecutedListener (CommandExecutedListener listener)

Protected Attributes inherited from conscience_core::bridging::commands::CscCommand
const CommandTypeId	typeId

optional< string >	originalCommandString = {}

Detailed Description

The command takes as input a target position and the serial number of the entity. Returns a position; if the input position is accessible, it will be returned as output. Otherwise, the returned position will be the closest possible position. If no position can be found, an error message will be returned.

Constructor & Destructor Documentation

◆ CommandEntityToPositionGetClosestValidPosition()

conscience_core::bridging::commands::environment_entities::CommandEntityToPositionGetClosestValidPosition::CommandEntityToPositionGetClosestValidPosition	(	const CscPoint3d *	targetPosition,
		ptr< CscEntityReflexion >	entityReflexion,
		CscArea3d *	zone = `nullptr`,
		optional< double >	distanceWithObjectAutorized = `{}`,
		optional< int >	matrixSize = `{}`,
		const CscPoint3d *	startPosition = `nullptr`,
		optional< bool >	useGnssCoordinates = `{}`,
		const vector< string > *	placeModelIdsToIgnore = `nullptr`,
		optional< CommandEntityToPositionAlgorithm >	algorithm = `{}`
	)

◆ ~CommandEntityToPositionGetClosestValidPosition()

conscience_core::bridging::commands::environment_entities::CommandEntityToPositionGetClosestValidPosition::~CommandEntityToPositionGetClosestValidPosition ( )

override

Member Function Documentation

◆ doExecute()

const CscCommandExecutionResultObject< EntityToPositionGetClosestValidPositionResult > * conscience_core::bridging::commands::environment_entities::CommandEntityToPositionGetClosestValidPosition::doExecute ( CscEnvironmentSimulator & environmentSimulator )

overrideprotectedvirtual

Implements conscience_core::bridging::commands::CscCommand.

◆ getEntityReflexion()

ptr< CscEntityReflexion > conscience_core::bridging::commands::environment_entities::CommandEntityToPositionGetClosestValidPosition::getEntityReflexion ( ) const

overrideprotectedvirtual

return entity reflexion if this command applies on an entityReflexion, otherwise return nullptr

Implements conscience_core::bridging::commands::CscCommand.

Member Data Documentation

◆ COMMAND_ID

const CommandTypeId conscience_core::bridging::commands::environment_entities::CommandEntityToPositionGetClosestValidPosition::COMMAND_ID = "ENTITY_TO_POSITION_GET_CLOSEST_VALID_POSITION"

inlinestatic

The documentation for this class was generated from the following files:

Bridging/EnvironmentInteractionCommands/environmentEntitiesCommands.h
Bridging/EnvironmentInteractionCommands/environmentEntitiesCommands.cpp

Conscience Core

Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members