cisst-saw
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | 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 & operator= (const prmPositionJointGet &other)
 ~prmPositionJointGet ()
void GetPosition (vctDynamicVector< double > &placeHolder) const
vctDynamicVector< double > GetPosition (void) const
void SetPosition (const vctDynamicVector< double > &newValue)
const vctDynamicVector< double > & Position (void) const
vctDynamicVector< double > & Position (void)
void GetTimestamps (vctDynamicVector< double > &placeHolder) const
vctDynamicVector< double > GetTimestamps (void) 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 override
void DeSerializeRaw (std::istream &inputStream) override
void ToStream (std::ostream &outputStream) const override
void ToStreamRaw (std::ostream &outputStream, const char delimiter=' ', bool headerOnly=false, const std::string &headerPrefix="") const override
void Copy (const prmPositionJointGet &source)
bool ScalarNumberIsFixed (void) const override
size_t ScalarNumber (void) const override
Public Member Functions inherited from mtsGenericObject
 mtsGenericObject (void)
 mtsGenericObject (double timestamp, bool automaticTimestamp, bool valid)
 mtsGenericObject (const mtsGenericObject &other)
virtual ~mtsGenericObject (void)
mtsGenericObject & operator= (const mtsGenericObject &other)
bool SetTimestampIfAutomatic (double timestamp)
virtual bool FromStreamRaw (std::istream &inputStream, const char delimiter=' ')
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::StreamBufType * GetLogMultiplexer (void) const
virtual double Scalar (const size_t CMN_UNUSED(index)) const CISST_THROW(std
virtual std::string ScalarDescription (const size_t CMN_UNUSED(index), const std::string &CMN_UNUSED(userDescription)) const

Public Attributes

void SerializeBinary(std::ostream &outputStream) const CISST_THROW(std void DeSerializeBinary(std::istream &inputStream, const cmnDataFormat &localFormat, const cmnDataFormat &remoteFormat) CISST_THROW(std void SerializeText(std::ostream &outputStream, const char delimiter=',') const CISST_THROW(std std::string SerializeDescription (const char delimiter=',', const std::string &userDescription="") const
void DeSerializeText(std::istream &inputStream, const char delimiter=',') CISST_THROW(std std::string HumanReadable (void) const

Protected Attributes

vctDynamicVector< double > mPosition
vctDynamicVector< double > mTimestamps

Constructor & Destructor Documentation

◆ prmPositionJointGet() [1/3]

prmPositionJointGet::prmPositionJointGet ( void )

◆ prmPositionJointGet() [2/3]

prmPositionJointGet::prmPositionJointGet ( const prmPositionJointGet & other)

◆ ~prmPositionJointGet()

prmPositionJointGet::~prmPositionJointGet ( )

◆ prmPositionJointGet() [3/3]

prmPositionJointGet::prmPositionJointGet ( size_t size)
inline

Member Function Documentation

◆ Copy()

void prmPositionJointGet::Copy ( const prmPositionJointGet & source)

◆ DeSerializeRaw()

void prmPositionJointGet::DeSerializeRaw ( std::istream & inputStream)
overridevirtual

Binary deserialization

Reimplemented from mtsGenericObject.

◆ GetPosition() [1/2]

void prmPositionJointGet::GetPosition ( vctDynamicVector< double > & placeHolder) const

◆ GetPosition() [2/2]

vctDynamicVector< double > prmPositionJointGet::GetPosition ( void ) const
inline

◆ GetTimestamps() [1/2]

void prmPositionJointGet::GetTimestamps ( vctDynamicVector< double > & placeHolder) const

◆ GetTimestamps() [2/2]

vctDynamicVector< double > prmPositionJointGet::GetTimestamps ( void ) const
inline

◆ operator=()

prmPositionJointGet & prmPositionJointGet::operator= ( const prmPositionJointGet & other)

◆ Position() [1/2]

vctDynamicVector< double > & prmPositionJointGet::Position ( void )

◆ Position() [2/2]

const vctDynamicVector< double > & prmPositionJointGet::Position ( void ) const

◆ ScalarNumber()

size_t prmPositionJointGet::ScalarNumber ( void ) const
overridevirtual

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.

◆ ScalarNumberIsFixed()

bool prmPositionJointGet::ScalarNumberIsFixed ( void ) const
overridevirtual

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.

◆ SerializeRaw()

void prmPositionJointGet::SerializeRaw ( std::ostream & outputStream) const
overridevirtual

Binary serialization

Reimplemented from mtsGenericObject.

◆ SetPosition()

void prmPositionJointGet::SetPosition ( const vctDynamicVector< double > & newValue)

◆ SetSize()

void prmPositionJointGet::SetSize ( size_t size)
inline

◆ SetTimestamps()

void prmPositionJointGet::SetTimestamps ( const vctDynamicVector< double > & newValue)

◆ Timestamps() [1/2]

vctDynamicVector< double > & prmPositionJointGet::Timestamps ( void )

◆ Timestamps() [2/2]

const vctDynamicVector< double > & prmPositionJointGet::Timestamps ( void ) const

◆ ToStream()

void prmPositionJointGet::ToStream ( std::ostream & outputStream) const
overridevirtual

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.

◆ ToStreamRaw()

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

Raw text output to stream

Reimplemented from mtsGenericObject.

Member Data Documentation

◆ HumanReadable

void DeSerializeText(std::istream &inputStream, const char delimiter=',') CISST_THROW(std std::string prmPositionJointGet::HumanReadable(void) const

◆ mPosition

vctDynamicVector<double> prmPositionJointGet::mPosition
protected

◆ mTimestamps

vctDynamicVector<double> prmPositionJointGet::mTimestamps
protected

◆ SerializeDescription

void SerializeBinary(std::ostream &outputStream) const CISST_THROW(std void DeSerializeBinary(std::istream &inputStream, const cmnDataFormat &localFormat, const cmnDataFormat &remoteFormat) CISST_THROW(std void SerializeText(std::ostream &outputStream, const char delimiter=',') const CISST_THROW(std std::string prmPositionJointGet::SerializeDescription(const char delimiter=',', const std::string &userDescription="") const
The documentation for this class was generated from the following file:
Generated by doxygen 1.18.0