#include <prmVelocityCartesianGet.h>

Inheritance diagram for prmVelocityCartesianGet:

Public Types
typedef mtsGenericObject	BaseType

Public Member Functions
	prmVelocityCartesianGet (void)

	prmVelocityCartesianGet (const vctDouble3 &velocityLinear, const vctDouble3 &velocityAngular)

virtual	~prmVelocityCartesianGet ()

void	ToStream (std::ostream &outputStream) const

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

void	SerializeRaw (std::ostream &outputStream) const

void	DeSerializeRaw (std::istream &inputStream)


	CMN_DECLARE_MEMBER_AND_ACCESSORS (vctDouble3, VelocityLinear)


	CMN_DECLARE_MEMBER_AND_ACCESSORS (vctDouble3, VelocityAngular)


void	SetVelocity (const vct6 &newValue)

void	GetVelocity (vct6 &placeHolder)

Public Member Functions inherited from mtsGenericObject
	mtsGenericObject (void)

	mtsGenericObject (double timestamp, bool automaticTimestamp, bool valid)

	mtsGenericObject (const mtsGenericObject &other)

virtual	~mtsGenericObject (void)

bool	SetTimestampIfAutomatic (double timestamp)

virtual bool	FromStreamRaw (std::istream &inputStream, const char delimiter= ' ')

size_t	ScalarNumber (void) const

bool	ScalarNumberIsFixed (void) const

double	Scalar (const size_t index) const throw (std::out_of_range)

std::string	ScalarDescription (const size_t index, const std::string &userDescription="") const throw (std::out_of_range)

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 throw (std::out_of_range)

virtual std::string	ScalarDescription (const size_t CMN_UNUSED(index), const std::string &CMN_UNUSED(userDescription)) const

Detailed Description

Cartesian velocity get command argument

Member Typedef Documentation

typedef mtsGenericObject prmVelocityCartesianGet::BaseType

Constructor & Destructor Documentation

prmVelocityCartesianGet::prmVelocityCartesianGet ( void )

inline

default constructor

prmVelocityCartesianGet::prmVelocityCartesianGet	(	const vctDouble3 &	velocityLinear,
		const vctDouble3 &	velocityAngular
	)

inline

constructor with all parameters

virtual prmVelocityCartesianGet::~prmVelocityCartesianGet ( )

virtual

destructor

Member Function Documentation

prmVelocityCartesianGet::CMN_DECLARE_MEMBER_AND_ACCESSORS	(	vctDouble3	,
		VelocityLinear
	)

Set and Get method the linear velocity parameter.

prmVelocityCartesianGet::CMN_DECLARE_MEMBER_AND_ACCESSORS	(	vctDouble3	,
		VelocityAngular
	)

Set and Get method the angular velocity parameter.

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

virtual

Binary deserialization

Reimplemented from mtsGenericObject.

void prmVelocityCartesianGet::GetVelocity ( vct6 & placeHolder )

inline

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

virtual

Binary serialization

Reimplemented from mtsGenericObject.

void prmVelocityCartesianGet::SetVelocity ( const vct6 & newValue )

inline

Set and Get methods for both linear and angular velocities. These methods assumes that the vector 6 elements stores the linear velocity first (elements 0, 1 and 2) and then the angular velocity (elements 3, 4 and 5).

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

virtual

Human readable output to stream.

Reimplemented from mtsGenericObject.

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

virtual

To stream raw data.

Reimplemented from mtsGenericObject.

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

/home/adeguet1/catkin_ws/src/cisst-saw/cisst/cisstParameterTypes/prmVelocityCartesianGet.h

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation