cisst-saw
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Protected Attributes | List of all members
prmVelocityCartesianGet Class Reference

#include <prmVelocityCartesianGet.h>

Inheritance diagram for prmVelocityCartesianGet:
mtsGenericObject cmnGenericObject

Public Member Functions

 prmVelocityCartesianGet (void)
 prmVelocityCartesianGet (const prmVelocityCartesianGet &other)
prmVelocityCartesianGet & operator= (const prmVelocityCartesianGet &other)
 ~prmVelocityCartesianGet ()
void GetVelocity (vct6 &placeHolder) const
vct6 GetVelocity (void) const
void SetVelocity (const vct6 &newValue)
const vct6 & Velocity (void) const
vct6 & Velocity (void)
void GetMovingFrame (std::string &placeHolder) const
std::string GetMovingFrame (void) const
void SetMovingFrame (const std::string &newValue)
const std::string & MovingFrame (void) const
std::string & MovingFrame (void)
void GetReferenceFrame (std::string &placeHolder) const
std::string GetReferenceFrame (void) const
void SetReferenceFrame (const std::string &newValue)
const std::string & ReferenceFrame (void) const
std::string & ReferenceFrame (void)
vctFixedSizeVectorRef< double, 3, 1 > VelocityLinear (void)
vctFixedSizeConstVectorRef< double, 3, 1 > VelocityLinear (void) const
void SetVelocityLinear (const vct3 &v)
vctFixedSizeVectorRef< double, 3, 1 > VelocityAngular (void)
vctFixedSizeConstVectorRef< double, 3, 1 > VelocityAngular (void) const
void SetVelocityAngular (const vct3 &v)
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 prmVelocityCartesianGet &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

vct6 mVelocity
std::string mMovingFrame
std::string mReferenceFrame

Constructor & Destructor Documentation

◆ prmVelocityCartesianGet() [1/2]

prmVelocityCartesianGet::prmVelocityCartesianGet ( void )

◆ prmVelocityCartesianGet() [2/2]

prmVelocityCartesianGet::prmVelocityCartesianGet ( const prmVelocityCartesianGet & other)

◆ ~prmVelocityCartesianGet()

prmVelocityCartesianGet::~prmVelocityCartesianGet ( )

Member Function Documentation

◆ Copy()

void prmVelocityCartesianGet::Copy ( const prmVelocityCartesianGet & source)

◆ DeSerializeRaw()

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

Binary deserialization

Reimplemented from mtsGenericObject.

◆ GetMovingFrame() [1/2]

void prmVelocityCartesianGet::GetMovingFrame ( std::string & placeHolder) const

◆ GetMovingFrame() [2/2]

std::string prmVelocityCartesianGet::GetMovingFrame ( void ) const
inline

◆ GetReferenceFrame() [1/2]

void prmVelocityCartesianGet::GetReferenceFrame ( std::string & placeHolder) const

◆ GetReferenceFrame() [2/2]

std::string prmVelocityCartesianGet::GetReferenceFrame ( void ) const
inline

◆ GetVelocity() [1/2]

void prmVelocityCartesianGet::GetVelocity ( vct6 & placeHolder) const

◆ GetVelocity() [2/2]

vct6 prmVelocityCartesianGet::GetVelocity ( void ) const
inline

◆ MovingFrame() [1/2]

std::string & prmVelocityCartesianGet::MovingFrame ( void )

◆ MovingFrame() [2/2]

const std::string & prmVelocityCartesianGet::MovingFrame ( void ) const

◆ operator=()

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

◆ ReferenceFrame() [1/2]

std::string & prmVelocityCartesianGet::ReferenceFrame ( void )

◆ ReferenceFrame() [2/2]

const std::string & prmVelocityCartesianGet::ReferenceFrame ( void ) const

◆ ScalarNumber()

size_t prmVelocityCartesianGet::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 prmVelocityCartesianGet::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 prmVelocityCartesianGet::SerializeRaw ( std::ostream & outputStream) const
overridevirtual

Binary serialization

Reimplemented from mtsGenericObject.

◆ SetMovingFrame()

void prmVelocityCartesianGet::SetMovingFrame ( const std::string & newValue)

◆ SetReferenceFrame()

void prmVelocityCartesianGet::SetReferenceFrame ( const std::string & newValue)

◆ SetVelocity()

void prmVelocityCartesianGet::SetVelocity ( const vct6 & newValue)

◆ SetVelocityAngular()

void prmVelocityCartesianGet::SetVelocityAngular ( const vct3 & v)
inline

◆ SetVelocityLinear()

void prmVelocityCartesianGet::SetVelocityLinear ( const vct3 & v)
inline

◆ ToStream()

void prmVelocityCartesianGet::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 prmVelocityCartesianGet::ToStreamRaw ( std::ostream & outputStream,
const char delimiter = ' ',
bool headerOnly = false,
const std::string & headerPrefix = "" ) const
overridevirtual

Raw text output to stream

Reimplemented from mtsGenericObject.

◆ Velocity() [1/2]

vct6 & prmVelocityCartesianGet::Velocity ( void )

◆ Velocity() [2/2]

const vct6 & prmVelocityCartesianGet::Velocity ( void ) const

◆ VelocityAngular() [1/2]

vctFixedSizeVectorRef< double, 3, 1 > prmVelocityCartesianGet::VelocityAngular ( void )
inline

◆ VelocityAngular() [2/2]

vctFixedSizeConstVectorRef< double, 3, 1 > prmVelocityCartesianGet::VelocityAngular ( void ) const
inline

◆ VelocityLinear() [1/2]

vctFixedSizeVectorRef< double, 3, 1 > prmVelocityCartesianGet::VelocityLinear ( void )
inline

◆ VelocityLinear() [2/2]

vctFixedSizeConstVectorRef< double, 3, 1 > prmVelocityCartesianGet::VelocityLinear ( void ) const
inline

Member Data Documentation

◆ HumanReadable

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

◆ mMovingFrame

std::string prmVelocityCartesianGet::mMovingFrame
protected

◆ mReferenceFrame

std::string prmVelocityCartesianGet::mReferenceFrame
protected

◆ mVelocity

vct6 prmVelocityCartesianGet::mVelocity
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 prmVelocityCartesianGet::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