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

#include <prmPositionCartesianArrayGet.h>

Inheritance diagram for prmPositionCartesianArrayGet:
mtsGenericObject cmnGenericObject

Public Types

typedef std::vector< vctFrm3 > Type

Public Member Functions

 prmPositionCartesianArrayGet (void)
 prmPositionCartesianArrayGet (const prmPositionCartesianArrayGet &other)
prmPositionCartesianArrayGet & operator= (const prmPositionCartesianArrayGet &other)
 ~prmPositionCartesianArrayGet ()
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 GetPositions (std::vector< vctFrm3 > &placeHolder) const
std::vector< vctFrm3 > GetPositions (void) const
void SetPositions (const std::vector< vctFrm3 > &newValue)
const std::vector< vctFrm3 > & Positions (void) const
std::vector< vctFrm3 > & Positions (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 prmPositionCartesianArrayGet &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 mReferenceFrame
std::vector< vctFrm3 > mPositions

Member Typedef Documentation

◆ Type

typedef std::vector<vctFrm3> prmPositionCartesianArrayGet::Type

Constructor & Destructor Documentation

◆ prmPositionCartesianArrayGet() [1/2]

prmPositionCartesianArrayGet::prmPositionCartesianArrayGet ( void )

◆ prmPositionCartesianArrayGet() [2/2]

prmPositionCartesianArrayGet::prmPositionCartesianArrayGet ( const prmPositionCartesianArrayGet & other)

◆ ~prmPositionCartesianArrayGet()

prmPositionCartesianArrayGet::~prmPositionCartesianArrayGet ( )

Member Function Documentation

◆ Copy()

void prmPositionCartesianArrayGet::Copy ( const prmPositionCartesianArrayGet & source)

◆ DeSerializeRaw()

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

Binary deserialization

Reimplemented from mtsGenericObject.

◆ GetPositions() [1/2]

void prmPositionCartesianArrayGet::GetPositions ( std::vector< vctFrm3 > & placeHolder) const

◆ GetPositions() [2/2]

std::vector< vctFrm3 > prmPositionCartesianArrayGet::GetPositions ( void ) const
inline

◆ GetReferenceFrame() [1/2]

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

◆ GetReferenceFrame() [2/2]

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

◆ operator=()

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

◆ Positions() [1/2]

std::vector< vctFrm3 > & prmPositionCartesianArrayGet::Positions ( void )

◆ Positions() [2/2]

const std::vector< vctFrm3 > & prmPositionCartesianArrayGet::Positions ( void ) const

◆ ReferenceFrame() [1/2]

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

◆ ReferenceFrame() [2/2]

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

◆ ScalarNumber()

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

Binary serialization

Reimplemented from mtsGenericObject.

◆ SetPositions()

void prmPositionCartesianArrayGet::SetPositions ( const std::vector< vctFrm3 > & newValue)

◆ SetReferenceFrame()

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

◆ ToStream()

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

◆ mPositions

std::vector<vctFrm3> prmPositionCartesianArrayGet::mPositions
protected

◆ mReferenceFrame

std::string prmPositionCartesianArrayGet::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 prmPositionCartesianArrayGet::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