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

#include <prmPositionCartesianGet.h>

Inheritance diagram for prmPositionCartesianGet:
mtsGenericObject cmnGenericObject

Public Member Functions

 prmPositionCartesianGet (void)
 prmPositionCartesianGet (const prmPositionCartesianGet &other)
prmPositionCartesianGet & operator= (const prmPositionCartesianGet &other)
 ~prmPositionCartesianGet ()
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)
void GetPosition (vctFrm3 &placeHolder) const
vctFrm3 GetPosition (void) const
void SetPosition (const vctFrm3 &newValue)
const vctFrm3 & Position (void) const
vctFrm3 & Position (void)
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 prmPositionCartesianGet &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

std::string mMovingFrame
std::string mReferenceFrame
vctFrm3 mPosition

Constructor & Destructor Documentation

◆ prmPositionCartesianGet() [1/2]

prmPositionCartesianGet::prmPositionCartesianGet ( void )

◆ prmPositionCartesianGet() [2/2]

prmPositionCartesianGet::prmPositionCartesianGet ( const prmPositionCartesianGet & other)

◆ ~prmPositionCartesianGet()

prmPositionCartesianGet::~prmPositionCartesianGet ( )

Member Function Documentation

◆ Copy()

void prmPositionCartesianGet::Copy ( const prmPositionCartesianGet & source)

◆ DeSerializeRaw()

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

Binary deserialization

Reimplemented from mtsGenericObject.

◆ GetMovingFrame() [1/2]

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

◆ GetMovingFrame() [2/2]

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

◆ GetPosition() [1/2]

void prmPositionCartesianGet::GetPosition ( vctFrm3 & placeHolder) const

◆ GetPosition() [2/2]

vctFrm3 prmPositionCartesianGet::GetPosition ( void ) const
inline

◆ GetReferenceFrame() [1/2]

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

◆ GetReferenceFrame() [2/2]

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

◆ MovingFrame() [1/2]

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

◆ MovingFrame() [2/2]

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

◆ operator=()

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

◆ Position() [1/2]

vctFrm3 & prmPositionCartesianGet::Position ( void )

◆ Position() [2/2]

const vctFrm3 & prmPositionCartesianGet::Position ( void ) const

◆ ReferenceFrame() [1/2]

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

◆ ReferenceFrame() [2/2]

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

◆ ScalarNumber()

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

Binary serialization

Reimplemented from mtsGenericObject.

◆ SetMovingFrame()

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

◆ SetPosition()

void prmPositionCartesianGet::SetPosition ( const vctFrm3 & newValue)

◆ SetReferenceFrame()

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

◆ ToStream()

void prmPositionCartesianGet::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 prmPositionCartesianGet::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 prmPositionCartesianGet::HumanReadable(void) const

◆ mMovingFrame

std::string prmPositionCartesianGet::mMovingFrame
protected

◆ mPosition

vctFrm3 prmPositionCartesianGet::mPosition
protected

◆ mReferenceFrame

std::string prmPositionCartesianGet::mReferenceFrame
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 prmPositionCartesianGet::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