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

#include <prmStateJoint.h>

Inheritance diagram for prmStateJoint:
mtsGenericObject cmnGenericObject

Public Member Functions

 prmStateJoint (void)
 prmStateJoint (const prmStateJoint &other)
prmStateJoint & operator= (const prmStateJoint &other)
 ~prmStateJoint ()
void GetName (std::vector< std::string > &placeHolder) const
std::vector< std::string > GetName (void) const
void SetName (const std::vector< std::string > &newValue)
const std::vector< std::string > & Name (void) const
std::vector< std::string > & Name (void)
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 GetVelocity (vctDynamicVector< double > &placeHolder) const
vctDynamicVector< double > GetVelocity (void) const
void SetVelocity (const vctDynamicVector< double > &newValue)
const vctDynamicVector< double > & Velocity (void) const
vctDynamicVector< double > & Velocity (void)
void GetEffort (vctDynamicVector< double > &placeHolder) const
vctDynamicVector< double > GetEffort (void) const
void SetEffort (const vctDynamicVector< double > &newValue)
const vctDynamicVector< double > & Effort (void) const
vctDynamicVector< double > & Effort (void)
void SetSize (const 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 prmStateJoint &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::vector< std::string > mName
vctDynamicVector< double > mPosition
vctDynamicVector< double > mVelocity
vctDynamicVector< double > mEffort

Constructor & Destructor Documentation

◆ prmStateJoint() [1/2]

prmStateJoint::prmStateJoint ( void )

◆ prmStateJoint() [2/2]

prmStateJoint::prmStateJoint ( const prmStateJoint & other)

◆ ~prmStateJoint()

prmStateJoint::~prmStateJoint ( )

Member Function Documentation

◆ Copy()

void prmStateJoint::Copy ( const prmStateJoint & source)

◆ DeSerializeRaw()

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

Binary deserialization

Reimplemented from mtsGenericObject.

◆ Effort() [1/2]

vctDynamicVector< double > & prmStateJoint::Effort ( void )

◆ Effort() [2/2]

const vctDynamicVector< double > & prmStateJoint::Effort ( void ) const

◆ GetEffort() [1/2]

void prmStateJoint::GetEffort ( vctDynamicVector< double > & placeHolder) const

◆ GetEffort() [2/2]

vctDynamicVector< double > prmStateJoint::GetEffort ( void ) const
inline

◆ GetName() [1/2]

void prmStateJoint::GetName ( std::vector< std::string > & placeHolder) const

◆ GetName() [2/2]

std::vector< std::string > prmStateJoint::GetName ( void ) const
inline

◆ GetPosition() [1/2]

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

◆ GetPosition() [2/2]

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

◆ GetVelocity() [1/2]

void prmStateJoint::GetVelocity ( vctDynamicVector< double > & placeHolder) const

◆ GetVelocity() [2/2]

vctDynamicVector< double > prmStateJoint::GetVelocity ( void ) const
inline

◆ Name() [1/2]

std::vector< std::string > & prmStateJoint::Name ( void )

◆ Name() [2/2]

const std::vector< std::string > & prmStateJoint::Name ( void ) const

◆ operator=()

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

◆ Position() [1/2]

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

◆ Position() [2/2]

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

◆ ScalarNumber()

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

Binary serialization

Reimplemented from mtsGenericObject.

◆ SetEffort()

void prmStateJoint::SetEffort ( const vctDynamicVector< double > & newValue)

◆ SetName()

void prmStateJoint::SetName ( const std::vector< std::string > & newValue)

◆ SetPosition()

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

◆ SetSize()

void prmStateJoint::SetSize ( const size_t & size)
inline

◆ SetVelocity()

void prmStateJoint::SetVelocity ( const vctDynamicVector< double > & newValue)

◆ ToStream()

void prmStateJoint::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 prmStateJoint::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]

vctDynamicVector< double > & prmStateJoint::Velocity ( void )

◆ Velocity() [2/2]

const vctDynamicVector< double > & prmStateJoint::Velocity ( void ) const

Member Data Documentation

◆ HumanReadable

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

◆ mEffort

vctDynamicVector<double> prmStateJoint::mEffort
protected

◆ mName

std::vector<std::string> prmStateJoint::mName
protected

◆ mPosition

vctDynamicVector<double> prmStateJoint::mPosition
protected

◆ mVelocity

vctDynamicVector<double> prmStateJoint::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 prmStateJoint::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