RcsPySim
A robot control and simulation library
Rcs::PPDCompound Class Reference

#include <PPDCompound.h>

Inheritance diagram for Rcs::PPDCompound:
Collaboration diagram for Rcs::PPDCompound:

Public Member Functions

 PPDCompound ()
 
virtual ~PPDCompound ()
 
void addChild (PhysicsParameterDescriptor *)
 
virtual void getValues (PropertySink *outValues)
 
virtual void setValues (PropertySource *inValues)
 
const std::vector< PhysicsParameterDescriptor * > & getChildren () const
 
- Public Member Functions inherited from Rcs::PhysicsParameterDescriptor
 PhysicsParameterDescriptor ()
 
virtual ~PhysicsParameterDescriptor ()
 

Protected Member Functions

virtual void init (BodyParamInfo *bodyParamInfo)
 

Private Attributes

std::vector< PhysicsParameterDescriptor * > children
 

Additional Inherited Members

- Protected Attributes inherited from Rcs::PhysicsParameterDescriptor
BodyParamInfobodyParamInfo
 

Detailed Description

Combines multiple child descriptors.

Definition at line 44 of file PPDCompound.h.

Constructor & Destructor Documentation

◆ PPDCompound()

Rcs::PPDCompound::PPDCompound ( )
default

◆ ~PPDCompound()

Rcs::PPDCompound::~PPDCompound ( )
virtual

Definition at line 38 of file PPDCompound.cpp.

Member Function Documentation

◆ addChild()

void Rcs::PPDCompound::addChild ( PhysicsParameterDescriptor child)

Register a child descriptor. Takes ownership of the given object.

Definition at line 59 of file PPDCompound.cpp.

◆ getChildren()

const std::vector< PhysicsParameterDescriptor * > & Rcs::PPDCompound::getChildren ( ) const

Definition at line 72 of file PPDCompound.cpp.

◆ getValues()

void Rcs::PPDCompound::getValues ( PropertySink outValues)
virtual

Read values from graph and put them into the given dict.

Implements Rcs::PhysicsParameterDescriptor.

Definition at line 45 of file PPDCompound.cpp.

◆ init()

void Rcs::PPDCompound::init ( BodyParamInfo bodyParamInfo)
protectedvirtual

Setup descriptor to work on the given body reference. Override for more custom initialization.

Reimplemented from Rcs::PhysicsParameterDescriptor.

Reimplemented in Rcs::PPDCubeExtents, Rcs::PPDBoxExtents, Rcs::PPDBodyOrientation, and Rcs::PPDBodyPosition.

Definition at line 64 of file PPDCompound.cpp.

◆ setValues()

void Rcs::PPDCompound::setValues ( PropertySource inValues)
virtual

Read values from the given dict and apply them to the graph. The parameter names need to be the same as in Rcs, e.g. rolling_friction_coefficient.

Implements Rcs::PhysicsParameterDescriptor.

Reimplemented in Rcs::PPDCubeExtents, Rcs::PPDMassProperties, Rcs::PPDBoxExtents, Rcs::PPDBodyOrientation, and Rcs::PPDBodyPosition.

Definition at line 52 of file PPDCompound.cpp.

Member Data Documentation

◆ children

std::vector<PhysicsParameterDescriptor*> Rcs::PPDCompound::children
private

List of children.

Definition at line 48 of file PPDCompound.h.


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