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

#include <prmConfigurationJoint.h>

Inheritance diagram for prmConfigurationJoint:
mtsGenericObject cmnGenericObject

Public Member Functions

 prmConfigurationJoint (void)
 prmConfigurationJoint (const prmConfigurationJoint &other)
prmConfigurationJoint & operator= (const prmConfigurationJoint &other)
 ~prmConfigurationJoint ()
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 GetType (vctDynamicVector< cmnJointType > &placeHolder) const
vctDynamicVector< cmnJointType > GetType (void) const
void SetType (const vctDynamicVector< cmnJointType > &newValue)
const vctDynamicVector< cmnJointType > & Type (void) const
vctDynamicVector< cmnJointType > & Type (void)
void GetPositionMin (vctDynamicVector< double > &placeHolder) const
vctDynamicVector< double > GetPositionMin (void) const
void SetPositionMin (const vctDynamicVector< double > &newValue)
const vctDynamicVector< double > & PositionMin (void) const
vctDynamicVector< double > & PositionMin (void)
void GetPositionMax (vctDynamicVector< double > &placeHolder) const
vctDynamicVector< double > GetPositionMax (void) const
void SetPositionMax (const vctDynamicVector< double > &newValue)
const vctDynamicVector< double > & PositionMax (void) const
vctDynamicVector< double > & PositionMax (void)
void GetVelocityMin (vctDynamicVector< double > &placeHolder) const
vctDynamicVector< double > GetVelocityMin (void) const
void SetVelocityMin (const vctDynamicVector< double > &newValue)
const vctDynamicVector< double > & VelocityMin (void) const
vctDynamicVector< double > & VelocityMin (void)
void GetVelocityMax (vctDynamicVector< double > &placeHolder) const
vctDynamicVector< double > GetVelocityMax (void) const
void SetVelocityMax (const vctDynamicVector< double > &newValue)
const vctDynamicVector< double > & VelocityMax (void) const
vctDynamicVector< double > & VelocityMax (void)
void GetAccelerationMin (vctDynamicVector< double > &placeHolder) const
vctDynamicVector< double > GetAccelerationMin (void) const
void SetAccelerationMin (const vctDynamicVector< double > &newValue)
const vctDynamicVector< double > & AccelerationMin (void) const
vctDynamicVector< double > & AccelerationMin (void)
void GetAccelerationMax (vctDynamicVector< double > &placeHolder) const
vctDynamicVector< double > GetAccelerationMax (void) const
void SetAccelerationMax (const vctDynamicVector< double > &newValue)
const vctDynamicVector< double > & AccelerationMax (void) const
vctDynamicVector< double > & AccelerationMax (void)
void GetEffortMin (vctDynamicVector< double > &placeHolder) const
vctDynamicVector< double > GetEffortMin (void) const
void SetEffortMin (const vctDynamicVector< double > &newValue)
const vctDynamicVector< double > & EffortMin (void) const
vctDynamicVector< double > & EffortMin (void)
void GetEffortMax (vctDynamicVector< double > &placeHolder) const
vctDynamicVector< double > GetEffortMax (void) const
void SetEffortMax (const vctDynamicVector< double > &newValue)
const vctDynamicVector< double > & EffortMax (void) const
vctDynamicVector< double > & EffortMax (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 prmConfigurationJoint &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< cmnJointType > mType
vctDynamicVector< double > mPositionMin
vctDynamicVector< double > mPositionMax
vctDynamicVector< double > mVelocityMin
vctDynamicVector< double > mVelocityMax
vctDynamicVector< double > mAccelerationMin
vctDynamicVector< double > mAccelerationMax
vctDynamicVector< double > mEffortMin
vctDynamicVector< double > mEffortMax

Constructor & Destructor Documentation

◆ prmConfigurationJoint() [1/2]

prmConfigurationJoint::prmConfigurationJoint ( void )

◆ prmConfigurationJoint() [2/2]

prmConfigurationJoint::prmConfigurationJoint ( const prmConfigurationJoint & other)

◆ ~prmConfigurationJoint()

prmConfigurationJoint::~prmConfigurationJoint ( )

Member Function Documentation

◆ AccelerationMax() [1/2]

vctDynamicVector< double > & prmConfigurationJoint::AccelerationMax ( void )

◆ AccelerationMax() [2/2]

const vctDynamicVector< double > & prmConfigurationJoint::AccelerationMax ( void ) const

◆ AccelerationMin() [1/2]

vctDynamicVector< double > & prmConfigurationJoint::AccelerationMin ( void )

◆ AccelerationMin() [2/2]

const vctDynamicVector< double > & prmConfigurationJoint::AccelerationMin ( void ) const

◆ Copy()

void prmConfigurationJoint::Copy ( const prmConfigurationJoint & source)

◆ DeSerializeRaw()

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

Binary deserialization

Reimplemented from mtsGenericObject.

◆ EffortMax() [1/2]

vctDynamicVector< double > & prmConfigurationJoint::EffortMax ( void )

◆ EffortMax() [2/2]

const vctDynamicVector< double > & prmConfigurationJoint::EffortMax ( void ) const

◆ EffortMin() [1/2]

vctDynamicVector< double > & prmConfigurationJoint::EffortMin ( void )

◆ EffortMin() [2/2]

const vctDynamicVector< double > & prmConfigurationJoint::EffortMin ( void ) const

◆ GetAccelerationMax() [1/2]

void prmConfigurationJoint::GetAccelerationMax ( vctDynamicVector< double > & placeHolder) const

◆ GetAccelerationMax() [2/2]

vctDynamicVector< double > prmConfigurationJoint::GetAccelerationMax ( void ) const
inline

◆ GetAccelerationMin() [1/2]

void prmConfigurationJoint::GetAccelerationMin ( vctDynamicVector< double > & placeHolder) const

◆ GetAccelerationMin() [2/2]

vctDynamicVector< double > prmConfigurationJoint::GetAccelerationMin ( void ) const
inline

◆ GetEffortMax() [1/2]

void prmConfigurationJoint::GetEffortMax ( vctDynamicVector< double > & placeHolder) const

◆ GetEffortMax() [2/2]

vctDynamicVector< double > prmConfigurationJoint::GetEffortMax ( void ) const
inline

◆ GetEffortMin() [1/2]

void prmConfigurationJoint::GetEffortMin ( vctDynamicVector< double > & placeHolder) const

◆ GetEffortMin() [2/2]

vctDynamicVector< double > prmConfigurationJoint::GetEffortMin ( void ) const
inline

◆ GetName() [1/2]

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

◆ GetName() [2/2]

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

◆ GetPositionMax() [1/2]

void prmConfigurationJoint::GetPositionMax ( vctDynamicVector< double > & placeHolder) const

◆ GetPositionMax() [2/2]

vctDynamicVector< double > prmConfigurationJoint::GetPositionMax ( void ) const
inline

◆ GetPositionMin() [1/2]

void prmConfigurationJoint::GetPositionMin ( vctDynamicVector< double > & placeHolder) const

◆ GetPositionMin() [2/2]

vctDynamicVector< double > prmConfigurationJoint::GetPositionMin ( void ) const
inline

◆ GetType() [1/2]

void prmConfigurationJoint::GetType ( vctDynamicVector< cmnJointType > & placeHolder) const

◆ GetType() [2/2]

vctDynamicVector< cmnJointType > prmConfigurationJoint::GetType ( void ) const
inline

◆ GetVelocityMax() [1/2]

void prmConfigurationJoint::GetVelocityMax ( vctDynamicVector< double > & placeHolder) const

◆ GetVelocityMax() [2/2]

vctDynamicVector< double > prmConfigurationJoint::GetVelocityMax ( void ) const
inline

◆ GetVelocityMin() [1/2]

void prmConfigurationJoint::GetVelocityMin ( vctDynamicVector< double > & placeHolder) const

◆ GetVelocityMin() [2/2]

vctDynamicVector< double > prmConfigurationJoint::GetVelocityMin ( void ) const
inline

◆ Name() [1/2]

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

◆ Name() [2/2]

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

◆ operator=()

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

◆ PositionMax() [1/2]

vctDynamicVector< double > & prmConfigurationJoint::PositionMax ( void )

◆ PositionMax() [2/2]

const vctDynamicVector< double > & prmConfigurationJoint::PositionMax ( void ) const

◆ PositionMin() [1/2]

vctDynamicVector< double > & prmConfigurationJoint::PositionMin ( void )

◆ PositionMin() [2/2]

const vctDynamicVector< double > & prmConfigurationJoint::PositionMin ( void ) const

◆ ScalarNumber()

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

Binary serialization

Reimplemented from mtsGenericObject.

◆ SetAccelerationMax()

void prmConfigurationJoint::SetAccelerationMax ( const vctDynamicVector< double > & newValue)

◆ SetAccelerationMin()

void prmConfigurationJoint::SetAccelerationMin ( const vctDynamicVector< double > & newValue)

◆ SetEffortMax()

void prmConfigurationJoint::SetEffortMax ( const vctDynamicVector< double > & newValue)

◆ SetEffortMin()

void prmConfigurationJoint::SetEffortMin ( const vctDynamicVector< double > & newValue)

◆ SetName()

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

◆ SetPositionMax()

void prmConfigurationJoint::SetPositionMax ( const vctDynamicVector< double > & newValue)

◆ SetPositionMin()

void prmConfigurationJoint::SetPositionMin ( const vctDynamicVector< double > & newValue)

◆ SetType()

void prmConfigurationJoint::SetType ( const vctDynamicVector< cmnJointType > & newValue)

◆ SetVelocityMax()

void prmConfigurationJoint::SetVelocityMax ( const vctDynamicVector< double > & newValue)

◆ SetVelocityMin()

void prmConfigurationJoint::SetVelocityMin ( const vctDynamicVector< double > & newValue)

◆ ToStream()

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

Raw text output to stream

Reimplemented from mtsGenericObject.

◆ Type() [1/2]

vctDynamicVector< cmnJointType > & prmConfigurationJoint::Type ( void )

◆ Type() [2/2]

const vctDynamicVector< cmnJointType > & prmConfigurationJoint::Type ( void ) const

◆ VelocityMax() [1/2]

vctDynamicVector< double > & prmConfigurationJoint::VelocityMax ( void )

◆ VelocityMax() [2/2]

const vctDynamicVector< double > & prmConfigurationJoint::VelocityMax ( void ) const

◆ VelocityMin() [1/2]

vctDynamicVector< double > & prmConfigurationJoint::VelocityMin ( void )

◆ VelocityMin() [2/2]

const vctDynamicVector< double > & prmConfigurationJoint::VelocityMin ( void ) const

Member Data Documentation

◆ HumanReadable

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

◆ mAccelerationMax

vctDynamicVector<double> prmConfigurationJoint::mAccelerationMax
protected

◆ mAccelerationMin

vctDynamicVector<double> prmConfigurationJoint::mAccelerationMin
protected

◆ mEffortMax

vctDynamicVector<double> prmConfigurationJoint::mEffortMax
protected

◆ mEffortMin

vctDynamicVector<double> prmConfigurationJoint::mEffortMin
protected

◆ mName

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

◆ mPositionMax

vctDynamicVector<double> prmConfigurationJoint::mPositionMax
protected

◆ mPositionMin

vctDynamicVector<double> prmConfigurationJoint::mPositionMin
protected

◆ mType

vctDynamicVector<cmnJointType> prmConfigurationJoint::mType
protected

◆ mVelocityMax

vctDynamicVector<double> prmConfigurationJoint::mVelocityMax
protected

◆ mVelocityMin

vctDynamicVector<double> prmConfigurationJoint::mVelocityMin
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 prmConfigurationJoint::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