#include <environmentPlacesCommands.h>

Inheritance diagram for conscience_core::bridging::commands::environment_places::CommandPlacesGet:

Public Member Functions
	CommandPlacesGet (const optional< ptr< PlacesGetFiltersCommandDataType >> &filters=nullopt)

	~CommandPlacesGet () 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 = "PLACES_GET"

Protected Member Functions
const CscCommandExecutionResultList< WorldPlaceCommandDataType > *	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

Gets places from the environment. Returns the list of places currently loaded in the environment.

Constructor & Destructor Documentation

◆ CommandPlacesGet()

conscience_core::bridging::commands::environment_places::CommandPlacesGet::CommandPlacesGet ( const optional< ptr< PlacesGetFiltersCommandDataType >> & filters = nullopt )

◆ ~CommandPlacesGet()

conscience_core::bridging::commands::environment_places::CommandPlacesGet::~CommandPlacesGet ( )

override

Member Function Documentation

◆ doExecute()

const CscCommandExecutionResultList< WorldPlaceCommandDataType > * conscience_core::bridging::commands::environment_places::CommandPlacesGet::doExecute ( CscEnvironmentSimulator & environmentSimulator )

overrideprotectedvirtual

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

◆ getEntityReflexion()

ptr< CscEntityReflexion > conscience_core::bridging::commands::environment_places::CommandPlacesGet::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_places::CommandPlacesGet::COMMAND_ID = "PLACES_GET"

inlinestatic

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

Bridging/EnvironmentInteractionCommands/environmentPlacesCommands.h
Bridging/EnvironmentInteractionCommands/environmentPlacesCommands.cpp

Conscience Core

Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members