ERC CISST - cisst software

---

mtsStateData< _elementType > Class Template Reference

Collaboration diagram for mtsStateData< _elementType >:

[legend]List of all members.

---

Detailed Description

template<class _elementType>
class mtsStateData< _elementType >

Definition at line 52 of file mtsStateData.h.

Public Member Functions

• void Get (const mtsStateIndex &when, value_type &data) const
• void GetLatest (value_type &obj) const
• void GetHistory (const mtsStateIndex &end, mtsVector< value_type > &data) const
• void Set (const value_type &obj)
• mtsStateData ()
• ~mtsStateData ()
• ThisType & operator= (value_type data)
• operator value_type & (void)
• void AddToStateTable (mtsStateTable &table, const std::string &dataName="")
• void AddReadCommandToInterface (mtsInterfaceProvided *interfaceProvided, const std::string &commandName)
• void AddWriteCommandToInterface (mtsInterfaceProvided *interfaceProvided, const std::string &commandName)

Public Attributes

• value_type Data

Protected Types

• typedef mtsStateData< _elementType > ThisType
• typedef mtsStateTable::Accessor<
  _elementType > AccessorType
• typedef _elementType value_type

Protected Attributes

• mtsStateDataId Id
• mtsStateTable * Table
• const AccessorType * Accessor

---

Member Function Documentation

template<class _elementType>

ThisType& mtsStateData< _elementType >::operator=

(

value_type

data

)

[inline]

Conversion assignment. This allows to assign from an object of the actual type without explicitly referencing the public member "Data".

Definition at line 101 of file mtsStateData.h.

References mtsStateData< _elementType >::Data.

template<class _elementType>

mtsStateData< _elementType >::operator value_type &

(

void

)

[inline]

Cast operator. This allows to assign to an object of the actual type without explicitly referencing the public data member "Data".

Definition at line 109 of file mtsStateData.h.

References mtsStateData< _elementType >::Data.

template<class _elementType>

void mtsStateData< _elementType >::AddToStateTable	(	mtsStateTable &	table,
		const std::string &	dataName = ""
	)			[inline]

Adds a new element (array) for this state data to the state table. This is normally called from the constructor. The dataName is optional.

Definition at line 116 of file mtsStateData.h.

References mtsStateData< _elementType >::Accessor, CMN_LOG_INIT_ERROR, mtsStateData< _elementType >::Data, mtsStateTable::GetAccessor(), mtsStateData< _elementType >::Id, mtsStateTable::NewElement(), and mtsStateData< _elementType >::Table.

template<class _elementType>

void mtsStateData< _elementType >::AddReadCommandToInterface	(	mtsInterfaceProvided *	interfaceProvided,
		const std::string &	commandName
	)			[inline]

Adds command objects to the specified device interface. Note that there are two command objects: a 'read' command to get the latest value, and a 'qualified read' command to get the value at the specified time. This is normally called from the constructor, and the commandName would typically be GetXXX, where XXX is the name of the state data.

Definition at line 130 of file mtsStateData.h.

References mtsInterfaceProvided::AddCommandQualifiedRead(), mtsInterfaceProvided::AddCommandRead(), mtsStateData< _elementType >::Get(), mtsStateData< _elementType >::GetHistory(), and mtsStateData< _elementType >::GetLatest().

template<class _elementType>

void mtsStateData< _elementType >::AddWriteCommandToInterface	(	mtsInterfaceProvided *	interfaceProvided,
		const std::string &	commandName
	)			[inline]

Add write command to the specified task interface. Note that this must be a task so that the write is thread-safe.

Definition at line 142 of file mtsStateData.h.

References mtsInterfaceProvided::AddCommandWrite(), and mtsStateData< _elementType >::Set().

---

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

• mtsStateData.h

---