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

#include <prmServoCartesian.h>

Inheritance diagram for prmServoCartesian:
mtsGenericObject cmnGenericObject

Public Member Functions

 prmServoCartesian (void)
 prmServoCartesian (const prmServoCartesian &other)
prmServoCartesian & operator= (const prmServoCartesian &other)
 ~prmServoCartesian ()
void GetTaskFrame (vctFrm3 &placeHolder) const
vctFrm3 GetTaskFrame (void) const
void SetTaskFrame (const vctFrm3 &newValue)
const vctFrm3 & TaskFrame (void) const
vctFrm3 & TaskFrame (void)
void GetPosition (vctFrm3 &placeHolder) const
vctFrm3 GetPosition (void) const
void SetPosition (const vctFrm3 &newValue)
const vctFrm3 & Position (void) const
vctFrm3 & Position (void)
void GetVelocity (vct6 &placeHolder) const
vct6 GetVelocity (void) const
void SetVelocity (const vct6 &newValue)
const vct6 & Velocity (void) const
vct6 & Velocity (void)
void GetForce (vct6 &placeHolder) const
vct6 GetForce (void) const
void SetForce (const vct6 &newValue)
const vct6 & Force (void) const
vct6 & Force (void)
void GetAxisMode (vctFixedSizeVector< prmSetpointMode, 6 > &placeHolder) const
vctFixedSizeVector< prmSetpointMode, 6 > GetAxisMode (void) const
void SetAxisMode (const vctFixedSizeVector< prmSetpointMode, 6 > &newValue)
const vctFixedSizeVector< prmSetpointMode, 6 > & AxisMode (void) const
vctFixedSizeVector< prmSetpointMode, 6 > & AxisMode (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 prmServoCartesian &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

vctFrm3 mTaskFrame
vctFrm3 mPosition
vct6 mVelocity
vct6 mForce
vctFixedSizeVector< prmSetpointMode, 6 > mAxisMode

Constructor & Destructor Documentation

◆ prmServoCartesian() [1/2]

prmServoCartesian::prmServoCartesian ( void )

◆ prmServoCartesian() [2/2]

prmServoCartesian::prmServoCartesian ( const prmServoCartesian & other)

◆ ~prmServoCartesian()

prmServoCartesian::~prmServoCartesian ( )

Member Function Documentation

◆ AxisMode() [1/2]

vctFixedSizeVector< prmSetpointMode, 6 > & prmServoCartesian::AxisMode ( void )

◆ AxisMode() [2/2]

const vctFixedSizeVector< prmSetpointMode, 6 > & prmServoCartesian::AxisMode ( void ) const

◆ Copy()

void prmServoCartesian::Copy ( const prmServoCartesian & source)

◆ DeSerializeRaw()

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

Binary deserialization

Reimplemented from mtsGenericObject.

◆ Force() [1/2]

vct6 & prmServoCartesian::Force ( void )

◆ Force() [2/2]

const vct6 & prmServoCartesian::Force ( void ) const

◆ GetAxisMode() [1/2]

void prmServoCartesian::GetAxisMode ( vctFixedSizeVector< prmSetpointMode, 6 > & placeHolder) const

◆ GetAxisMode() [2/2]

vctFixedSizeVector< prmSetpointMode, 6 > prmServoCartesian::GetAxisMode ( void ) const
inline

◆ GetForce() [1/2]

void prmServoCartesian::GetForce ( vct6 & placeHolder) const

◆ GetForce() [2/2]

vct6 prmServoCartesian::GetForce ( void ) const
inline

◆ GetPosition() [1/2]

void prmServoCartesian::GetPosition ( vctFrm3 & placeHolder) const

◆ GetPosition() [2/2]

vctFrm3 prmServoCartesian::GetPosition ( void ) const
inline

◆ GetTaskFrame() [1/2]

void prmServoCartesian::GetTaskFrame ( vctFrm3 & placeHolder) const

◆ GetTaskFrame() [2/2]

vctFrm3 prmServoCartesian::GetTaskFrame ( void ) const
inline

◆ GetVelocity() [1/2]

void prmServoCartesian::GetVelocity ( vct6 & placeHolder) const

◆ GetVelocity() [2/2]

vct6 prmServoCartesian::GetVelocity ( void ) const
inline

◆ operator=()

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

◆ Position() [1/2]

vctFrm3 & prmServoCartesian::Position ( void )

◆ Position() [2/2]

const vctFrm3 & prmServoCartesian::Position ( void ) const

◆ ScalarNumber()

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

Binary serialization

Reimplemented from mtsGenericObject.

◆ SetAxisMode()

void prmServoCartesian::SetAxisMode ( const vctFixedSizeVector< prmSetpointMode, 6 > & newValue)

◆ SetForce()

void prmServoCartesian::SetForce ( const vct6 & newValue)

◆ SetPosition()

void prmServoCartesian::SetPosition ( const vctFrm3 & newValue)

◆ SetTaskFrame()

void prmServoCartesian::SetTaskFrame ( const vctFrm3 & newValue)

◆ SetVelocity()

void prmServoCartesian::SetVelocity ( const vct6 & newValue)

◆ TaskFrame() [1/2]

vctFrm3 & prmServoCartesian::TaskFrame ( void )

◆ TaskFrame() [2/2]

const vctFrm3 & prmServoCartesian::TaskFrame ( void ) const

◆ ToStream()

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

vct6 & prmServoCartesian::Velocity ( void )

◆ Velocity() [2/2]

const vct6 & prmServoCartesian::Velocity ( void ) const

Member Data Documentation

◆ HumanReadable

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

◆ mAxisMode

vctFixedSizeVector<prmSetpointMode, 6> prmServoCartesian::mAxisMode
protected

◆ mForce

vct6 prmServoCartesian::mForce
protected

◆ mPosition

vctFrm3 prmServoCartesian::mPosition
protected

◆ mTaskFrame

vctFrm3 prmServoCartesian::mTaskFrame
protected

◆ mVelocity

vct6 prmServoCartesian::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 prmServoCartesian::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