#include <prmForceCartesianSet.h>

Inheritance diagram for prmForceCartesianSet:

Public Types
typedef prmMotionBase	BaseType

typedef vctFixedSizeVector < double, 6 >	ForceType

typedef vctFixedSizeVector < bool, 6 >	MaskType

Public Types inherited from prmMotionBase
typedef mtsGenericObject	BaseType

Public Member Functions
	prmForceCartesianSet ()

	prmForceCartesianSet (const ForceType &force, const MaskType &mask)

void	SetAll (double forceSet, bool mask)

virtual	~prmForceCartesianSet ()

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)

Public Member Functions inherited from prmMotionBase
	prmMotionBase ()

	prmMotionBase (const prmBlocking &blockingFlag, const bool &blendingFactor, const double &timeLimit, const bool &isPreemptable, const bool &isCoordinated, const bool &isGoalOnly)

virtual	~prmMotionBase ()

void	SetBaseParameter (const prmBlocking &blockingFlag, const bool &blendingFactor, const double &timeLimit, const bool &isPreemptable, const bool &isCoordinated, const bool &isGoalOnly)

void	SerializeRaw (std::ostream &outputStream) const

void	DeSerializeRaw (std::istream &inputStream)

	CMN_DECLARE_MEMBER_AND_ACCESSORS (prmBlocking, BlockingFlag)

	CMN_DECLARE_MEMBER_AND_ACCESSORS (bool, BlendingFactor)

	CMN_DECLARE_MEMBER_AND_ACCESSORS (double, TimeLimit)

	CMN_DECLARE_MEMBER_AND_ACCESSORS (bool, IsPreemptable)

	CMN_DECLARE_MEMBER_AND_ACCESSORS (bool, IsCoordinated)

	CMN_DECLARE_MEMBER_AND_ACCESSORS (bool, IsGoalOnly)

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

Protected Member Functions
	CMN_DECLARE_MEMBER_AND_ACCESSORS (ForceType, Force)

	CMN_DECLARE_MEMBER_AND_ACCESSORS (MaskType, Mask)

Detailed Description

Cartesian position motion command arguments - default motion is a line between the current position and the goal

Member Typedef Documentation

typedef prmMotionBase prmForceCartesianSet::BaseType

typedef vctFixedSizeVector<double, 6> prmForceCartesianSet::ForceType

typedef vctFixedSizeVector<bool, 6> prmForceCartesianSet::MaskType

Constructor & Destructor Documentation

prmForceCartesianSet::prmForceCartesianSet ( )

inline

default constructor

prmForceCartesianSet::prmForceCartesianSet	(	const ForceType &	force,
		const MaskType &	mask
	)

inline

constructor with all parameters

virtual prmForceCartesianSet::~prmForceCartesianSet ( )

virtual

destructor

Member Function Documentation

prmForceCartesianSet::CMN_DECLARE_MEMBER_AND_ACCESSORS	(	ForceType	,
		Force
	)

protected

Set and Get methods for the reference frame for current force, mask, movinf and reference frames. This is defined by a node in the transformation tree.

prmForceCartesianSet::CMN_DECLARE_MEMBER_AND_ACCESSORS	(	MaskType	,
		Mask
	)

protected

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

virtual

Binary deserialization

Reimplemented from mtsGenericObject.

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

virtual

Binary serialization

Reimplemented from mtsGenericObject.

void prmForceCartesianSet::SetAll	(	double	forceSet,
		bool	mask
	)

inline

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

virtual

Human readable output to stream.

Reimplemented from mtsGenericObject.

void prmForceCartesianSet::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/prmForceCartesianSet.h

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation