RcsPySim
A robot control and simulation library
Rcs::ECPlanarInsert Class Reference
Inheritance diagram for Rcs::ECPlanarInsert:
Collaboration diagram for Rcs::ECPlanarInsert:

Private Member Functions

virtual ActionModelcreateActionModel ()
 
virtual ObservationModelcreateObservationModel ()
 
virtual void populatePhysicsParameters (PhysicsParameterManager *manager)
 
virtual InitStateSettercreateInitStateSetter ()
 
virtual ForceDisturbercreateForceDisturber ()
 
virtual void initViewer (Rcs::Viewer *viewer)
 
void getHUDText (std::vector< std::string > &linesOut, double currentTime, const MatNd *obs, const MatNd *currentAction, PhysicsBase *simulator, PhysicsParameterManager *physicsManager, ForceDisturber *forceDisturber) override
 

Additional Inherited Members

- Public Types inherited from Rcs::ExperimentConfig
typedef ExperimentConfig *(* ExperimentConfigCreateFunction) ()
 
- Public Member Functions inherited from Rcs::ExperimentConfig
 ExperimentConfig ()
 
virtual ~ExperimentConfig ()
 
PhysicsParameterManagercreatePhysicsParameterManager ()
 
std::string getHUDText (double currentTime, const MatNd *currentObservation, const MatNd *currentAction, PhysicsBase *simulator, PhysicsParameterManager *physicsManager, ForceDisturber *forceDisturber)
 
- Static Public Member Functions inherited from Rcs::ExperimentConfig
static void registerType (const char *name, ExperimentConfigCreateFunction creator)
 
static ExperimentConfigcreate (PropertySource *properties)
 
- Public Attributes inherited from Rcs::ExperimentConfig
PropertySourceproperties
 
RcsGraph * graph
 
ActionModelactionModel
 
ObservationModelobservationModel
 
RcsCollisionMdl * collisionMdl
 
double dt
 
bool checkJointLimits
 
- Protected Member Functions inherited from Rcs::ExperimentConfig
virtual void load (PropertySource *properties)
 

Detailed Description

Definition at line 77 of file ECPlanarInsert.cpp.

Member Function Documentation

◆ createActionModel()

virtual ActionModel* Rcs::ECPlanarInsert::createActionModel ( )
inlineprivatevirtual

Create the action model. Read any configuration from this->properties.

Returns
the new action model

Implements Rcs::ExperimentConfig.

Definition at line 79 of file ECPlanarInsert.cpp.

◆ createForceDisturber()

virtual ForceDisturber* Rcs::ECPlanarInsert::createForceDisturber ( )
inlineprivatevirtual

Create a model for artificial external disturbing forces. The default implementation returns NULL to ignore this.

Returns
the new force disturber

Reimplemented from Rcs::ExperimentConfig.

Definition at line 289 of file ECPlanarInsert.cpp.

◆ createInitStateSetter()

virtual InitStateSetter* Rcs::ECPlanarInsert::createInitStateSetter ( )
inlineprivatevirtual

Create the init state setter. Read any configuration from this->properties. Since the init state setter is only needed for the simulation, it is not stored in the ExperimentConfig. Instead, the simulation calls this method and manages the object on it's own. The default implementation returns NULL to use the state from the graph file.

Returns
the new init state setter

Reimplemented from Rcs::ExperimentConfig.

Definition at line 284 of file ECPlanarInsert.cpp.

◆ createObservationModel()

virtual ObservationModel* Rcs::ECPlanarInsert::createObservationModel ( )
inlineprivatevirtual

Create the observation model. Read any configuration from this->properties.

Returns
the new observation model

Implements Rcs::ExperimentConfig.

Definition at line 175 of file ECPlanarInsert.cpp.

◆ getHUDText()

void Rcs::ECPlanarInsert::getHUDText ( std::vector< std::string > &  linesOut,
double  currentTime,
const MatNd *  currentObservation,
const MatNd *  currentAction,
PhysicsBase *  simulator,
PhysicsParameterManager physicsManager,
ForceDisturber forceDisturber 
)
inlineoverrideprivatevirtual

Called to update the HUD text for the viewer. The default implementation will show the physics engine name, the current time.

Parameters
[out]linesOutvector of HUD lines. initially empty.
[in]currentTimesimulation time
[in]currentObservationlatest observation
[in]currentActionlatest action
[in]simulatorphysics simulator or NULL if none
[in]physicsManagerphysics parameter manager or NULL if none
[in]forceDisturberdistruber which applies the forces to a given body
Returns
concatenated HUD lines

Reimplemented from Rcs::ExperimentConfig.

Definition at line 324 of file ECPlanarInsert.cpp.

◆ initViewer()

virtual void Rcs::ECPlanarInsert::initViewer ( Rcs::Viewer *  viewer)
inlineprivatevirtual

Perform additional initialization on the viewer. This could, for example, change the camera position or add additional visualization. The default implementation does nothing.

Reimplemented from Rcs::ExperimentConfig.

Definition at line 296 of file ECPlanarInsert.cpp.

◆ populatePhysicsParameters()

virtual void Rcs::ECPlanarInsert::populatePhysicsParameters ( PhysicsParameterManager manager)
inlineprivatevirtual

Add the physics parameter descriptors to the given physics parameter manager.

Parameters
managerparameter manager to populate.

Reimplemented from Rcs::ExperimentConfig.

Definition at line 273 of file ECPlanarInsert.cpp.


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