openjaus::mobility::ReportAccelerationLimit Class Reference

ReportAccelerationLimit Message Implementation. More...

#include <ReportAccelerationLimit.h>

Inherits openjaus::model::Message.

List of all members.

Public Member Functions
	ReportAccelerationLimit ()
	ReportAccelerationLimit (model::Message *message)
	~ReportAccelerationLimit ()
virtual int	to (system::Buffer *dst)
	Pack this message to the given openjaus::system::Buffer.
virtual int	from (system::Buffer *src)
	Unpack this message from the given openjaus::system::Buffer.
virtual int	length ()
	Get the number of bytes this message would occupy in a serialized buffer.
std::string	toXml (unsigned char level=0) const
	Used to serialize the runtime state of the message to an XML format.
void	setPresenceVector (uint8_t value)
uint8_t	getPresenceVector (void) const
bool	isAccelerationXEnabled (void) const
void	enableAccelerationX (void)
void	disableAccelerationX (void)
bool	isAccelerationYEnabled (void) const
void	enableAccelerationY (void)
void	disableAccelerationY (void)
bool	isAccelerationZEnabled (void) const
void	enableAccelerationZ (void)
void	disableAccelerationZ (void)
bool	isRollAccelerationEnabled (void) const
void	enableRollAcceleration (void)
void	disableRollAcceleration (void)
bool	isPitchAccelerationEnabled (void) const
void	enablePitchAcceleration (void)
void	disablePitchAcceleration (void)
bool	isYawAccelerationEnabled (void) const
void	enableYawAcceleration (void)
void	disableYawAcceleration (void)
AccelerationCommandTypeEnumeration::AccelerationCommandTypeEnum	getCommandType (void)
void	setCommandType (AccelerationCommandTypeEnumeration::AccelerationCommandTypeEnum value)
double	getAccelerationX_mps2 (void)
void	setAccelerationX_mps2 (double value)
double	getAccelerationY_mps2 (void)
void	setAccelerationY_mps2 (double value)
double	getAccelerationZ_mps2 (void)
void	setAccelerationZ_mps2 (double value)
double	getRollAcceleration_rps2 (void)
void	setRollAcceleration_rps2 (double value)
double	getPitchAcceleration_rps2 (void)
void	setPitchAcceleration_rps2 (double value)
double	getYawAcceleration_rps2 (void)
void	setYawAcceleration_rps2 (double value)
Static Public Attributes
static const uint16_t	ID = 0x4416
Private Types
enum	pvEnum {   ACCELERATIONX_MPS2 = 0, ACCELERATIONY_MPS2 = 1, ACCELERATIONZ_MPS2 = 2, ROLLACCELERATION_RPS2 = 3,   PITCHACCELERATION_RPS2 = 4, YAWACCELERATION_RPS2 = 5 }
Private Attributes
AccelerationCommandTypeEnumeration	commandType
LinearAccelerationScaledInteger	accelerationX_mps2
LinearAccelerationScaledInteger	accelerationY_mps2
LinearAccelerationScaledInteger	accelerationZ_mps2
AngularAccelerationScaledInteger	rollAcceleration_rps2
AngularAccelerationScaledInteger	pitchAcceleration_rps2
AngularAccelerationScaledInteger	yawAcceleration_rps2
uint8_t	presenceVector

---

Detailed Description

This message is used to provide the receiver the commanded linear and rotational acceleration limits of the platform. The message data and mapping of the presence vector of this message are identical to ID 0416h: SetAccelerationCommand.

---

Member Enumeration Documentation

enum openjaus::mobility::ReportAccelerationLimit::pvEnum [private]

Enumerator:

ACCELERATIONX_MPS2
ACCELERATIONY_MPS2
ACCELERATIONZ_MPS2
ROLLACCELERATION_RPS2
PITCHACCELERATION_RPS2
YAWACCELERATION_RPS2

---

Constructor & Destructor Documentation

openjaus::mobility::ReportAccelerationLimit::ReportAccelerationLimit

(

)

openjaus::mobility::ReportAccelerationLimit::ReportAccelerationLimit

(

model::Message *

message

)

openjaus::mobility::ReportAccelerationLimit::~ReportAccelerationLimit

(

)

---

Member Function Documentation

void openjaus::mobility::ReportAccelerationLimit::disableAccelerationX

(

void

)

void openjaus::mobility::ReportAccelerationLimit::disableAccelerationY

(

void

)

void openjaus::mobility::ReportAccelerationLimit::disableAccelerationZ

(

void

)

void openjaus::mobility::ReportAccelerationLimit::disablePitchAcceleration

(

void

)

void openjaus::mobility::ReportAccelerationLimit::disableRollAcceleration

(

void

)

void openjaus::mobility::ReportAccelerationLimit::disableYawAcceleration

(

void

)

void openjaus::mobility::ReportAccelerationLimit::enableAccelerationX

(

void

)

void openjaus::mobility::ReportAccelerationLimit::enableAccelerationY

(

void

)

void openjaus::mobility::ReportAccelerationLimit::enableAccelerationZ

(

void

)

void openjaus::mobility::ReportAccelerationLimit::enablePitchAcceleration

(

void

)

void openjaus::mobility::ReportAccelerationLimit::enableRollAcceleration

(

void

)

void openjaus::mobility::ReportAccelerationLimit::enableYawAcceleration

(

void

)

int openjaus::mobility::ReportAccelerationLimit::from

(

system::Buffer *

src

)

[virtual]

src - The source openjaus::system::Buffer from which this message will be unpacked.

Returns:

The number of bytes unpacked from the source buffer

Reimplemented from openjaus::model::Message.

double openjaus::mobility::ReportAccelerationLimit::getAccelerationX_mps2

(

void

)

double openjaus::mobility::ReportAccelerationLimit::getAccelerationY_mps2

(

void

)

double openjaus::mobility::ReportAccelerationLimit::getAccelerationZ_mps2

(

void

)

AccelerationCommandTypeEnumeration::AccelerationCommandTypeEnum openjaus::mobility::ReportAccelerationLimit::getCommandType

(

void

)

double openjaus::mobility::ReportAccelerationLimit::getPitchAcceleration_rps2

(

void

)

uint8_t openjaus::mobility::ReportAccelerationLimit::getPresenceVector

(

void

)

const

double openjaus::mobility::ReportAccelerationLimit::getRollAcceleration_rps2

(

void

)

double openjaus::mobility::ReportAccelerationLimit::getYawAcceleration_rps2

(

void

)

bool openjaus::mobility::ReportAccelerationLimit::isAccelerationXEnabled

(

void

)

const

bool openjaus::mobility::ReportAccelerationLimit::isAccelerationYEnabled

(

void

)

const

bool openjaus::mobility::ReportAccelerationLimit::isAccelerationZEnabled

(

void

)

const

bool openjaus::mobility::ReportAccelerationLimit::isPitchAccelerationEnabled

(

void

)

const

bool openjaus::mobility::ReportAccelerationLimit::isRollAccelerationEnabled

(

void

)

const

bool openjaus::mobility::ReportAccelerationLimit::isYawAccelerationEnabled

(

void

)

const

int openjaus::mobility::ReportAccelerationLimit::length

(

void

)

[virtual]

The number of bytes this message would occupy in a buffer

Reimplemented from openjaus::model::Message.

void openjaus::mobility::ReportAccelerationLimit::setAccelerationX_mps2

(

double

value

)

void openjaus::mobility::ReportAccelerationLimit::setAccelerationY_mps2

(

double

value

)

void openjaus::mobility::ReportAccelerationLimit::setAccelerationZ_mps2

(

double

value

)

void openjaus::mobility::ReportAccelerationLimit::setCommandType

(

AccelerationCommandTypeEnumeration::AccelerationCommandTypeEnum

value

)

void openjaus::mobility::ReportAccelerationLimit::setPitchAcceleration_rps2

(

double

value

)

void openjaus::mobility::ReportAccelerationLimit::setPresenceVector

(

uint8_t

value

)

void openjaus::mobility::ReportAccelerationLimit::setRollAcceleration_rps2

(

double

value

)

void openjaus::mobility::ReportAccelerationLimit::setYawAcceleration_rps2

(

double

value

)

int openjaus::mobility::ReportAccelerationLimit::to

(

system::Buffer *

dst

)

[virtual]

dst - The destination openjaus::system::Buffer to which this message will be packed.

Returns:

The number of bytes packed into the destination buffer

Reimplemented from openjaus::model::Message.

std::string openjaus::mobility::ReportAccelerationLimit::toXml

(

unsigned char

level = 0

)

const

level - Used to determine how many tabs are inserted per line for pretty formating.

Returns:

The serialized XML string

---

Member Data Documentation

LinearAccelerationScaledInteger openjaus::mobility::ReportAccelerationLimit::accelerationX_mps2 [private]

LinearAccelerationScaledInteger openjaus::mobility::ReportAccelerationLimit::accelerationY_mps2 [private]

LinearAccelerationScaledInteger openjaus::mobility::ReportAccelerationLimit::accelerationZ_mps2 [private]

AccelerationCommandTypeEnumeration openjaus::mobility::ReportAccelerationLimit::commandType [private]

const uint16_t openjaus::mobility::ReportAccelerationLimit::ID = 0x4416 [static]

AngularAccelerationScaledInteger openjaus::mobility::ReportAccelerationLimit::pitchAcceleration_rps2 [private]

uint8_t openjaus::mobility::ReportAccelerationLimit::presenceVector [private]

AngularAccelerationScaledInteger openjaus::mobility::ReportAccelerationLimit::rollAcceleration_rps2 [private]

AngularAccelerationScaledInteger openjaus::mobility::ReportAccelerationLimit::yawAcceleration_rps2 [private]

---

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

• include/openjaus/mobility/Triggers/ReportAccelerationLimit.h
• src/openjaus/mobility/Triggers/ReportAccelerationLimit.cpp