This message is used to command the linear and rotational acceleration limits of the platform. More...

#include <setaccelerationlimit.h>

Inheritance diagram for JAUS::SetAccelerationLimit:

Classes
class	Limits
	Contains constants for limit values of data members of class. More...
class	PresenceVector
	This class contains bit masks for bitwise operations on the presence vector for this message. More...
Public Types
enum	Command { SetMaximumAllowedValues = 0, SetMinimumAllowedValues }
Public Member Functions
	SetAccelerationLimit (const Address &dest=Address(), const Address &src=Address())
	Constructor, initializes default values.
	SetAccelerationLimit (const SetAccelerationLimit &message)
	Copy constructor.
	~SetAccelerationLimit ()
	Destructor.
Byte	SetCommandType (const Command type)
bool	SetAccelerationX (const double value)
	Sets the Acceleration x and update the presence vector for the message.
bool	SetAccelerationY (const double value)
	Sets the Acceleration y and update the presence vector for the message.
bool	SetAccelerationZ (const double value)
	Sets the Acceleration z and update the presence vector for the message.
bool	SetRollAcceleration (const double value)
	Sets the roll Acceleration and update the presence vector for the message.
bool	SetPitchAcceleration (const double value)
	Sets the pitch Acceleration and update the presence vector for the message.
bool	SetYawAcceleration (const double value)
	Sets the yaw Acceleration and update the presence vector for the message.
Byte	GetCommandType () const
double	GetAccelerationX () const
double	GetAccelerationY () const
double	GetAccelerationZ () const
double	GetRollAcceleration () const
double	GetPitchAcceleration () const
double	GetYawAcceleration () const
virtual bool	IsCommand () const
virtual int	WriteMessageBody (Packet &packet) const
	Writes message payload to the packet.
virtual int	ReadMessageBody (const Packet &packet)
	Reads message payload from the packet.
virtual Message *	Clone () const
virtual UInt	GetPresenceVector () const
virtual UInt	GetPresenceVectorSize () const
virtual UInt	GetPresenceVectorMask () const
virtual UShort	GetMessageCodeOfResponse () const
virtual std::string	GetMessageName () const
virtual void	ClearMessageBody ()
	Clears message payload data.
virtual bool	IsLargeDataSet (const unsigned int maxPayloadSize=1437) const
virtual int	RunTestCase () const
	Runs a test case to validate the message class.
SetAccelerationLimit &	operator= (const SetAccelerationLimit &message)
	Sets equal to.
Protected Attributes
Byte	mPresenceVector
	Bit vector for fields present.
Command	mCommandType
	CommandType.
double	mAccelerationX
	Acceleration X in meters per second squared [-1310.68, 1310.68].
double	mAccelerationY
	Acceleration Y in meters per second squared [-1310.68, 1310.68].
double	mAccelerationZ
	Acceleration Z in meters per second squared [-1310.68, 1310.68].
double	mRollAcceleration
	Roll Acceleration in Radians per second squared [-13106.8, 13106.8].
double	mPitchAcceleration
	Pitch Acceleration in Radians per second squared [-13106.8, 13106.8].
double	mYawAcceleration
	Yaw Acceleration in Radians per second squared [-13106.8, 13106.8].

Detailed Description

This message is used to command the linear and rotational acceleration limits of the platform.

Definition at line 55 of file setaccelerationlimit.h.

Member Enumeration Documentation

enum JAUS::SetAccelerationLimit::Command

Enumerator:

SetMaximumAllowedValues
SetMinimumAllowedValues

Definition at line 91 of file setaccelerationlimit.h.

Constructor & Destructor Documentation

SetAccelerationLimit::SetAccelerationLimit	(	const Address &	dest = `Address()`,
		const Address &	src = `Address()`
	)

Constructor, initializes default values.

Parameters:

[in]	src	Source ID of message sender.
[in]	dest	Destination ID of message.

Definition at line 60 of file setaccelerationlimit.cpp.

SetAccelerationLimit::SetAccelerationLimit ( const SetAccelerationLimit & message )

Copy constructor.

Definition at line 78 of file setaccelerationlimit.cpp.

SetAccelerationLimit::~SetAccelerationLimit ( )

Destructor.

Definition at line 89 of file setaccelerationlimit.cpp.

Member Function Documentation

void SetAccelerationLimit::ClearMessageBody ( ) [virtual]

Clears message payload data.

Implements JAUS::Message.

Definition at line 344 of file setaccelerationlimit.cpp.

virtual Message* JAUS::SetAccelerationLimit::Clone ( ) const [inline, virtual]

Implements JAUS::Message.

Definition at line 116 of file setaccelerationlimit.h.

double JAUS::SetAccelerationLimit::GetAccelerationX ( ) const [inline]

Definition at line 107 of file setaccelerationlimit.h.

double JAUS::SetAccelerationLimit::GetAccelerationY ( ) const [inline]

Definition at line 108 of file setaccelerationlimit.h.

double JAUS::SetAccelerationLimit::GetAccelerationZ ( ) const [inline]

Definition at line 109 of file setaccelerationlimit.h.

Byte JAUS::SetAccelerationLimit::GetCommandType ( ) const [inline]

Definition at line 106 of file setaccelerationlimit.h.

virtual UShort JAUS::SetAccelerationLimit::GetMessageCodeOfResponse ( ) const [inline, virtual]

Implements JAUS::Message.

Definition at line 120 of file setaccelerationlimit.h.

virtual std::string JAUS::SetAccelerationLimit::GetMessageName ( ) const [inline, virtual]

Implements JAUS::Message.

Definition at line 121 of file setaccelerationlimit.h.

double JAUS::SetAccelerationLimit::GetPitchAcceleration ( ) const [inline]

Definition at line 111 of file setaccelerationlimit.h.

virtual UInt JAUS::SetAccelerationLimit::GetPresenceVector ( ) const [inline, virtual]

Implements JAUS::Message.

Definition at line 117 of file setaccelerationlimit.h.

virtual UInt JAUS::SetAccelerationLimit::GetPresenceVectorMask ( ) const [inline, virtual]

Implements JAUS::Message.

Definition at line 119 of file setaccelerationlimit.h.

virtual UInt JAUS::SetAccelerationLimit::GetPresenceVectorSize ( ) const [inline, virtual]

Implements JAUS::Message.

Definition at line 118 of file setaccelerationlimit.h.

double JAUS::SetAccelerationLimit::GetRollAcceleration ( ) const [inline]

Definition at line 110 of file setaccelerationlimit.h.

double JAUS::SetAccelerationLimit::GetYawAcceleration ( ) const [inline]

Definition at line 112 of file setaccelerationlimit.h.

virtual bool JAUS::SetAccelerationLimit::IsCommand ( ) const [inline, virtual]

Implements JAUS::Message.

Definition at line 113 of file setaccelerationlimit.h.

virtual bool JAUS::SetAccelerationLimit::IsLargeDataSet ( const unsigned int maxPayloadSize = 1437 ) const [inline, virtual]

Implements JAUS::Message.

Definition at line 123 of file setaccelerationlimit.h.

SetAccelerationLimit & SetAccelerationLimit::operator= ( const SetAccelerationLimit & message )

Sets equal to.

Definition at line 395 of file setaccelerationlimit.cpp.

int SetAccelerationLimit::ReadMessageBody ( const Packet & packet ) [virtual]

Reads message payload from the packet.

Message contents are read from the packet following the JAUS standard.

Parameters:

[in] packet Packet containing message payload data to read.

Returns:: -1 on error, otherwise number of bytes written.

Implements JAUS::Message.

Definition at line 294 of file setaccelerationlimit.cpp.

int SetAccelerationLimit::RunTestCase ( ) const [virtual]

Runs a test case to validate the message class.

Returns:: 1 on success, otherwise 0.

Reimplemented from JAUS::Message.

Definition at line 364 of file setaccelerationlimit.cpp.

bool SetAccelerationLimit::SetAccelerationX ( const double value )

Sets the Acceleration x and update the presence vector for the message.

Parameters:

[in] value Desired Acceleration x in meters per second squared [-1310.68, 1310.68].

Returns:: true on success, otherwise false.

Definition at line 104 of file setaccelerationlimit.cpp.

bool SetAccelerationLimit::SetAccelerationY ( const double value )

Sets the Acceleration y and update the presence vector for the message.

Parameters:

[in] value Desired Acceleration y in meters per second squared [-1310.68, 1310.68].

Returns:: true on success, otherwise false.

Definition at line 126 of file setaccelerationlimit.cpp.

bool SetAccelerationLimit::SetAccelerationZ ( const double value )

Sets the Acceleration z and update the presence vector for the message.

Parameters:

[in] value Desired Acceleration z in meters per second squared [-1310.68, 1310.68].

Returns:: true on success, otherwise false.

Definition at line 148 of file setaccelerationlimit.cpp.

Byte JAUS::SetAccelerationLimit::SetCommandType ( const Command type ) [inline]

Definition at line 99 of file setaccelerationlimit.h.

bool SetAccelerationLimit::SetPitchAcceleration ( const double value )

Sets the pitch Acceleration and update the presence vector for the message.

Parameters:

[in] value Desired pitch Acceleration in Radians per second squared [-13106.8, 13106.8].

Returns:: true on success, otherwise false.

Definition at line 193 of file setaccelerationlimit.cpp.

bool SetAccelerationLimit::SetRollAcceleration ( const double value )

Sets the roll Acceleration and update the presence vector for the message.

Parameters:

[in] value Desired roll Acceleration in Radians per second squared [-13106.8, 13106.8].

Returns:: true on success, otherwise false.

Definition at line 170 of file setaccelerationlimit.cpp.

bool SetAccelerationLimit::SetYawAcceleration ( const double value )

Sets the yaw Acceleration and update the presence vector for the message.

Parameters:

[in] value Desired yaw Acceleration in Radians per second squared [-13106.8, 13106.8].

Returns:: true on success, otherwise false.

Definition at line 215 of file setaccelerationlimit.cpp.

int SetAccelerationLimit::WriteMessageBody ( Packet & packet ) const [virtual]

Writes message payload to the packet.

Message contents are written to the packet following the JAUS standard.

Parameters:

[out] packet Packet to write payload to.

Returns:: -1 on error, otherwise number of bytes written.

Implements JAUS::Message.

Definition at line 238 of file setaccelerationlimit.cpp.

Member Data Documentation

double JAUS::SetAccelerationLimit::mAccelerationX [protected]

Acceleration X in meters per second squared [-1310.68, 1310.68].

Definition at line 129 of file setaccelerationlimit.h.

double JAUS::SetAccelerationLimit::mAccelerationY [protected]

Acceleration Y in meters per second squared [-1310.68, 1310.68].

Definition at line 130 of file setaccelerationlimit.h.

double JAUS::SetAccelerationLimit::mAccelerationZ [protected]

Acceleration Z in meters per second squared [-1310.68, 1310.68].

Definition at line 131 of file setaccelerationlimit.h.

Command JAUS::SetAccelerationLimit::mCommandType [protected]

CommandType.

Definition at line 128 of file setaccelerationlimit.h.

double JAUS::SetAccelerationLimit::mPitchAcceleration [protected]

Pitch Acceleration in Radians per second squared [-13106.8, 13106.8].

Definition at line 133 of file setaccelerationlimit.h.

Byte JAUS::SetAccelerationLimit::mPresenceVector [protected]

Bit vector for fields present.

Definition at line 127 of file setaccelerationlimit.h.

double JAUS::SetAccelerationLimit::mRollAcceleration [protected]

Roll Acceleration in Radians per second squared [-13106.8, 13106.8].

Definition at line 132 of file setaccelerationlimit.h.

double JAUS::SetAccelerationLimit::mYawAcceleration [protected]

Yaw Acceleration in Radians per second squared [-13106.8, 13106.8].

Definition at line 134 of file setaccelerationlimit.h.

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

jaus++/2.0/include/jaus/mobility/drivers/setaccelerationlimit.h
jaus++/2.0/src/jaus/mobility/drivers/setaccelerationlimit.cpp

JAUS::SetAccelerationLimit Class Reference

Classes

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation