prmForceCartesianGet Class Reference

#include <prmForceCartesianGet.h>

Inheritance diagram for prmForceCartesianGet:

Public Types
typedef mtsGenericObject	BaseType
typedef vctFixedSizeConstVectorRef< double, 3, 1 >	ConstForceType
typedef vctFixedSizeVectorRef< double, 3, 1 >	ForceType
typedef ConstForceType	ConstTorqueType
typedef ForceType	TorqueType

Public Member Functions
	prmForceCartesianGet (void)
	prmForceCartesianGet (const vctDouble6 &force)
virtual	~prmForceCartesianGet ()
	CMN_DECLARE_MEMBER_AND_ACCESSORS (vctDouble6, Force)
	CMN_DECLARE_MEMBER_AND_ACCESSORS (vctBool6, Mask)
	CMN_DECLARE_MEMBER_AND_ACCESSORS (std::string, ReferenceFrame)
	CMN_DECLARE_MEMBER_AND_ACCESSORS (std::string, MovingFrame)
ConstForceType	F (void) const
ForceType	F (void)
ConstTorqueType	T (void) const
TorqueType	T (void)
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	SerializeRaw (std::ostream &outputStream) const override
void	DeSerializeRaw (std::istream &inputStream) 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=' ')
size_t	ScalarNumber (void) const
bool	ScalarNumberIsFixed (void) const
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

Detailed Description

Cartesian force get command argument

Member Typedef Documentation

BaseType

typedef mtsGenericObject prmForceCartesianGet::BaseType

ConstForceType

typedef vctFixedSizeConstVectorRef<double, 3, 1> prmForceCartesianGet::ConstForceType

ConstTorqueType

typedef ConstForceType prmForceCartesianGet::ConstTorqueType

ForceType

typedef vctFixedSizeVectorRef<double, 3, 1> prmForceCartesianGet::ForceType

TorqueType

typedef ForceType prmForceCartesianGet::TorqueType

Constructor & Destructor Documentation

prmForceCartesianGet() [1/2]

prmForceCartesianGet::prmForceCartesianGet ( void )

inline

default constructor

prmForceCartesianGet() [2/2]

prmForceCartesianGet::prmForceCartesianGet ( const vctDouble6 & force )

inline

constructor with all parameters

~prmForceCartesianGet()

virtual prmForceCartesianGet::~prmForceCartesianGet ( )

virtual

destructor

Member Function Documentation

CMN_DECLARE_MEMBER_AND_ACCESSORS() [1/4]

prmForceCartesianGet::CMN_DECLARE_MEMBER_AND_ACCESSORS	(	std::string	,
		MovingFrame	)

CMN_DECLARE_MEMBER_AND_ACCESSORS() [2/4]

prmForceCartesianGet::CMN_DECLARE_MEMBER_AND_ACCESSORS	(	std::string	,
		ReferenceFrame	)

CMN_DECLARE_MEMBER_AND_ACCESSORS() [3/4]

prmForceCartesianGet::CMN_DECLARE_MEMBER_AND_ACCESSORS	(	vctBool6	,
		Mask	)

Set and Get methods for mask

CMN_DECLARE_MEMBER_AND_ACCESSORS() [4/4]

prmForceCartesianGet::CMN_DECLARE_MEMBER_AND_ACCESSORS	(	vctDouble6	,
		Force	)

Set and Get methods for force

DeSerializeRaw()

void prmForceCartesianGet::DeSerializeRaw ( std::istream & inputStream )

overridevirtual

Binary deserialization

Reimplemented from mtsGenericObject.

F() [1/2]

ForceType prmForceCartesianGet::F ( void )

inline

Reference to the first 3 elements (force part) of the "Force" vector.

F() [2/2]

ConstForceType prmForceCartesianGet::F ( void ) const

inline

Reference (const) to the first 3 elements (force part) of the "Force" vector.

SerializeRaw()

void prmForceCartesianGet::SerializeRaw ( std::ostream & outputStream ) const

overridevirtual

Binary serialization

Reimplemented from mtsGenericObject.

T() [1/2]

TorqueType prmForceCartesianGet::T ( void )

inline

Reference to the last 3 elements (torque part) of the "Force" vector.

T() [2/2]

ConstTorqueType prmForceCartesianGet::T ( void ) const

inline

Reference (const) to the last 3 elements (torque part) of the "Force" vector.

ToStream()

void prmForceCartesianGet::ToStream ( std::ostream & outputStream ) const

overridevirtual

Human readable output to stream.

Reimplemented from mtsGenericObject.

ToStreamRaw()

void prmForceCartesianGet::ToStreamRaw ( std::ostream & outputStream, const char delimiter = ' ', bool headerOnly = false, const std::string & headerPrefix = "" ) const

overridevirtual

To stream raw data.

Reimplemented from mtsGenericObject.

---

The documentation for this class was generated from the following file:

• tmp/cisst-saw/cisst/cisstParameterTypes/prmForceCartesianGet.h