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

#include <prmForceTorqueJointSet.h>

Inheritance diagram for prmForceTorqueJointSet:
mtsGenericObject cmnGenericObject

Public Member Functions

 prmForceTorqueJointSet (void)
 prmForceTorqueJointSet (const prmForceTorqueJointSet &other)
prmForceTorqueJointSet & operator= (const prmForceTorqueJointSet &other)
 ~prmForceTorqueJointSet ()
void GetForceTorque (vctDynamicVector< double > &placeHolder) const
vctDynamicVector< double > GetForceTorque (void) const
void SetForceTorque (const vctDynamicVector< double > &newValue)
const vctDynamicVector< double > & ForceTorque (void) const
vctDynamicVector< double > & ForceTorque (void)
CISST_DEPRECATED void GetMask (vctDynamicVector< bool > &placeHolder) const
CISST_DEPRECATED vctDynamicVector< bool > GetMask (void) const
CISST_DEPRECATED void SetMask (const vctDynamicVector< bool > &newValue)
CISST_DEPRECATED const vctDynamicVector< bool > & Mask (void) const
CISST_DEPRECATED vctDynamicVector< bool > & Mask (void)
CISST_DEPRECATED void GetBlockingFlag (prmBlocking &placeHolder) const
CISST_DEPRECATED prmBlocking GetBlockingFlag (void) const
CISST_DEPRECATED void SetBlockingFlag (const prmBlocking &newValue)
CISST_DEPRECATED const prmBlocking & BlockingFlag (void) const
CISST_DEPRECATED prmBlocking & BlockingFlag (void)
CISST_DEPRECATED void GetBlendingFactor (bool &placeHolder) const
CISST_DEPRECATED bool GetBlendingFactor (void) const
CISST_DEPRECATED void SetBlendingFactor (const bool &newValue)
CISST_DEPRECATED const bool & BlendingFactor (void) const
CISST_DEPRECATED bool & BlendingFactor (void)
CISST_DEPRECATED void GetIsPreemptable (bool &placeHolder) const
CISST_DEPRECATED bool GetIsPreemptable (void) const
CISST_DEPRECATED void SetIsPreemptable (const bool &newValue)
CISST_DEPRECATED const bool & IsPreemptable (void) const
CISST_DEPRECATED bool & IsPreemptable (void)
CISST_DEPRECATED void GetIsGoalOnly (bool &placeHolder) const
CISST_DEPRECATED bool GetIsGoalOnly (void) const
CISST_DEPRECATED void SetIsGoalOnly (const bool &newValue)
CISST_DEPRECATED const bool & IsGoalOnly (void) const
CISST_DEPRECATED bool & IsGoalOnly (void)
CISST_DEPRECATED prmForceTorqueJointSet (const size_t size)
void CISST_DEPRECATED 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 prmForceTorqueJointSet &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

vctDynamicVector< double > mForceTorque
vctDynamicVector< bool > mMask
prmBlocking mBlockingFlag
bool mBlendingFactor
bool mIsPreemptable
bool mIsGoalOnly

Constructor & Destructor Documentation

◆ prmForceTorqueJointSet() [1/3]

prmForceTorqueJointSet::prmForceTorqueJointSet ( void )

◆ prmForceTorqueJointSet() [2/3]

prmForceTorqueJointSet::prmForceTorqueJointSet ( const prmForceTorqueJointSet & other)

◆ ~prmForceTorqueJointSet()

prmForceTorqueJointSet::~prmForceTorqueJointSet ( )

◆ prmForceTorqueJointSet() [3/3]

CISST_DEPRECATED prmForceTorqueJointSet::prmForceTorqueJointSet ( const size_t size)
inline

Member Function Documentation

◆ BlendingFactor() [1/2]

CISST_DEPRECATED bool & prmForceTorqueJointSet::BlendingFactor ( void )

◆ BlendingFactor() [2/2]

CISST_DEPRECATED const bool & prmForceTorqueJointSet::BlendingFactor ( void ) const

◆ BlockingFlag() [1/2]

CISST_DEPRECATED prmBlocking & prmForceTorqueJointSet::BlockingFlag ( void )

◆ BlockingFlag() [2/2]

CISST_DEPRECATED const prmBlocking & prmForceTorqueJointSet::BlockingFlag ( void ) const

◆ Copy()

void prmForceTorqueJointSet::Copy ( const prmForceTorqueJointSet & source)

◆ DeSerializeRaw()

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

Binary deserialization

Reimplemented from mtsGenericObject.

◆ ForceTorque() [1/2]

vctDynamicVector< double > & prmForceTorqueJointSet::ForceTorque ( void )

◆ ForceTorque() [2/2]

const vctDynamicVector< double > & prmForceTorqueJointSet::ForceTorque ( void ) const

◆ GetBlendingFactor() [1/2]

CISST_DEPRECATED void prmForceTorqueJointSet::GetBlendingFactor ( bool & placeHolder) const

◆ GetBlendingFactor() [2/2]

CISST_DEPRECATED bool prmForceTorqueJointSet::GetBlendingFactor ( void ) const
inline

◆ GetBlockingFlag() [1/2]

CISST_DEPRECATED void prmForceTorqueJointSet::GetBlockingFlag ( prmBlocking & placeHolder) const

◆ GetBlockingFlag() [2/2]

CISST_DEPRECATED prmBlocking prmForceTorqueJointSet::GetBlockingFlag ( void ) const
inline

◆ GetForceTorque() [1/2]

void prmForceTorqueJointSet::GetForceTorque ( vctDynamicVector< double > & placeHolder) const

◆ GetForceTorque() [2/2]

vctDynamicVector< double > prmForceTorqueJointSet::GetForceTorque ( void ) const
inline

◆ GetIsGoalOnly() [1/2]

CISST_DEPRECATED void prmForceTorqueJointSet::GetIsGoalOnly ( bool & placeHolder) const

◆ GetIsGoalOnly() [2/2]

CISST_DEPRECATED bool prmForceTorqueJointSet::GetIsGoalOnly ( void ) const
inline

◆ GetIsPreemptable() [1/2]

CISST_DEPRECATED void prmForceTorqueJointSet::GetIsPreemptable ( bool & placeHolder) const

◆ GetIsPreemptable() [2/2]

CISST_DEPRECATED bool prmForceTorqueJointSet::GetIsPreemptable ( void ) const
inline

◆ GetMask() [1/2]

CISST_DEPRECATED void prmForceTorqueJointSet::GetMask ( vctDynamicVector< bool > & placeHolder) const

◆ GetMask() [2/2]

CISST_DEPRECATED vctDynamicVector< bool > prmForceTorqueJointSet::GetMask ( void ) const
inline

◆ IsGoalOnly() [1/2]

CISST_DEPRECATED bool & prmForceTorqueJointSet::IsGoalOnly ( void )

◆ IsGoalOnly() [2/2]

CISST_DEPRECATED const bool & prmForceTorqueJointSet::IsGoalOnly ( void ) const

◆ IsPreemptable() [1/2]

CISST_DEPRECATED bool & prmForceTorqueJointSet::IsPreemptable ( void )

◆ IsPreemptable() [2/2]

CISST_DEPRECATED const bool & prmForceTorqueJointSet::IsPreemptable ( void ) const

◆ Mask() [1/2]

CISST_DEPRECATED vctDynamicVector< bool > & prmForceTorqueJointSet::Mask ( void )

◆ Mask() [2/2]

CISST_DEPRECATED const vctDynamicVector< bool > & prmForceTorqueJointSet::Mask ( void ) const

◆ operator=()

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

◆ ScalarNumber()

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

Binary serialization

Reimplemented from mtsGenericObject.

◆ SetBlendingFactor()

CISST_DEPRECATED void prmForceTorqueJointSet::SetBlendingFactor ( const bool & newValue)

◆ SetBlockingFlag()

CISST_DEPRECATED void prmForceTorqueJointSet::SetBlockingFlag ( const prmBlocking & newValue)

◆ SetForceTorque()

void prmForceTorqueJointSet::SetForceTorque ( const vctDynamicVector< double > & newValue)

◆ SetIsGoalOnly()

CISST_DEPRECATED void prmForceTorqueJointSet::SetIsGoalOnly ( const bool & newValue)

◆ SetIsPreemptable()

CISST_DEPRECATED void prmForceTorqueJointSet::SetIsPreemptable ( const bool & newValue)

◆ SetMask()

CISST_DEPRECATED void prmForceTorqueJointSet::SetMask ( const vctDynamicVector< bool > & newValue)

◆ SetSize()

void CISST_DEPRECATED prmForceTorqueJointSet::SetSize ( const size_t size)
inline

◆ ToStream()

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

Raw text output to stream

Reimplemented from mtsGenericObject.

Member Data Documentation

◆ HumanReadable

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

◆ mBlendingFactor

bool prmForceTorqueJointSet::mBlendingFactor
protected

◆ mBlockingFlag

prmBlocking prmForceTorqueJointSet::mBlockingFlag
protected

◆ mForceTorque

vctDynamicVector<double> prmForceTorqueJointSet::mForceTorque
protected

◆ mIsGoalOnly

bool prmForceTorqueJointSet::mIsGoalOnly
protected

◆ mIsPreemptable

bool prmForceTorqueJointSet::mIsPreemptable
protected

◆ mMask

vctDynamicVector<bool> prmForceTorqueJointSet::mMask
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 prmForceTorqueJointSet::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