Conscience Core
Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
conscience_core::bridging::commands::CommandEntityObstacleStrategySet Class Reference

#include <CommandEntityObstacleStrategySet.h>

Inheritance diagram for conscience_core::bridging::commands::CommandEntityObstacleStrategySet:
conscience_core::bridging::commands::CscCommand

Public Member Functions

 CommandEntityObstacleStrategySet (ptr< CscEntityReflexion > entityReflexion, const EntityObstacleStrategyParamsCommandDataType *parameters)
 
- Public Member Functions inherited from conscience_core::bridging::commands::CscCommand
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_OBSTACLE_STRATEGY_SET"
 

Protected Member Functions

const CscCommandExecutionResultNone * 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

const ptr< CscEntityReflexion > entityReflexion
 
const EntityObstacleStrategyParamsCommandDataType *const parameters
 
std::unique_ptr< CscLogger > logger = CscLogger::getForCategory("CommandEntityObstacleStrategySet")
 
- 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

Set the configuration of obstacle strategy. This configuration will influence the robot’s behavior when facing an obstacle (such as the distance at which it stops before the obstacle).

Constructor & Destructor Documentation

◆ CommandEntityObstacleStrategySet()

conscience_core::bridging::commands::CommandEntityObstacleStrategySet::CommandEntityObstacleStrategySet ( ptr< CscEntityReflexion >  entityReflexion,
const EntityObstacleStrategyParamsCommandDataType *  parameters 
)

Member Function Documentation

◆ doExecute()

const CscCommandExecutionResultNone * conscience_core::bridging::commands::CommandEntityObstacleStrategySet::doExecute ( CscEnvironmentSimulator &  environmentSimulator)
overrideprotectedvirtual

◆ getEntityReflexion()

ptr< CscEntityReflexion > conscience_core::bridging::commands::CommandEntityObstacleStrategySet::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::CommandEntityObstacleStrategySet::COMMAND_ID = "ENTITY_OBSTACLE_STRATEGY_SET"
inlinestatic

◆ entityReflexion

const ptr<CscEntityReflexion> conscience_core::bridging::commands::CommandEntityObstacleStrategySet::entityReflexion
protected

◆ logger

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

◆ parameters

const EntityObstacleStrategyParamsCommandDataType* const conscience_core::bridging::commands::CommandEntityObstacleStrategySet::parameters
protected

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