cisst-saw: mtsStateArrayBase Class Reference

#include <mtsStateArrayBase.h>

Inheritance diagram for mtsStateArrayBase:

Public Types
typedef size_t	index_type

typedef size_t	size_type

Public Member Functions
virtual	~mtsStateArrayBase (void)

virtual mtsGenericObject &	operator[] (index_type index)=0

virtual const mtsGenericObject &	operator[] (index_type index) const =0

virtual mtsStateArrayBase *	Create (const mtsGenericObject *objectExample, size_type size)=0

virtual void	Copy (index_type indexTo, index_type indexFrom)=0

virtual bool	Get (index_type index, mtsGenericObject &data) const =0

virtual bool	Set (index_type index, const mtsGenericObject &data)=0

virtual bool	SetDataSize (const size_t size)=0

bool	SetSize (const size_t size)

Protected Member Functions
	mtsStateArrayBase (void)

Protected Attributes
const cmnClassServicesBase *	DataClassServices

Detailed Description

Abstract base class for state data arrays. This class is mostly pure virtual and is used as a base class for mtsStateArray which is templated. Using a base class allows to keep all the state arrays in an homogenous container of pointers on different types of state arrays.

See Also: mtsStateArray

Member Typedef Documentation

typedef size_t mtsStateArrayBase::index_type

typedef size_t mtsStateArrayBase::size_type

Constructor & Destructor Documentation

mtsStateArrayBase::mtsStateArrayBase ( void )

inlineprotected

Protected constructor. Does nothing.

virtual mtsStateArrayBase::~mtsStateArrayBase ( void )

inlinevirtual

Default destructor. Does nothing.

Member Function Documentation

virtual void mtsStateArrayBase::Copy	(	index_type	indexTo,
		index_type	indexFrom
	)

pure virtual

Copy data from one index to another.

Implemented in mtsStateArray< _elementType >, and mtsStateArray< mtsGenericObjectProxy >.

virtual mtsStateArrayBase* mtsStateArrayBase::Create	(	const mtsGenericObject *	objectExample,
		size_type	size
	)

pure virtual

Create the array of data. This is currently unused.

Implemented in mtsStateArray< _elementType >, and mtsStateArray< mtsGenericObjectProxy >.

virtual bool mtsStateArrayBase::Get	(	index_type	index,
		mtsGenericObject &	data
	)		const

pure virtual

Get data from array.

Implemented in mtsStateArray< _elementType >, and mtsStateArray< mtsGenericObjectProxy >.

virtual mtsGenericObject& mtsStateArrayBase::operator[] ( index_type index )

pure virtual

Overloaded subscript operator.

Implemented in mtsStateArray< _elementType >, and mtsStateArray< mtsGenericObjectProxy >.

virtual const mtsGenericObject& mtsStateArrayBase::operator[] ( index_type index ) const

pure virtual

Overloaded subscript operator.

Implemented in mtsStateArray< _elementType >, and mtsStateArray< mtsGenericObjectProxy >.

virtual bool mtsStateArrayBase::Set	(	index_type	index,
		const mtsGenericObject &	data
	)

pure virtual

Set data in array.

Implemented in mtsStateArray< _elementType >, and mtsStateArray< mtsGenericObjectProxy >.

virtual bool mtsStateArrayBase::SetDataSize ( const size_t size )

pure virtual

Implemented in mtsStateArray< _elementType >, and mtsStateArray< mtsGenericObjectProxy >.

bool mtsStateArrayBase::SetSize ( const size_t size )

inline

Member Data Documentation

const cmnClassServicesBase* mtsStateArrayBase::DataClassServices

protected

Class services associated to the element contained

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

/home/adeguet1/catkin_ws/src/cisst-saw/cisst/cisstMultiTask/mtsStateArrayBase.h