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

#include <environmentPlacesCommands.h>

Inheritance diagram for conscience_core::bridging::commands::environment_places::CommandPlaceInsert:
conscience_core::bridging::commands::CscCommand

Public Member Functions

 CommandPlaceInsert (ptr< const CscPlaceModel > placeModel, optional< ptr< CscPoint3d >> position, optional< ptr< CscPoint3d >> rotation, optional< bool > removeOtherPlaces)
 
 ~CommandPlaceInsert () 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 CommandTypeIdgetTypeId () const
 
virtual ~CscCommand ()
 
void setOriginalCommandString (string command)
 

Static Public Attributes

static const CommandTypeId COMMAND_ID = "PLACE_INSERT"
 

Protected Member Functions

const CscCommandExecutionResultStringdoExecute (CscEnvironmentSimulator &environmentSimulator) override
 
ptr< CscEntityReflexiongetEntityReflexion () const override
 
- Protected Member Functions inherited from conscience_core::bridging::commands::CscCommand
 CscCommand (const CommandTypeId &typeId)
 
const CscCommandExecutionResultNoneresultNone ()
 
const CscCommandExecutionResultSequenceresultSequence (CscSequence *sequence, const string &entitySerialNumber, bool doNotPlay=false)
 
const CscCommandExecutionResultFileresultFile (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

Insert a place in the environment

Returns id of the inserted place

Constructor & Destructor Documentation

◆ CommandPlaceInsert()

conscience_core::bridging::commands::environment_places::CommandPlaceInsert::CommandPlaceInsert ( ptr< const CscPlaceModel placeModel,
optional< ptr< CscPoint3d >>  position,
optional< ptr< CscPoint3d >>  rotation,
optional< bool >  removeOtherPlaces 
)

Sets the parameters for inserting an object. It is possible to provide rotation, mass in grams, and a type of physics (0 => BOUNDING_BOX, 1 => CONCAVE, 2 => CONVEX, 3 => FROM_MODEL, 4 => GHOST, 5 => STATIC). It is possible to specify a member of an entity in the simulation to load the object from the robot's position, in which case the provided position becomes relative to the robot's position. In the case of a relative position, the serial number of the entity in the simulator must be provided.

◆ ~CommandPlaceInsert()

conscience_core::bridging::commands::environment_places::CommandPlaceInsert::~CommandPlaceInsert ( )
override

Member Function Documentation

◆ doExecute()

const CscCommandExecutionResultString * conscience_core::bridging::commands::environment_places::CommandPlaceInsert::doExecute ( CscEnvironmentSimulator environmentSimulator)
overrideprotectedvirtual

◆ getEntityReflexion()

ptr< CscEntityReflexion > conscience_core::bridging::commands::environment_places::CommandPlaceInsert::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::CommandPlaceInsert::COMMAND_ID = "PLACE_INSERT"
inlinestatic

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