conscience_core::bridging::commands::CommandPing Class Reference

#include <CommandPing.h>

Inheritance diagram for conscience_core::bridging::commands::CommandPing:

Public Member Functions
	CommandPing ()
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 = "PING"

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

Protected Attributes
std::unique_ptr< CscLogger >	logger = CscLogger::getForCategory("CommandPing")
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)

Detailed Description

Simplest ping, returns PONG string

Constructor & Destructor Documentation

CommandPing()

conscience_core::bridging::commands::CommandPing::CommandPing

(

)

Member Function Documentation

doExecute()

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

overrideprotectedvirtual

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

getEntityReflexion()

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

inlinestatic

logger

std::unique_ptr<CscLogger> conscience_core::bridging::commands::CommandPing::logger = CscLogger::getForCategory("CommandPing")

protected

---

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

• Bridging/EnvironmentInteractionCommands/CommandPing.h
• Bridging/EnvironmentInteractionCommands/CommandPing.cpp