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

#include <prmPositionJointSet.h>

Inheritance diagram for prmPositionJointSet:
mtsGenericObject cmnGenericObject

Public Member Functions

 prmPositionJointSet (void)
 prmPositionJointSet (const prmPositionJointSet &other)
prmPositionJointSet & operator= (const prmPositionJointSet &other)
 ~prmPositionJointSet ()
void GetGoal (vctDynamicVector< double > &placeHolder) const
vctDynamicVector< double > GetGoal (void) const
void SetGoal (const vctDynamicVector< double > &newValue)
const vctDynamicVector< double > & Goal (void) const
vctDynamicVector< double > & Goal (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 GetAcceleration (vctDynamicVector< double > &placeHolder) const
vctDynamicVector< double > GetAcceleration (void) const
void SetAcceleration (const vctDynamicVector< double > &newValue)
const vctDynamicVector< double > & Acceleration (void) const
vctDynamicVector< double > & Acceleration (void)
void GetTimeLimit (double &placeHolder) const
double GetTimeLimit (void) const
void SetTimeLimit (const double &newValue)
const double & TimeLimit (void) const
double & TimeLimit (void)
void GetIsCoordinated (bool &placeHolder) const
bool GetIsCoordinated (void) const
void SetIsCoordinated (const bool &newValue)
const bool & IsCoordinated (void) const
bool & IsCoordinated (void)
CISST_DEPRECATED void GetDeceleration (vctDynamicVector< double > &placeHolder) const
CISST_DEPRECATED vctDynamicVector< double > GetDeceleration (void) const
CISST_DEPRECATED void SetDeceleration (const vctDynamicVector< double > &newValue)
CISST_DEPRECATED const vctDynamicVector< double > & Deceleration (void) const
CISST_DEPRECATED vctDynamicVector< double > & Deceleration (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 prmPositionJointSet (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 prmPositionJointSet &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 > mGoal
vctDynamicVector< double > mVelocity
vctDynamicVector< double > mAcceleration
double mTimeLimit
bool mIsCoordinated
vctDynamicVector< double > mDeceleration
vctDynamicVector< bool > mMask
prmBlocking mBlockingFlag
bool mBlendingFactor
bool mIsPreemptable
bool mIsGoalOnly

Constructor & Destructor Documentation

◆ prmPositionJointSet() [1/3]

prmPositionJointSet::prmPositionJointSet ( void )

◆ prmPositionJointSet() [2/3]

prmPositionJointSet::prmPositionJointSet ( const prmPositionJointSet & other)

◆ ~prmPositionJointSet()

prmPositionJointSet::~prmPositionJointSet ( )

◆ prmPositionJointSet() [3/3]

CISST_DEPRECATED prmPositionJointSet::prmPositionJointSet ( const size_t size)
inline

Member Function Documentation

◆ Acceleration() [1/2]

vctDynamicVector< double > & prmPositionJointSet::Acceleration ( void )

◆ Acceleration() [2/2]

const vctDynamicVector< double > & prmPositionJointSet::Acceleration ( void ) const

◆ BlendingFactor() [1/2]

CISST_DEPRECATED bool & prmPositionJointSet::BlendingFactor ( void )

◆ BlendingFactor() [2/2]

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

◆ BlockingFlag() [1/2]

CISST_DEPRECATED prmBlocking & prmPositionJointSet::BlockingFlag ( void )

◆ BlockingFlag() [2/2]

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

◆ Copy()

void prmPositionJointSet::Copy ( const prmPositionJointSet & source)

◆ Deceleration() [1/2]

CISST_DEPRECATED vctDynamicVector< double > & prmPositionJointSet::Deceleration ( void )

◆ Deceleration() [2/2]

CISST_DEPRECATED const vctDynamicVector< double > & prmPositionJointSet::Deceleration ( void ) const

◆ DeSerializeRaw()

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

Binary deserialization

Reimplemented from mtsGenericObject.

◆ GetAcceleration() [1/2]

void prmPositionJointSet::GetAcceleration ( vctDynamicVector< double > & placeHolder) const

◆ GetAcceleration() [2/2]

vctDynamicVector< double > prmPositionJointSet::GetAcceleration ( void ) const
inline

◆ GetBlendingFactor() [1/2]

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

◆ GetBlendingFactor() [2/2]

CISST_DEPRECATED bool prmPositionJointSet::GetBlendingFactor ( void ) const
inline

◆ GetBlockingFlag() [1/2]

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

◆ GetBlockingFlag() [2/2]

CISST_DEPRECATED prmBlocking prmPositionJointSet::GetBlockingFlag ( void ) const
inline

◆ GetDeceleration() [1/2]

CISST_DEPRECATED void prmPositionJointSet::GetDeceleration ( vctDynamicVector< double > & placeHolder) const

◆ GetDeceleration() [2/2]

CISST_DEPRECATED vctDynamicVector< double > prmPositionJointSet::GetDeceleration ( void ) const
inline

◆ GetGoal() [1/2]

void prmPositionJointSet::GetGoal ( vctDynamicVector< double > & placeHolder) const

◆ GetGoal() [2/2]

vctDynamicVector< double > prmPositionJointSet::GetGoal ( void ) const
inline

◆ GetIsCoordinated() [1/2]

void prmPositionJointSet::GetIsCoordinated ( bool & placeHolder) const

◆ GetIsCoordinated() [2/2]

bool prmPositionJointSet::GetIsCoordinated ( void ) const
inline

◆ GetIsGoalOnly() [1/2]

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

◆ GetIsGoalOnly() [2/2]

CISST_DEPRECATED bool prmPositionJointSet::GetIsGoalOnly ( void ) const
inline

◆ GetIsPreemptable() [1/2]

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

◆ GetIsPreemptable() [2/2]

CISST_DEPRECATED bool prmPositionJointSet::GetIsPreemptable ( void ) const
inline

◆ GetMask() [1/2]

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

◆ GetMask() [2/2]

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

◆ GetTimeLimit() [1/2]

void prmPositionJointSet::GetTimeLimit ( double & placeHolder) const

◆ GetTimeLimit() [2/2]

double prmPositionJointSet::GetTimeLimit ( void ) const
inline

◆ GetVelocity() [1/2]

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

◆ GetVelocity() [2/2]

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

◆ Goal() [1/2]

vctDynamicVector< double > & prmPositionJointSet::Goal ( void )

◆ Goal() [2/2]

const vctDynamicVector< double > & prmPositionJointSet::Goal ( void ) const

◆ IsCoordinated() [1/2]

bool & prmPositionJointSet::IsCoordinated ( void )

◆ IsCoordinated() [2/2]

const bool & prmPositionJointSet::IsCoordinated ( void ) const

◆ IsGoalOnly() [1/2]

CISST_DEPRECATED bool & prmPositionJointSet::IsGoalOnly ( void )

◆ IsGoalOnly() [2/2]

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

◆ IsPreemptable() [1/2]

CISST_DEPRECATED bool & prmPositionJointSet::IsPreemptable ( void )

◆ IsPreemptable() [2/2]

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

◆ Mask() [1/2]

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

◆ Mask() [2/2]

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

◆ operator=()

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

◆ ScalarNumber()

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

Binary serialization

Reimplemented from mtsGenericObject.

◆ SetAcceleration()

void prmPositionJointSet::SetAcceleration ( const vctDynamicVector< double > & newValue)

◆ SetBlendingFactor()

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

◆ SetBlockingFlag()

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

◆ SetDeceleration()

CISST_DEPRECATED void prmPositionJointSet::SetDeceleration ( const vctDynamicVector< double > & newValue)

◆ SetGoal()

void prmPositionJointSet::SetGoal ( const vctDynamicVector< double > & newValue)

◆ SetIsCoordinated()

void prmPositionJointSet::SetIsCoordinated ( const bool & newValue)

◆ SetIsGoalOnly()

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

◆ SetIsPreemptable()

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

◆ SetMask()

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

◆ SetSize()

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

◆ SetTimeLimit()

void prmPositionJointSet::SetTimeLimit ( const double & newValue)

◆ SetVelocity()

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

◆ TimeLimit() [1/2]

double & prmPositionJointSet::TimeLimit ( void )

◆ TimeLimit() [2/2]

const double & prmPositionJointSet::TimeLimit ( void ) const

◆ ToStream()

void prmPositionJointSet::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 prmPositionJointSet::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 > & prmPositionJointSet::Velocity ( void )

◆ Velocity() [2/2]

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

Member Data Documentation

◆ HumanReadable

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

◆ mAcceleration

vctDynamicVector<double> prmPositionJointSet::mAcceleration
protected

◆ mBlendingFactor

bool prmPositionJointSet::mBlendingFactor
protected

◆ mBlockingFlag

prmBlocking prmPositionJointSet::mBlockingFlag
protected

◆ mDeceleration

vctDynamicVector<double> prmPositionJointSet::mDeceleration
protected

◆ mGoal

vctDynamicVector<double> prmPositionJointSet::mGoal
protected

◆ mIsCoordinated

bool prmPositionJointSet::mIsCoordinated
protected

◆ mIsGoalOnly

bool prmPositionJointSet::mIsGoalOnly
protected

◆ mIsPreemptable

bool prmPositionJointSet::mIsPreemptable
protected

◆ mMask

vctDynamicVector<bool> prmPositionJointSet::mMask
protected

◆ mTimeLimit

double prmPositionJointSet::mTimeLimit
protected

◆ mVelocity

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