ERC CISST - cisst software

mtsGenericObject Class Reference
[Multi Task Support]

#include <mtsGenericObject.h>

Inheritance diagram for mtsGenericObject:

Inheritance graph
[legend]
Collaboration diagram for mtsGenericObject:

Collaboration graph
[legend]
List of all members.

Detailed Description

Base class for data object in cisstMultiTask.

See also:
cmnGenericObject

Definition at line 52 of file mtsGenericObject.h.

Public Member Functions


Constructor & Destructor Documentation

mtsGenericObject::mtsGenericObject ( void   )  [inline]

Constructor, initialize Timestamp to 0 and Valid flag to false.

Definition at line 76 of file mtsGenericObject.h.

mtsGenericObject::mtsGenericObject ( double  timestamp,
bool  automaticTimestamp,
bool  valid 
) [inline]

Constructor with initialization for each member

Definition at line 83 of file mtsGenericObject.h.

mtsGenericObject::mtsGenericObject ( const mtsGenericObject other  )  [inline]

Copy constructor

Definition at line 90 of file mtsGenericObject.h.

virtual mtsGenericObject::~mtsGenericObject ( void   )  [inline, virtual]

Destructor. Does nothing specific.

Definition at line 98 of file mtsGenericObject.h.


Member Function Documentation

bool mtsGenericObject::SetTimestampIfAutomatic ( double  timestamp  ) 

Set timestamp if AutomaticTimeStamp is set to true. This is only meaningful if the derived class contains a timestamp and overrides this method.

Parameters:
timeStamp time stamp in seconds
Returns:
true if time stamp was set.

virtual void mtsGenericObject::ToStream ( std::ostream &  outputStream  )  const [virtual]

Human readable text output. This method only streams the data members of mtsGenericObject, i.e. the Timestamp and Valid flag. It should be called by any derived class re-implementing ToStream.

Reimplemented from cmnGenericObject.

Reimplemented in prmActuatorState, prmEventButton, prmForceCartesianGet, prmForceCartesianSet, prmGainParameters, prmMaskedVector< _elementType >, prmPositionCartesianGet, prmPositionJointGet, prmRobotState, prmVelocityCartesianGet, prmVelocityJointGet, mtsFixedSizeVector< _elementType, _size >, mtsGenericObjectProxy< _elementType >, mtsGenericObjectProxyRef< _elementType >, mtsHistory< _elementType >, mtsIntervalStatistics, mtsMatrix< _elementType >, mtsDescriptionComponent, mtsDescriptionInterface, mtsDescriptionConnection, mtsComponentStatusControl, mtsComponentStateChange, mtsStateIndex, and mtsVector< _elementType >.

Referenced by prmMaskedVector< _elementType >::ToStream(), mtsVector< _elementType >::ToStream(), mtsMatrix< _elementType >::ToStream(), mtsGenericObjectProxyRef< _elementType >::ToStream(), mtsGenericObjectProxy< _elementType >::ToStream(), mtsFixedSizeVector< _elementType, _size >::ToStream(), and prmGainParameters::ToString().

virtual void mtsGenericObject::ToStreamRaw ( std::ostream &  outputStream,
const char  delimiter = ' ',
bool  headerOnly = false,
const std::string &  headerPrefix = "" 
) const [virtual]

Raw text output to stream

Reimplemented from cmnGenericObject.

Reimplemented in prmEventButton, prmForceCartesianGet, prmForceCartesianSet, prmPositionCartesianGet, prmPositionJointGet, prmVelocityCartesianGet, prmVelocityJointGet, mtsFixedSizeVector< _elementType, _size >, mtsGenericObjectProxy< _elementType >, mtsGenericObjectProxyRef< _elementType >, mtsHistory< _elementType >, mtsIntervalStatistics, mtsMatrix< _elementType >, mtsStateIndex, mtsStateTable::IndexRange, and mtsVector< _elementType >.

Referenced by mtsVector< _elementType >::ToStreamRaw(), mtsMatrix< _elementType >::ToStreamRaw(), mtsHistory< _elementType >::ToStreamRaw(), mtsGenericObjectProxyRef< _elementType >::ToStreamRaw(), mtsGenericObjectProxy< _elementType >::ToStreamRaw(), and mtsFixedSizeVector< _elementType, _size >::ToStreamRaw().

virtual void mtsGenericObject::SerializeRaw ( std::ostream &  outputStream  )  const [virtual]

Binary serialization

Reimplemented from cmnGenericObject.

Reimplemented in svlSample, svlSampleImage, svlSampleImageCustom< _ValueType, _DataChannels, _VideoChannels >, svlSampleMatrix, svlSampleMatrixCustom< _ValueType >, svlSampleTargets, svlSampleText, svlSampleTransform3D, prmEventButton, prmForceCartesianGet, prmForceCartesianSet, prmPositionCartesianGet, prmPositionJointGet, prmVelocityCartesianGet, prmVelocityJointGet, mtsFixedSizeVector< _elementType, _size >, mtsGenericObjectProxy< _elementType >, mtsGenericObjectProxyRef< _elementType >, mtsIntervalStatistics, mtsMatrix< _elementType >, mtsDescriptionComponent, mtsDescriptionInterface, mtsDescriptionConnection, mtsComponentStatusControl, mtsComponentStateChange, mtsStateIndex, and mtsVector< _elementType >.

Referenced by svlSampleMatrixCustom< _ValueType >::SerializeRaw(), svlSampleImageCustom< _ValueType, _DataChannels, _VideoChannels >::SerializeRaw(), mtsVector< _elementType >::SerializeRaw(), mtsMatrix< _elementType >::SerializeRaw(), mtsGenericObjectProxyRef< _elementType >::SerializeRaw(), mtsGenericObjectProxy< _elementType >::SerializeRaw(), and mtsFixedSizeVector< _elementType, _size >::SerializeRaw().

virtual void mtsGenericObject::DeSerializeRaw ( std::istream &  inputStream  )  [virtual]

Binary deserialization

Reimplemented from cmnGenericObject.

Reimplemented in svlSample, svlSampleImage, svlSampleImageCustom< _ValueType, _DataChannels, _VideoChannels >, svlSampleMatrix, svlSampleMatrixCustom< _ValueType >, svlSampleTargets, svlSampleText, svlSampleTransform3D, prmEventButton, prmForceCartesianGet, prmForceCartesianSet, prmPositionCartesianGet, prmPositionJointGet, prmVelocityCartesianGet, prmVelocityJointGet, mtsFixedSizeVector< _elementType, _size >, mtsGenericObjectProxy< _elementType >, mtsGenericObjectProxyRef< _elementType >, mtsIntervalStatistics, mtsMatrix< _elementType >, mtsDescriptionComponent, mtsDescriptionInterface, mtsDescriptionConnection, mtsComponentStatusControl, mtsComponentStateChange, mtsStateIndex, and mtsVector< _elementType >.

Referenced by svlSampleMatrixCustom< _ValueType >::DeSerializeRaw(), svlSampleImageCustom< _ValueType, _DataChannels, _VideoChannels >::DeSerializeRaw(), mtsVector< _elementType >::DeSerializeRaw(), mtsMatrix< _elementType >::DeSerializeRaw(), mtsGenericObjectProxyRef< _elementType >::DeSerializeRaw(), mtsGenericObjectProxy< _elementType >::DeSerializeRaw(), and mtsFixedSizeVector< _elementType, _size >::DeSerializeRaw().

virtual unsigned int mtsGenericObject::GetNumberOfScalar ( const bool   CMN_UNUSED(visualizable) = true  )  const [inline, virtual]

Return a number of data (which can be visualized, i.e., type-casted to double)

Definition at line 130 of file mtsGenericObject.h.

virtual double mtsGenericObject::GetScalarAsDouble ( const size_t   CMN_UNUSED(index)  )  const [inline, virtual]

Return the index-th (zero-based) value of data typecasted to double. Note that an index has to be defined such that all indicies are continuous. (This is required by the data visualizer of the GCM UI)

Definition at line 137 of file mtsGenericObject.h.

virtual std::string mtsGenericObject::GetScalarName ( const size_t   CMN_UNUSED(index)  )  const [inline, virtual]

Return the name of index-th (zero-based) data typecasted to double.

Definition at line 142 of file mtsGenericObject.h.


The documentation for this class was generated from the following file:
erc-cisst-devel<at>lists.johnshopkins.edu