StateCache Class Reference

the basic building block for the stateless design using the StateStructure class. A StateCache represents a size, a unique id, and a unique name, when inserted into the StateStructure. The size will allocate "size"-doubles in State objects originating from the StateStructure. More...

#include <StateCache.hpp>

Inherited by DeformableObject::DeformableObjectCache, CameraModel::CameraModelCache, Scanner25DModel::Scanner25DModelCache, Scanner2DModel::Scanner2DModelCache, TactileArrayModel::TactileModelCache, BodyContactSensor::ClassState, and TactileArraySensor::ClassState.

Public Types
typedef rw::core::Ptr< StateCache >	Ptr
	Smart pointer type to a StateCache.
typedef rw::core::Ptr< const StateCache >	CPtr
	Smart pointer type to a constant StateCache.

Public Member Functions
virtual	~StateCache ()
	destructor
virtual size_t	size () const =0
	An integer ID for the StateCache. More...
virtual rw::core::Ptr< StateCache >	clone () const =0
	this creates a deep copy of this cache

Detailed Description

the basic building block for the stateless design using the StateStructure class. A StateCache represents a size, a unique id, and a unique name, when inserted into the StateStructure. The size will allocate "size"-doubles in State objects originating from the StateStructure.

Member Function Documentation

size()

virtual size_t size ( ) const

pure virtual

An integer ID for the StateCache.

IDs are assigned to the state data upon insertion State. StateCache that are not in a State have an ID of -1.

StateCache present in different trees may have identical IDs.

IDs are used for the efficient implementation of State. Normally, you should not make use of frame IDs yourself.

Returns

An integer ID for the frame.

The number of doubles allocated by this StateCache in each State object.

Returns

The number of doubles allocated by the StateCache

Implemented in TactileArraySensor::ClassState, BodyContactSensor::ClassState, TactileArrayModel::TactileModelCache, Scanner2DModel::Scanner2DModelCache, Scanner25DModel::Scanner25DModelCache, CameraModel::CameraModelCache, and DeformableObject::DeformableObjectCache.

---

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

• StateCache.hpp