Rcs::BoxSpaceProvider Class Reference

#include <BoxSpaceProvider.h>

Inheritance diagram for Rcs::BoxSpaceProvider:

Collaboration diagram for Rcs::BoxSpaceProvider:

Public Member Functions
	BoxSpaceProvider ()
virtual	~BoxSpaceProvider ()
	BoxSpaceProvider (const BoxSpaceProvider &)=delete
BoxSpaceProvider &	operator= (const BoxSpaceProvider &)=delete
	BoxSpaceProvider (BoxSpaceProvider &&)=delete
BoxSpaceProvider &	operator= (BoxSpaceProvider &&)=delete
const BoxSpace *	getSpace () const
virtual unsigned int	getDim () const =0
virtual void	getMinMax (double *min, double *max) const =0
virtual std::vector< std::string >	getNames () const

Private Attributes
BoxSpace *	space

Detailed Description

A class that lazily provides an 1D box space.

Definition at line 43 of file BoxSpaceProvider.h.

Constructor & Destructor Documentation

BoxSpaceProvider() [1/3]

Rcs::BoxSpaceProvider::BoxSpaceProvider

(

)

Definition at line 33 of file BoxSpaceProvider.cpp.

~BoxSpaceProvider()

Rcs::BoxSpaceProvider::~BoxSpaceProvider ( )

virtual

Definition at line 35 of file BoxSpaceProvider.cpp.

BoxSpaceProvider() [2/3]

Rcs::BoxSpaceProvider::BoxSpaceProvider ( const BoxSpaceProvider &  )

delete

BoxSpaceProvider() [3/3]

Rcs::BoxSpaceProvider::BoxSpaceProvider ( BoxSpaceProvider &&  )

delete

Member Function Documentation

getDim()

virtual unsigned int Rcs::BoxSpaceProvider::getDim ( ) const

pure virtual

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.

Implemented in Rcs::AMIKGeneric, Rcs::ObservationModel, Rcs::AMIntegrate2ndOrder, Rcs::AMIntegrate1stOrder, Rcs::AMDynamicalSystemActivation, Rcs::AMIKControllerActivation, Rcs::AMNormalized, Rcs::AMPlateAngPos, Rcs::AMJointControl, Rcs::ISSBoxLifting, Rcs::ISSBoxShelving, Rcs::ISSBallInTube, Rcs::ISSBallOnPlate, Rcs::ISSMiniGolf, Rcs::ISSMPBlending, Rcs::ISSPlanar3Link, Rcs::ISSPlanarInsert, Rcs::AMPlatePos5D, and Rcs::ISSQuanserQube.

getMinMax()

virtual void Rcs::BoxSpaceProvider::getMinMax ( double *  min, double *  max  ) const

pure virtual

Provides minimum and maximum values for the space.

The passed arrays will be large enough to hold getDim() values.

Parameters

[out]	min	minimum value storage
[out]	max	maximum value storage

Implemented in Rcs::AMIKGeneric, Rcs::ObservationModel, Rcs::AMIntegrate2ndOrder, Rcs::AMIntegrate1stOrder, Rcs::AMDynamicalSystemActivation, Rcs::AMIKControllerActivation, Rcs::AMNormalized, Rcs::AMPlateAngPos, Rcs::AMJointControlAcceleration, Rcs::InitStateSetter, Rcs::ISSBoxLifting, Rcs::ISSBoxShelving, Rcs::AMJointControlPosition, Rcs::ISSBallInTube, Rcs::ISSBallOnPlate, Rcs::ISSMiniGolf, Rcs::ISSMPBlending, Rcs::ISSPlanar3Link, Rcs::ISSPlanarInsert, Rcs::AMPlatePos5D, and Rcs::ISSQuanserQube.

getNames()

std::vector< std::string > Rcs::BoxSpaceProvider::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 in Rcs::AMIKGeneric, Rcs::ObservationModel, Rcs::AMIntegrate2ndOrder, Rcs::AMIntegrate1stOrder, Rcs::AMDynamicalSystemActivation, Rcs::AMIKControllerActivation, Rcs::AMNormalized, Rcs::AMPlateAngPos, Rcs::AMJointControlPosition, Rcs::ISSBoxLifting, Rcs::ISSBoxShelving, Rcs::ISSBallInTube, Rcs::ISSBallOnPlate, Rcs::ISSMiniGolf, Rcs::ISSMPBlending, Rcs::ISSPlanar3Link, Rcs::ISSPlanarInsert, Rcs::AMPlatePos5D, and Rcs::ISSQuanserQube.

Definition at line 54 of file BoxSpaceProvider.cpp.

getSpace()

const Rcs::BoxSpace * Rcs::BoxSpaceProvider::getSpace

(

)

const

Compute and return the space.

Definition at line 40 of file BoxSpaceProvider.cpp.

operator=() [1/2]

BoxSpaceProvider& Rcs::BoxSpaceProvider::operator= ( const BoxSpaceProvider &  )

delete

operator=() [2/2]

BoxSpaceProvider& Rcs::BoxSpaceProvider::operator= ( BoxSpaceProvider &&  )

delete

Member Data Documentation

space

BoxSpace* Rcs::BoxSpaceProvider::space

mutableprivate

Definition at line 46 of file BoxSpaceProvider.h.

---

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

• src/cpp/core/util/BoxSpaceProvider.h
• src/cpp/core/util/BoxSpaceProvider.cpp