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

#include <prmStateCartesian.h>

Inheritance diagram for prmStateCartesian:
mtsGenericObject cmnGenericObject

Public Member Functions

 prmStateCartesian (void)
 prmStateCartesian (const prmStateCartesian &other)
prmStateCartesian & operator= (const prmStateCartesian &other)
 ~prmStateCartesian ()
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 GetPositionIsValid (bool &placeHolder) const
bool GetPositionIsValid (void) const
void SetPositionIsValid (const bool &newValue)
const bool & PositionIsValid (void) const
bool & PositionIsValid (void)
void GetVelocity (vct6 &placeHolder) const
vct6 GetVelocity (void) const
void SetVelocity (const vct6 &newValue)
const vct6 & Velocity (void) const
vct6 & Velocity (void)
void GetVelocityIsValid (bool &placeHolder) const
bool GetVelocityIsValid (void) const
void SetVelocityIsValid (const bool &newValue)
const bool & VelocityIsValid (void) const
bool & VelocityIsValid (void)
void GetForce (vct6 &placeHolder) const
vct6 GetForce (void) const
void SetForce (const vct6 &newValue)
const vct6 & Force (void) const
vct6 & Force (void)
void GetForceIsValid (bool &placeHolder) const
bool GetForceIsValid (void) const
void SetForceIsValid (const bool &newValue)
const bool & ForceIsValid (void) const
bool & ForceIsValid (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 prmStateCartesian &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

Static Public Member Functions

static bool ToPositionCartesianGet (const prmStateCartesian &_state, prmPositionCartesianGet &_position)
static bool ToVelocityCartesianGet (const prmStateCartesian &_state, prmVelocityCartesianGet &_velocity)

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
bool mPositionIsValid
vct6 mVelocity
bool mVelocityIsValid
vct6 mForce
bool mForceIsValid

Constructor & Destructor Documentation

◆ prmStateCartesian() [1/2]

prmStateCartesian::prmStateCartesian ( void )

◆ prmStateCartesian() [2/2]

prmStateCartesian::prmStateCartesian ( const prmStateCartesian & other)

◆ ~prmStateCartesian()

prmStateCartesian::~prmStateCartesian ( )

Member Function Documentation

◆ Copy()

void prmStateCartesian::Copy ( const prmStateCartesian & source)

◆ DeSerializeRaw()

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

Binary deserialization

Reimplemented from mtsGenericObject.

◆ Force() [1/2]

vct6 & prmStateCartesian::Force ( void )

◆ Force() [2/2]

const vct6 & prmStateCartesian::Force ( void ) const

◆ ForceIsValid() [1/2]

bool & prmStateCartesian::ForceIsValid ( void )

◆ ForceIsValid() [2/2]

const bool & prmStateCartesian::ForceIsValid ( void ) const

◆ GetForce() [1/2]

void prmStateCartesian::GetForce ( vct6 & placeHolder) const

◆ GetForce() [2/2]

vct6 prmStateCartesian::GetForce ( void ) const
inline

◆ GetForceIsValid() [1/2]

void prmStateCartesian::GetForceIsValid ( bool & placeHolder) const

◆ GetForceIsValid() [2/2]

bool prmStateCartesian::GetForceIsValid ( void ) const
inline

◆ GetMovingFrame() [1/2]

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

◆ GetMovingFrame() [2/2]

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

◆ GetPosition() [1/2]

void prmStateCartesian::GetPosition ( vctFrm3 & placeHolder) const

◆ GetPosition() [2/2]

vctFrm3 prmStateCartesian::GetPosition ( void ) const
inline

◆ GetPositionIsValid() [1/2]

void prmStateCartesian::GetPositionIsValid ( bool & placeHolder) const

◆ GetPositionIsValid() [2/2]

bool prmStateCartesian::GetPositionIsValid ( void ) const
inline

◆ GetReferenceFrame() [1/2]

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

◆ GetReferenceFrame() [2/2]

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

◆ GetVelocity() [1/2]

void prmStateCartesian::GetVelocity ( vct6 & placeHolder) const

◆ GetVelocity() [2/2]

vct6 prmStateCartesian::GetVelocity ( void ) const
inline

◆ GetVelocityIsValid() [1/2]

void prmStateCartesian::GetVelocityIsValid ( bool & placeHolder) const

◆ GetVelocityIsValid() [2/2]

bool prmStateCartesian::GetVelocityIsValid ( void ) const
inline

◆ MovingFrame() [1/2]

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

◆ MovingFrame() [2/2]

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

◆ operator=()

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

◆ Position() [1/2]

vctFrm3 & prmStateCartesian::Position ( void )

◆ Position() [2/2]

const vctFrm3 & prmStateCartesian::Position ( void ) const

◆ PositionIsValid() [1/2]

bool & prmStateCartesian::PositionIsValid ( void )

◆ PositionIsValid() [2/2]

const bool & prmStateCartesian::PositionIsValid ( void ) const

◆ ReferenceFrame() [1/2]

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

◆ ReferenceFrame() [2/2]

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

◆ ScalarNumber()

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

Binary serialization

Reimplemented from mtsGenericObject.

◆ SetForce()

void prmStateCartesian::SetForce ( const vct6 & newValue)

◆ SetForceIsValid()

void prmStateCartesian::SetForceIsValid ( const bool & newValue)

◆ SetMovingFrame()

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

◆ SetPosition()

void prmStateCartesian::SetPosition ( const vctFrm3 & newValue)

◆ SetPositionIsValid()

void prmStateCartesian::SetPositionIsValid ( const bool & newValue)

◆ SetReferenceFrame()

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

◆ SetVelocity()

void prmStateCartesian::SetVelocity ( const vct6 & newValue)

◆ SetVelocityIsValid()

void prmStateCartesian::SetVelocityIsValid ( const bool & newValue)

◆ ToPositionCartesianGet()

bool prmStateCartesian::ToPositionCartesianGet ( const prmStateCartesian & _state,
prmPositionCartesianGet & _position )
inlinestatic

◆ ToStream()

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

Raw text output to stream

Reimplemented from mtsGenericObject.

◆ ToVelocityCartesianGet()

bool prmStateCartesian::ToVelocityCartesianGet ( const prmStateCartesian & _state,
prmVelocityCartesianGet & _velocity )
inlinestatic

◆ Velocity() [1/2]

vct6 & prmStateCartesian::Velocity ( void )

◆ Velocity() [2/2]

const vct6 & prmStateCartesian::Velocity ( void ) const

◆ VelocityIsValid() [1/2]

bool & prmStateCartesian::VelocityIsValid ( void )

◆ VelocityIsValid() [2/2]

const bool & prmStateCartesian::VelocityIsValid ( void ) const

Member Data Documentation

◆ HumanReadable

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

◆ mForce

vct6 prmStateCartesian::mForce
protected

◆ mForceIsValid

bool prmStateCartesian::mForceIsValid
protected

◆ mMovingFrame

std::string prmStateCartesian::mMovingFrame
protected

◆ mPosition

vctFrm3 prmStateCartesian::mPosition
protected

◆ mPositionIsValid

bool prmStateCartesian::mPositionIsValid
protected

◆ mReferenceFrame

std::string prmStateCartesian::mReferenceFrame
protected

◆ mVelocity

vct6 prmStateCartesian::mVelocity
protected

◆ mVelocityIsValid

bool prmStateCartesian::mVelocityIsValid
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 prmStateCartesian::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