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

#include <prmServoJoint.h>

Inheritance diagram for prmServoJoint:
mtsGenericObject cmnGenericObject

Public Member Functions

 prmServoJoint (void)
 prmServoJoint (const prmServoJoint &other)
prmServoJoint & operator= (const prmServoJoint &other)
 ~prmServoJoint ()
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 GetMode (std::vector< prmSetpointMode > &placeHolder) const
std::vector< prmSetpointMode > GetMode (void) const
void SetMode (const std::vector< prmSetpointMode > &newValue)
const std::vector< prmSetpointMode > & Mode (void) const
std::vector< prmSetpointMode > & Mode (void)
void GetPosition (vctDoubleVec &placeHolder) const
vctDoubleVec GetPosition (void) const
void SetPosition (const vctDoubleVec &newValue)
const vctDoubleVec & Position (void) const
vctDoubleVec & Position (void)
void GetVelocity (vctDoubleVec &placeHolder) const
vctDoubleVec GetVelocity (void) const
void SetVelocity (const vctDoubleVec &newValue)
const vctDoubleVec & Velocity (void) const
vctDoubleVec & Velocity (void)
void GetEffort (vctDoubleVec &placeHolder) const
vctDoubleVec GetEffort (void) const
void SetEffort (const vctDoubleVec &newValue)
const vctDoubleVec & Effort (void) const
vctDoubleVec & Effort (void)
void GetPositionProjection (vctDoubleMat &placeHolder) const
vctDoubleMat GetPositionProjection (void) const
void SetPositionProjection (const vctDoubleMat &newValue)
const vctDoubleMat & PositionProjection (void) const
vctDoubleMat & PositionProjection (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 prmServoJoint &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
std::vector< prmSetpointMode > mMode
vctDoubleVec mPosition
vctDoubleVec mVelocity
vctDoubleVec mEffort
vctDoubleMat mPositionProjection

Constructor & Destructor Documentation

◆ prmServoJoint() [1/2]

prmServoJoint::prmServoJoint ( void )

◆ prmServoJoint() [2/2]

prmServoJoint::prmServoJoint ( const prmServoJoint & other)

◆ ~prmServoJoint()

prmServoJoint::~prmServoJoint ( )

Member Function Documentation

◆ Copy()

void prmServoJoint::Copy ( const prmServoJoint & source)

◆ DeSerializeRaw()

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

Binary deserialization

Reimplemented from mtsGenericObject.

◆ Effort() [1/2]

vctDoubleVec & prmServoJoint::Effort ( void )

◆ Effort() [2/2]

const vctDoubleVec & prmServoJoint::Effort ( void ) const

◆ GetEffort() [1/2]

void prmServoJoint::GetEffort ( vctDoubleVec & placeHolder) const

◆ GetEffort() [2/2]

vctDoubleVec prmServoJoint::GetEffort ( void ) const
inline

◆ GetMode() [1/2]

void prmServoJoint::GetMode ( std::vector< prmSetpointMode > & placeHolder) const

◆ GetMode() [2/2]

std::vector< prmSetpointMode > prmServoJoint::GetMode ( void ) const
inline

◆ GetName() [1/2]

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

◆ GetName() [2/2]

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

◆ GetPosition() [1/2]

void prmServoJoint::GetPosition ( vctDoubleVec & placeHolder) const

◆ GetPosition() [2/2]

vctDoubleVec prmServoJoint::GetPosition ( void ) const
inline

◆ GetPositionProjection() [1/2]

void prmServoJoint::GetPositionProjection ( vctDoubleMat & placeHolder) const

◆ GetPositionProjection() [2/2]

vctDoubleMat prmServoJoint::GetPositionProjection ( void ) const
inline

◆ GetVelocity() [1/2]

void prmServoJoint::GetVelocity ( vctDoubleVec & placeHolder) const

◆ GetVelocity() [2/2]

vctDoubleVec prmServoJoint::GetVelocity ( void ) const
inline

◆ Mode() [1/2]

std::vector< prmSetpointMode > & prmServoJoint::Mode ( void )

◆ Mode() [2/2]

const std::vector< prmSetpointMode > & prmServoJoint::Mode ( void ) const

◆ Name() [1/2]

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

◆ Name() [2/2]

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

◆ operator=()

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

◆ Position() [1/2]

vctDoubleVec & prmServoJoint::Position ( void )

◆ Position() [2/2]

const vctDoubleVec & prmServoJoint::Position ( void ) const

◆ PositionProjection() [1/2]

vctDoubleMat & prmServoJoint::PositionProjection ( void )

◆ PositionProjection() [2/2]

const vctDoubleMat & prmServoJoint::PositionProjection ( void ) const

◆ ScalarNumber()

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

Binary serialization

Reimplemented from mtsGenericObject.

◆ SetEffort()

void prmServoJoint::SetEffort ( const vctDoubleVec & newValue)

◆ SetMode()

void prmServoJoint::SetMode ( const std::vector< prmSetpointMode > & newValue)

◆ SetName()

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

◆ SetPosition()

void prmServoJoint::SetPosition ( const vctDoubleVec & newValue)

◆ SetPositionProjection()

void prmServoJoint::SetPositionProjection ( const vctDoubleMat & newValue)

◆ SetSize()

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

◆ SetVelocity()

void prmServoJoint::SetVelocity ( const vctDoubleVec & newValue)

◆ ToStream()

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

vctDoubleVec & prmServoJoint::Velocity ( void )

◆ Velocity() [2/2]

const vctDoubleVec & prmServoJoint::Velocity ( void ) const

Member Data Documentation

◆ HumanReadable

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

◆ mEffort

vctDoubleVec prmServoJoint::mEffort
protected

◆ mMode

std::vector<prmSetpointMode> prmServoJoint::mMode
protected

◆ mName

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

◆ mPosition

vctDoubleVec prmServoJoint::mPosition
protected

◆ mPositionProjection

vctDoubleMat prmServoJoint::mPositionProjection
protected

◆ mVelocity

vctDoubleVec prmServoJoint::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 prmServoJoint::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