Rcs::ISSBallInTube Class Reference

#include <ISSBallInTube.h>

Inheritance diagram for Rcs::ISSBallInTube:

Collaboration diagram for Rcs::ISSBallInTube:

Public Member Functions
	ISSBallInTube (RcsGraph *graph, bool fixedInitState)
virtual	~ISSBallInTube ()
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
BoxSpaceProvider &	operator= (const BoxSpaceProvider &)=delete
	BoxSpaceProvider (BoxSpaceProvider &&)=delete
BoxSpaceProvider &	operator= (BoxSpaceProvider &&)=delete
const BoxSpace *	getSpace () const

Private Attributes
bool	fixedInitState
RcsBody *	platform
RcsBody *	rail

Additional Inherited Members
Protected Attributes inherited from Rcs::InitStateSetter
RcsGraph *	graph

Detailed Description

Initial state setter for the ball-in-tube task. The initial state consists of the the x and y position of the base, and the z position of the rail.

Definition at line 43 of file ISSBallInTube.h.

Constructor & Destructor Documentation

ISSBallInTube()

Rcs::ISSBallInTube::ISSBallInTube	(	RcsGraph *	graph,
		bool	fixedInitState
	)

Constructor. The passed graph must contain the bodies ImetronPlatform, RailBot.

Parameters

graph

graph to set the state on

Definition at line 39 of file ISSBallInTube.cpp.

~ISSBallInTube()

Rcs::ISSBallInTube::~ISSBallInTube ( )

virtual

Definition at line 48 of file ISSBallInTube.cpp.

Member Function Documentation

applyInitialState()

void Rcs::ISSBallInTube::applyInitialState ( const MatNd *  initialState )

overridevirtual

Set initial state of the graph.

Implements Rcs::InitStateSetter.

Definition at line 75 of file ISSBallInTube.cpp.

getDim()

unsigned int Rcs::ISSBallInTube::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 53 of file ISSBallInTube.cpp.

getMinMax()

void Rcs::ISSBallInTube::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 58 of file ISSBallInTube.cpp.

getNames()

std::vector< std::string > Rcs::ISSBallInTube::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 70 of file ISSBallInTube.cpp.

Member Data Documentation

fixedInitState

bool Rcs::ISSBallInTube::fixedInitState

private

Definition at line 64 of file ISSBallInTube.h.

platform

RcsBody* Rcs::ISSBallInTube::platform

private

Definition at line 65 of file ISSBallInTube.h.

rail

RcsBody* Rcs::ISSBallInTube::rail

private

Definition at line 66 of file ISSBallInTube.h.

---

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

• src/cpp/core/initState/ISSBallInTube.h
• src/cpp/core/initState/ISSBallInTube.cpp