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

#include <ISSPlanar3Link.h>

Inheritance diagram for Rcs::ISSPlanar3Link:
Collaboration diagram for Rcs::ISSPlanar3Link:

Public Member Functions

 ISSPlanar3Link (RcsGraph *graph)
 
virtual ~ISSPlanar3Link ()
 
unsigned int getDim () const override
 
void getMinMax (double *min, double *max) const override
 
virtual std::vector< std::string > getNames () const
 
void applyInitialState (const MatNd *initialState) override
 
- Public Member Functions inherited from Rcs::InitStateSetter
 InitStateSetter (RcsGraph *graph)
 
virtual ~InitStateSetter ()
 
- Public Member Functions inherited from Rcs::BoxSpaceProvider
 BoxSpaceProvider ()
 
virtual ~BoxSpaceProvider ()
 
 BoxSpaceProvider (const BoxSpaceProvider &)=delete
 
BoxSpaceProvideroperator= (const BoxSpaceProvider &)=delete
 
 BoxSpaceProvider (BoxSpaceProvider &&)=delete
 
BoxSpaceProvideroperator= (BoxSpaceProvider &&)=delete
 
const BoxSpacegetSpace () const
 

Private Attributes

RcsBody * link1
 
RcsBody * link2
 
RcsBody * link3
 

Additional Inherited Members

- Protected Attributes inherited from Rcs::InitStateSetter
RcsGraph * graph
 

Detailed Description

Initial state setter for the planar-3-link environment. The initial state consists of the 3 joint angles.

Definition at line 43 of file ISSPlanar3Link.h.

Constructor & Destructor Documentation

◆ ISSPlanar3Link()

Rcs::ISSPlanar3Link::ISSPlanar3Link ( RcsGraph *  graph)

Constructor. The passed graph must contain three bodies named 'Link1', 'Link2', and 'Link3'.

Parameters
graphgraph to set the state on

Definition at line 39 of file ISSPlanar3Link.cpp.

◆ ~ISSPlanar3Link()

Rcs::ISSPlanar3Link::~ISSPlanar3Link ( )
virtual

Definition at line 50 of file ISSPlanar3Link.cpp.

Member Function Documentation

◆ applyInitialState()

void Rcs::ISSPlanar3Link::applyInitialState ( const MatNd *  initialState)
overridevirtual

Set initial state of the graph.

Implements Rcs::InitStateSetter.

Definition at line 76 of file ISSPlanar3Link.cpp.

◆ getDim()

unsigned int Rcs::ISSPlanar3Link::getDim ( ) const
overridevirtual

Provides the number of elements in the space. Since the BoxSpace object will be cached, this must not change.

Returns
number of elements for the space.

Implements Rcs::BoxSpaceProvider.

Definition at line 55 of file ISSPlanar3Link.cpp.

◆ getMinMax()

void Rcs::ISSPlanar3Link::getMinMax ( double *  min,
double *  max 
) const
overridevirtual

Provides the minimum and maximum state values. The default implementation uses -inf and inf.

Reimplemented from Rcs::InitStateSetter.

Definition at line 60 of file ISSPlanar3Link.cpp.

◆ getNames()

std::vector< std::string > Rcs::ISSPlanar3Link::getNames ( ) const
virtual

Provides names for each entry of the space.

These are intended for use in python, i.e., for pandas dataframe column names.

Returns
a vector of name strings. Must be of length getDim() or empty.

Reimplemented from Rcs::BoxSpaceProvider.

Definition at line 71 of file ISSPlanar3Link.cpp.

Member Data Documentation

◆ link1

RcsBody* Rcs::ISSPlanar3Link::link1
private

Definition at line 64 of file ISSPlanar3Link.h.

◆ link2

RcsBody* Rcs::ISSPlanar3Link::link2
private

Definition at line 65 of file ISSPlanar3Link.h.

◆ link3

RcsBody* Rcs::ISSPlanar3Link::link3
private

Definition at line 66 of file ISSPlanar3Link.h.


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