prmVelocityJointSet Class Reference

#include <prmVelocityJointSet.h>

Inheritance diagram for prmVelocityJointSet:

Public Types
typedef prmMotionBase	BaseType
typedef unsigned int	size_type
Public Types inherited from prmMotionBase
typedef mtsGenericObject	BaseType

Public Member Functions
	prmVelocityJointSet ()
	prmVelocityJointSet (size_type size)
void	SetSize (size_type size)
	prmVelocityJointSet (const vctBoolVec &mask, const vctDoubleVec &guard, const vctDoubleVec &velocity, const vctDoubleVec &acceleration, const vctDoubleVec &deceleration, const bool &isPositionGuarded)
virtual	~prmVelocityJointSet ()
void	SerializeRaw (std::ostream &outputStream) const override
void	DeSerializeRaw (std::istream &inputStream) override
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)
	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)
mtsGenericObject &	operator= (const mtsGenericObject &other)
bool	SetTimestampIfAutomatic (double timestamp)
virtual void	ToStream (std::ostream &outputStream) const
virtual void	ToStreamRaw (std::ostream &outputStream, const char delimiter=' ', bool headerOnly=false, const std::string &headerPrefix="") const
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

Protected Member Functions
	CMN_DECLARE_MEMBER_AND_ACCESSORS (vctBoolVec, Mask)
	CMN_DECLARE_MEMBER_AND_ACCESSORS (vctDoubleVec, Guard)
	CMN_DECLARE_MEMBER_AND_ACCESSORS (vctDoubleVec, Goal)
	CMN_DECLARE_MEMBER_AND_ACCESSORS (vctDoubleVec, Acceleration)
	CMN_DECLARE_MEMBER_AND_ACCESSORS (vctDoubleVec, Deceleration)
	CMN_DECLARE_MEMBER_AND_ACCESSORS (bool, IsPositionGuarded)

Detailed Description

motion command arguments for joint angle velocity moves

Member Typedef Documentation

BaseType

typedef prmMotionBase prmVelocityJointSet::BaseType

size_type

typedef unsigned int prmVelocityJointSet::size_type

Constructor & Destructor Documentation

prmVelocityJointSet() [1/3]

prmVelocityJointSet::prmVelocityJointSet ( )

inline

default constructor

prmVelocityJointSet() [2/3]

prmVelocityJointSet::prmVelocityJointSet ( size_type size )

inline

this constructor sets the size of the vector type members

prmVelocityJointSet() [3/3]

prmVelocityJointSet::prmVelocityJointSet ( const vctBoolVec & mask, const vctDoubleVec & guard, const vctDoubleVec & velocity, const vctDoubleVec & acceleration, const vctDoubleVec & deceleration, const bool & isPositionGuarded )

inline

constructor with all parameters

~prmVelocityJointSet()

virtual prmVelocityJointSet::~prmVelocityJointSet ( )

virtual

destructor

Member Function Documentation

CMN_DECLARE_MEMBER_AND_ACCESSORS() [1/6]

prmVelocityJointSet::CMN_DECLARE_MEMBER_AND_ACCESSORS ( bool , IsPositionGuarded  )

protected

true --> move at specified velocity until MoveVelocityJointSet.goal for ANY is reached

CMN_DECLARE_MEMBER_AND_ACCESSORS() [2/6]

prmVelocityJointSet::CMN_DECLARE_MEMBER_AND_ACCESSORS ( vctBoolVec , Mask  )

protected

Masks joints not involved in this move, true --> corresponding joint index velocities will be used

CMN_DECLARE_MEMBER_AND_ACCESSORS() [3/6]

prmVelocityJointSet::CMN_DECLARE_MEMBER_AND_ACCESSORS ( vctDoubleVec , Acceleration  )

protected

Corresponding accelerations where needed

CMN_DECLARE_MEMBER_AND_ACCESSORS() [4/6]

prmVelocityJointSet::CMN_DECLARE_MEMBER_AND_ACCESSORS ( vctDoubleVec , Deceleration  )

protected

Corresponding accelerations where applicable

CMN_DECLARE_MEMBER_AND_ACCESSORS() [5/6]

prmVelocityJointSet::CMN_DECLARE_MEMBER_AND_ACCESSORS ( vctDoubleVec , Goal  )

protected

Joint velocity goals (mask -> true) indicates goals will be used in the move

CMN_DECLARE_MEMBER_AND_ACCESSORS() [6/6]

prmVelocityJointSet::CMN_DECLARE_MEMBER_AND_ACCESSORS ( vctDoubleVec , Guard  )

protected

Unmasked elements (mask --> true) are only used if move is position guarded

DeSerializeRaw()

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

overridevirtual

Binary deserialization

Reimplemented from prmMotionBase.

SerializeRaw()

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

overridevirtual

Binary serialization

Reimplemented from prmMotionBase.

SetSize()

void prmVelocityJointSet::SetSize

(

size_type

size

)

---

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

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