cnoid::ExtraBodyStateAccessor Class Reference

#include <ExtraBodyStateAccessor.h>

Inheritance diagram for cnoid::ExtraBodyStateAccessor:

Classes
class	Angle
struct	None
class	Value

Public Types
enum	Attribute { NORMAL = 0, WARNING = 1 << 0, STRONG_WARNING = WARNING | 1 << 1 }
enum	{   BOOL, INT, DOUBLE, ANGLE,   STRING, VECTOR3, VECTORX, NONE }

Public Member Functions
	ExtraBodyStateAccessor ()
	ExtraBodyStateAccessor (const ExtraBodyStateAccessor &org)
virtual	~ExtraBodyStateAccessor ()
virtual int	getNumStateItems () const =0
virtual int	getNumJointStateItems () const =0
virtual const char *	getStateItemName (int stateIndex) const =0
virtual const char *	getStateItemLabel (int stateIndex) const =0
	Translated version of getStateItemName() More...
virtual const char *	getJointStateItemName (int jointStateIndex) const =0
virtual const char *	getJointStateItemLabel (int jointStateIndex) const =0
	Translated version of getJointStateItemName() More...
virtual void	getState (std::vector< Value > &out_state) const =0
virtual bool	setState (const std::vector< Value > &state) const
virtual void	getJointState (Array2D< Value > &out_jointState) const =0
virtual bool	setJointState (const Array2D< Value > &jointState) const
SignalProxy< void()>	sigStateChanged ()
void	notifyStateChange ()
Public Member Functions inherited from cnoid::Referenced
virtual	~Referenced ()

Static Public Member Functions
static int	getNumValueElements (const Value &v)

Public Attributes
struct cnoid::ExtraBodyStateAccessor::None	none

Additional Inherited Members
Protected Member Functions inherited from cnoid::Referenced
	Referenced ()
	Referenced (const Referenced &)
int	refCount () const

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
BOOL
INT
DOUBLE
ANGLE
STRING
VECTOR3
VECTORX
NONE

Attribute

enum cnoid::ExtraBodyStateAccessor::Attribute

Enumerator
NORMAL
WARNING
STRONG_WARNING

Constructor & Destructor Documentation

ExtraBodyStateAccessor() [1/2]

ExtraBodyStateAccessor::ExtraBodyStateAccessor

(

)

ExtraBodyStateAccessor() [2/2]

ExtraBodyStateAccessor::ExtraBodyStateAccessor

(

const ExtraBodyStateAccessor &

org

)

~ExtraBodyStateAccessor()

ExtraBodyStateAccessor::~ExtraBodyStateAccessor ( )

virtual

Member Function Documentation

getJointState()

virtual void cnoid::ExtraBodyStateAccessor::getJointState ( Array2D< Value > &  out_jointState ) const

pure virtual

Returns

out_jointState 2D array of (jointIndex, itemIndex)

getJointStateItemLabel()

virtual const char* cnoid::ExtraBodyStateAccessor::getJointStateItemLabel ( int  jointStateIndex ) const

pure virtual

Translated version of getJointStateItemName()

getJointStateItemName()

virtual const char* cnoid::ExtraBodyStateAccessor::getJointStateItemName ( int  jointStateIndex ) const

pure virtual

getNumJointStateItems()

virtual int cnoid::ExtraBodyStateAccessor::getNumJointStateItems ( ) const

pure virtual

getNumStateItems()

virtual int cnoid::ExtraBodyStateAccessor::getNumStateItems ( ) const

pure virtual

getNumValueElements()

static int cnoid::ExtraBodyStateAccessor::getNumValueElements ( const Value &  v )

inlinestatic

getState()

virtual void cnoid::ExtraBodyStateAccessor::getState ( std::vector< Value > &  out_state ) const

pure virtual

getStateItemLabel()

virtual const char* cnoid::ExtraBodyStateAccessor::getStateItemLabel ( int  stateIndex ) const

pure virtual

Translated version of getStateItemName()

getStateItemName()

virtual const char* cnoid::ExtraBodyStateAccessor::getStateItemName ( int  stateIndex ) const

pure virtual

notifyStateChange()

void cnoid::ExtraBodyStateAccessor::notifyStateChange ( )

inline

setJointState()

bool ExtraBodyStateAccessor::setJointState ( const Array2D< Value > &  jointState ) const

virtual

This function returns false by default. The function which updates the state values and returns true should be implementedin the inherited class.

setState()

bool ExtraBodyStateAccessor::setState ( const std::vector< Value > &  state ) const

virtual

This function returns false by default. The function which updates the state values and returns true should be implementedin a inherited class.

sigStateChanged()

SignalProxy<void()> cnoid::ExtraBodyStateAccessor::sigStateChanged ( )

inline

Member Data Documentation

none

struct cnoid::ExtraBodyStateAccessor::None cnoid::ExtraBodyStateAccessor::none

---

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

• ExtraBodyStateAccessor.h
• ExtraBodyStateAccessor.cpp