conscience_core::bridging::commands::environment_entities::CommandEntityStreamStart Class Reference

#include <environmentEntitiesCommands.h>

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

Public Member Functions
	CommandEntityStreamStart (const EntityStreamStartParamsCommandDataType *parameters)
	~CommandEntityStreamStart () 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_STREAM_START"

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

Request start playing stream for given entity serialNumber and streamId. This will make sure stream is available at the moment unless noErrorIfStreamUnavailable is true. Returns the access token.

Constructor & Destructor Documentation

CommandEntityStreamStart()

conscience_core::bridging::commands::environment_entities::CommandEntityStreamStart::CommandEntityStreamStart

(

const EntityStreamStartParamsCommandDataType *

parameters

)

~CommandEntityStreamStart()

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

override

Member Function Documentation

doExecute()

const CscCommandExecutionResultString * conscience_core::bridging::commands::environment_entities::CommandEntityStreamStart::doExecute ( CscEnvironmentSimulator &  environmentSimulator )

overrideprotectedvirtual

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

getEntityReflexion()

ptr< CscEntityReflexion > conscience_core::bridging::commands::environment_entities::CommandEntityStreamStart::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::CommandEntityStreamStart::COMMAND_ID = "ENTITY_STREAM_START"

inlinestatic

---

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

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