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

#include <prmPositionCartesianSet.h>

Inheritance diagram for prmPositionCartesianSet:
mtsGenericObject cmnGenericObject

Public Member Functions

 prmPositionCartesianSet (void)
 prmPositionCartesianSet (const prmPositionCartesianSet &other)
prmPositionCartesianSet & operator= (const prmPositionCartesianSet &other)
 ~prmPositionCartesianSet ()
void GetGoal (vctDoubleFrm3 &placeHolder) const
vctDoubleFrm3 GetGoal (void) const
void SetGoal (const vctDoubleFrm3 &newValue)
const vctDoubleFrm3 & Goal (void) const
vctDoubleFrm3 & Goal (void)
void GetVelocity (vctDouble3 &placeHolder) const
vctDouble3 GetVelocity (void) const
void SetVelocity (const vctDouble3 &newValue)
const vctDouble3 & Velocity (void) const
vctDouble3 & Velocity (void)
void GetVelocityAngular (vctDouble3 &placeHolder) const
vctDouble3 GetVelocityAngular (void) const
void SetVelocityAngular (const vctDouble3 &newValue)
const vctDouble3 & VelocityAngular (void) const
vctDouble3 & VelocityAngular (void)
void GetAcceleration (vctDouble3 &placeHolder) const
vctDouble3 GetAcceleration (void) const
void SetAcceleration (const vctDouble3 &newValue)
const vctDouble3 & Acceleration (void) const
vctDouble3 & Acceleration (void)
void GetAngularAcceleration (vctDouble3 &placeHolder) const
vctDouble3 GetAngularAcceleration (void) const
void SetAngularAcceleration (const vctDouble3 &newValue)
const vctDouble3 & AngularAcceleration (void) const
vctDouble3 & AngularAcceleration (void)
void GetMask (vctBool2 &placeHolder) const
vctBool2 GetMask (void) const
void SetMask (const vctBool2 &newValue)
const vctBool2 & Mask (void) const
vctBool2 & Mask (void)
void GetMovingFrame (std::string &placeHolder) const
std::string GetMovingFrame (void) const
void SetMovingFrame (const std::string &newValue)
const std::string & MovingFrame (void) const
std::string & MovingFrame (void)
void GetReferenceFrame (std::string &placeHolder) const
std::string GetReferenceFrame (void) const
void SetReferenceFrame (const std::string &newValue)
const std::string & ReferenceFrame (void) const
std::string & ReferenceFrame (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)
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 prmPositionCartesianSet &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

vctDoubleFrm3 mGoal
vctDouble3 mVelocity
vctDouble3 mVelocityAngular
vctDouble3 mAcceleration
vctDouble3 mAngularAcceleration
vctBool2 mMask
std::string mMovingFrame
std::string mReferenceFrame
prmBlocking mBlockingFlag
bool mBlendingFactor
bool mIsPreemptable
bool mIsGoalOnly

Constructor & Destructor Documentation

◆ prmPositionCartesianSet() [1/2]

prmPositionCartesianSet::prmPositionCartesianSet ( void )

◆ prmPositionCartesianSet() [2/2]

prmPositionCartesianSet::prmPositionCartesianSet ( const prmPositionCartesianSet & other)

◆ ~prmPositionCartesianSet()

prmPositionCartesianSet::~prmPositionCartesianSet ( )

Member Function Documentation

◆ Acceleration() [1/2]

vctDouble3 & prmPositionCartesianSet::Acceleration ( void )

◆ Acceleration() [2/2]

const vctDouble3 & prmPositionCartesianSet::Acceleration ( void ) const

◆ AngularAcceleration() [1/2]

vctDouble3 & prmPositionCartesianSet::AngularAcceleration ( void )

◆ AngularAcceleration() [2/2]

const vctDouble3 & prmPositionCartesianSet::AngularAcceleration ( void ) const

◆ BlendingFactor() [1/2]

CISST_DEPRECATED bool & prmPositionCartesianSet::BlendingFactor ( void )

◆ BlendingFactor() [2/2]

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

◆ BlockingFlag() [1/2]

CISST_DEPRECATED prmBlocking & prmPositionCartesianSet::BlockingFlag ( void )

◆ BlockingFlag() [2/2]

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

◆ Copy()

void prmPositionCartesianSet::Copy ( const prmPositionCartesianSet & source)

◆ DeSerializeRaw()

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

Binary deserialization

Reimplemented from mtsGenericObject.

◆ GetAcceleration() [1/2]

void prmPositionCartesianSet::GetAcceleration ( vctDouble3 & placeHolder) const

◆ GetAcceleration() [2/2]

vctDouble3 prmPositionCartesianSet::GetAcceleration ( void ) const
inline

◆ GetAngularAcceleration() [1/2]

void prmPositionCartesianSet::GetAngularAcceleration ( vctDouble3 & placeHolder) const

◆ GetAngularAcceleration() [2/2]

vctDouble3 prmPositionCartesianSet::GetAngularAcceleration ( void ) const
inline

◆ GetBlendingFactor() [1/2]

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

◆ GetBlendingFactor() [2/2]

CISST_DEPRECATED bool prmPositionCartesianSet::GetBlendingFactor ( void ) const
inline

◆ GetBlockingFlag() [1/2]

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

◆ GetBlockingFlag() [2/2]

CISST_DEPRECATED prmBlocking prmPositionCartesianSet::GetBlockingFlag ( void ) const
inline

◆ GetGoal() [1/2]

void prmPositionCartesianSet::GetGoal ( vctDoubleFrm3 & placeHolder) const

◆ GetGoal() [2/2]

vctDoubleFrm3 prmPositionCartesianSet::GetGoal ( void ) const
inline

◆ GetIsGoalOnly() [1/2]

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

◆ GetIsGoalOnly() [2/2]

CISST_DEPRECATED bool prmPositionCartesianSet::GetIsGoalOnly ( void ) const
inline

◆ GetIsPreemptable() [1/2]

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

◆ GetIsPreemptable() [2/2]

CISST_DEPRECATED bool prmPositionCartesianSet::GetIsPreemptable ( void ) const
inline

◆ GetMask() [1/2]

void prmPositionCartesianSet::GetMask ( vctBool2 & placeHolder) const

◆ GetMask() [2/2]

vctBool2 prmPositionCartesianSet::GetMask ( void ) const
inline

◆ GetMovingFrame() [1/2]

void prmPositionCartesianSet::GetMovingFrame ( std::string & placeHolder) const

◆ GetMovingFrame() [2/2]

std::string prmPositionCartesianSet::GetMovingFrame ( void ) const
inline

◆ GetReferenceFrame() [1/2]

void prmPositionCartesianSet::GetReferenceFrame ( std::string & placeHolder) const

◆ GetReferenceFrame() [2/2]

std::string prmPositionCartesianSet::GetReferenceFrame ( void ) const
inline

◆ GetVelocity() [1/2]

void prmPositionCartesianSet::GetVelocity ( vctDouble3 & placeHolder) const

◆ GetVelocity() [2/2]

vctDouble3 prmPositionCartesianSet::GetVelocity ( void ) const
inline

◆ GetVelocityAngular() [1/2]

void prmPositionCartesianSet::GetVelocityAngular ( vctDouble3 & placeHolder) const

◆ GetVelocityAngular() [2/2]

vctDouble3 prmPositionCartesianSet::GetVelocityAngular ( void ) const
inline

◆ Goal() [1/2]

vctDoubleFrm3 & prmPositionCartesianSet::Goal ( void )

◆ Goal() [2/2]

const vctDoubleFrm3 & prmPositionCartesianSet::Goal ( void ) const

◆ IsGoalOnly() [1/2]

CISST_DEPRECATED bool & prmPositionCartesianSet::IsGoalOnly ( void )

◆ IsGoalOnly() [2/2]

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

◆ IsPreemptable() [1/2]

CISST_DEPRECATED bool & prmPositionCartesianSet::IsPreemptable ( void )

◆ IsPreemptable() [2/2]

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

◆ Mask() [1/2]

vctBool2 & prmPositionCartesianSet::Mask ( void )

◆ Mask() [2/2]

const vctBool2 & prmPositionCartesianSet::Mask ( void ) const

◆ MovingFrame() [1/2]

std::string & prmPositionCartesianSet::MovingFrame ( void )

◆ MovingFrame() [2/2]

const std::string & prmPositionCartesianSet::MovingFrame ( void ) const

◆ operator=()

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

◆ ReferenceFrame() [1/2]

std::string & prmPositionCartesianSet::ReferenceFrame ( void )

◆ ReferenceFrame() [2/2]

const std::string & prmPositionCartesianSet::ReferenceFrame ( void ) const

◆ ScalarNumber()

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

Binary serialization

Reimplemented from mtsGenericObject.

◆ SetAcceleration()

void prmPositionCartesianSet::SetAcceleration ( const vctDouble3 & newValue)

◆ SetAngularAcceleration()

void prmPositionCartesianSet::SetAngularAcceleration ( const vctDouble3 & newValue)

◆ SetBlendingFactor()

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

◆ SetBlockingFlag()

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

◆ SetGoal()

void prmPositionCartesianSet::SetGoal ( const vctDoubleFrm3 & newValue)

◆ SetIsGoalOnly()

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

◆ SetIsPreemptable()

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

◆ SetMask()

void prmPositionCartesianSet::SetMask ( const vctBool2 & newValue)

◆ SetMovingFrame()

void prmPositionCartesianSet::SetMovingFrame ( const std::string & newValue)

◆ SetReferenceFrame()

void prmPositionCartesianSet::SetReferenceFrame ( const std::string & newValue)

◆ SetVelocity()

void prmPositionCartesianSet::SetVelocity ( const vctDouble3 & newValue)

◆ SetVelocityAngular()

void prmPositionCartesianSet::SetVelocityAngular ( const vctDouble3 & newValue)

◆ ToStream()

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

vctDouble3 & prmPositionCartesianSet::Velocity ( void )

◆ Velocity() [2/2]

const vctDouble3 & prmPositionCartesianSet::Velocity ( void ) const

◆ VelocityAngular() [1/2]

vctDouble3 & prmPositionCartesianSet::VelocityAngular ( void )

◆ VelocityAngular() [2/2]

const vctDouble3 & prmPositionCartesianSet::VelocityAngular ( void ) const

Member Data Documentation

◆ HumanReadable

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

◆ mAcceleration

vctDouble3 prmPositionCartesianSet::mAcceleration
protected

◆ mAngularAcceleration

vctDouble3 prmPositionCartesianSet::mAngularAcceleration
protected

◆ mBlendingFactor

bool prmPositionCartesianSet::mBlendingFactor
protected

◆ mBlockingFlag

prmBlocking prmPositionCartesianSet::mBlockingFlag
protected

◆ mGoal

vctDoubleFrm3 prmPositionCartesianSet::mGoal
protected

◆ mIsGoalOnly

bool prmPositionCartesianSet::mIsGoalOnly
protected

◆ mIsPreemptable

bool prmPositionCartesianSet::mIsPreemptable
protected

◆ mMask

vctBool2 prmPositionCartesianSet::mMask
protected

◆ mMovingFrame

std::string prmPositionCartesianSet::mMovingFrame
protected

◆ mReferenceFrame

std::string prmPositionCartesianSet::mReferenceFrame
protected

◆ mVelocity

vctDouble3 prmPositionCartesianSet::mVelocity
protected

◆ mVelocityAngular

vctDouble3 prmPositionCartesianSet::mVelocityAngular
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 prmPositionCartesianSet::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