cisst-saw
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Attributes | List of all members
prmPositionJointGet Class Reference

#include <prmPositionJointGet.h>

Inheritance diagram for prmPositionJointGet:
mtsGenericObject cmnGenericObject

Public Member Functions

 prmPositionJointGet (void)
 
 prmPositionJointGet (const prmPositionJointGet &other)
 
 ~prmPositionJointGet ()
 
void GetPosition (vctDynamicVector< double > &placeHolder) const
 
void SetPosition (const vctDynamicVector< double > &newValue)
 
const vctDynamicVector< double > & Position (void) const
 
vctDynamicVector< double > & Position (void)
 
void GetTimestamps (vctDynamicVector< double > &placeHolder) const
 
void SetTimestamps (const vctDynamicVector< double > &newValue)
 
const vctDynamicVector< double > & Timestamps (void) const
 
vctDynamicVector< double > & Timestamps (void)
 
 prmPositionJointGet (size_t size)
 
void SetSize (size_t size)
 
void SerializeRaw (std::ostream &outputStream) const
 
void DeSerializeRaw (std::istream &inputStream)
 
void ToStream (std::ostream &outputStream) const
 
void ToStreamRaw (std::ostream &outputStream, const char delimiter= ' ', bool headerOnly=false, const std::string &headerPrefix="") const
 
void Copy (const prmPositionJointGet &source)
 
void SerializeBinary (std::ostream &outputStream) const throw (std::runtime_error)
 
void DeSerializeBinary (std::istream &inputStream, const cmnDataFormat &localFormat, const cmnDataFormat &remoteFormat) throw (std::runtime_error)
 
void SerializeText (std::ostream &outputStream, const char delimiter= ',') const throw (std::runtime_error)
 
std::string SerializeDescription (const char delimiter= ',', const std::string &userDescription="") const
 
void DeSerializeText (std::istream &inputStream, const char delimiter= ',') throw (std::runtime_error)
 
std::string HumanReadable (void) const
 
bool ScalarNumberIsFixed (void) const
 
size_t ScalarNumber (void) const
 
double Scalar (const size_t index) const throw (std::out_of_range)
 
std::string ScalarDescription (const size_t index, const std::string &userDescription="") const throw (std::out_of_range)
 
- Public Member Functions inherited from mtsGenericObject
 mtsGenericObject (void)
 
 mtsGenericObject (double timestamp, bool automaticTimestamp, bool valid)
 
 mtsGenericObject (const mtsGenericObject &other)
 
virtual ~mtsGenericObject (void)
 
bool SetTimestampIfAutomatic (double timestamp)
 
virtual bool FromStreamRaw (std::istream &inputStream, const char delimiter= ' ')
 
double Scalar (const size_t index) const throw (std::out_of_range)
 
std::string ScalarDescription (const size_t index, const std::string &userDescription="") const throw (std::out_of_range)
 
- Public Member Functions inherited from cmnGenericObject
virtual ~cmnGenericObject (void)
 
virtual const
cmnClassServicesBase
Services (void) const =0
 
bool ReconstructFrom (const cmnGenericObject &other)
 
std::string ToString (void) const
 
virtual cmnLogger::StreamBufTypeGetLogMultiplexer (void) const
 
virtual double Scalar (const size_t CMN_UNUSED(index)) const throw (std::out_of_range)
 
virtual std::string ScalarDescription (const size_t CMN_UNUSED(index), const std::string &CMN_UNUSED(userDescription)) const
 

Protected Attributes

vctDynamicVector< double > mPosition
 
vctDynamicVector< double > mTimestamps
 

Constructor & Destructor Documentation

prmPositionJointGet::prmPositionJointGet ( void  )
prmPositionJointGet::prmPositionJointGet ( const prmPositionJointGet other)
prmPositionJointGet::~prmPositionJointGet ( )
prmPositionJointGet::prmPositionJointGet ( size_t  size)
inline

Member Function Documentation

void prmPositionJointGet::Copy ( const prmPositionJointGet source)
void prmPositionJointGet::DeSerializeBinary ( std::istream &  inputStream,
const cmnDataFormat localFormat,
const cmnDataFormat remoteFormat 
)
throw (std::runtime_error
)
void prmPositionJointGet::DeSerializeRaw ( std::istream &  inputStream)
virtual

Binary deserialization

Reimplemented from mtsGenericObject.

void prmPositionJointGet::DeSerializeText ( std::istream &  inputStream,
const char  delimiter = ',' 
)
throw (std::runtime_error
)
void prmPositionJointGet::GetPosition ( vctDynamicVector< double > &  placeHolder) const
void prmPositionJointGet::GetTimestamps ( vctDynamicVector< double > &  placeHolder) const
std::string prmPositionJointGet::HumanReadable ( void  ) const
const vctDynamicVector<double>& prmPositionJointGet::Position ( void  ) const
vctDynamicVector<double>& prmPositionJointGet::Position ( void  )
double prmPositionJointGet::Scalar ( const size_t  index) const
throw (std::out_of_range
)
std::string prmPositionJointGet::ScalarDescription ( const size_t  index,
const std::string &  userDescription = "" 
) const
throw (std::out_of_range
)
size_t prmPositionJointGet::ScalarNumber ( void  ) const
virtual

Methods for data visualization. Derived classes should override the following methods in order to be properly processed by the data visualizer of the global component manager.

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

Reimplemented from mtsGenericObject.

bool prmPositionJointGet::ScalarNumberIsFixed ( void  ) const
virtual

Indicates if this object has a fixed number of scalars. This is used for arrays of object in order to optimize random access for a given scalar. When defining an object with a fixed number of scalars, overloading this method to return true allows some optimizations.

Reimplemented from mtsGenericObject.

void prmPositionJointGet::SerializeBinary ( std::ostream &  outputStream) const
throw (std::runtime_error
)
std::string prmPositionJointGet::SerializeDescription ( const char  delimiter = ',',
const std::string &  userDescription = "" 
) const
void prmPositionJointGet::SerializeRaw ( std::ostream &  outputStream) const
virtual

Binary serialization

Reimplemented from mtsGenericObject.

void prmPositionJointGet::SerializeText ( std::ostream &  outputStream,
const char  delimiter = ',' 
) const
throw (std::runtime_error
)
void prmPositionJointGet::SetPosition ( const vctDynamicVector< double > &  newValue)
void prmPositionJointGet::SetSize ( size_t  size)
inline
void prmPositionJointGet::SetTimestamps ( const vctDynamicVector< double > &  newValue)
const vctDynamicVector<double>& prmPositionJointGet::Timestamps ( void  ) const
vctDynamicVector<double>& prmPositionJointGet::Timestamps ( void  )
void prmPositionJointGet::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 mtsGenericObject.

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

Raw text output to stream

Reimplemented from mtsGenericObject.

Member Data Documentation

vctDynamicVector<double> prmPositionJointGet::mPosition
protected
vctDynamicVector<double> prmPositionJointGet::mTimestamps
protected

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