conscience_core::bridging::commands::CommandPlaySequence Class Reference

#include <CommandPlaySequence.h>

Inheritance diagram for conscience_core::bridging::commands::CommandPlaySequence:

Public Member Functions
	CommandPlaySequence (ptr< CscEntityReflexion > entityReflexion, CscSequence *sequence)
	Creates and returns an executable command to play a sequence on a given entity. More...
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 = "PLAY_SEQUENCE"

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

Protected Attributes
std::unique_ptr< CscLogger >	logger
Protected Attributes inherited from conscience_core::bridging::commands::CscCommand
const CommandTypeId	typeId
optional< string >	originalCommandString = {}

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)

Constructor & Destructor Documentation

CommandPlaySequence()

conscience_core::bridging::commands::CommandPlaySequence::CommandPlaySequence	(	ptr< CscEntityReflexion >	entityReflexion,
		CscSequence *	sequence
	)

Creates and returns an executable command to play a sequence on a given entity.

Parameters

entityReflexion	Shared pointer to the CscEntityReflexion object representing the entity on which to play the sequence.
sequence	encoded CscSequence object representing the sequence to be played.

Member Function Documentation

doExecute()

const CscCommandExecutionResultSequence * conscience_core::bridging::commands::CommandPlaySequence::doExecute ( CscEnvironmentSimulator &  environmentSimulator )

overrideprotectedvirtual

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

getEntityReflexion()

ptr< CscEntityReflexion > conscience_core::bridging::commands::CommandPlaySequence::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::CommandPlaySequence::COMMAND_ID = "PLAY_SEQUENCE"

inlinestatic

logger

std::unique_ptr<CscLogger> conscience_core::bridging::commands::CommandPlaySequence::logger

protected

---

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

• Bridging/EnvironmentInteractionCommands/CommandPlaySequence.h
• Bridging/EnvironmentInteractionCommands/CommandPlaySequence.cpp