openjaus::mobility::ReportVelocityCommand Class Reference

ReportVelocityCommand Message Implementation. More...

#include <ReportVelocityCommand.h>

Inherits openjaus::model::Message.

List of all members.

Public Member Functions
	ReportVelocityCommand ()
	ReportVelocityCommand (model::Message *message)
	~ReportVelocityCommand ()
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	isVelocityXEnabled (void) const
void	enableVelocityX (void)
void	disableVelocityX (void)
bool	isVelocityYEnabled (void) const
void	enableVelocityY (void)
void	disableVelocityY (void)
bool	isVelocityZEnabled (void) const
void	enableVelocityZ (void)
void	disableVelocityZ (void)
bool	isRollRateEnabled (void) const
void	enableRollRate (void)
void	disableRollRate (void)
bool	isPitchRateEnabled (void) const
void	enablePitchRate (void)
void	disablePitchRate (void)
bool	isYawRateEnabled (void) const
void	enableYawRate (void)
void	disableYawRate (void)
VelocityCommandTypeEnumeration::VelocityCommandTypeEnum	getCommandType (void)
void	setCommandType (VelocityCommandTypeEnumeration::VelocityCommandTypeEnum value)
double	getVelocityX_mps (void)
void	setVelocityX_mps (double value)
double	getVelocityY_mps (void)
void	setVelocityY_mps (double value)
double	getVelocityZ_mps (void)
void	setVelocityZ_mps (double value)
double	getRollRate_rps (void)
void	setRollRate_rps (double value)
double	getPitchRate_rps (void)
void	setPitchRate_rps (double value)
double	getYawRate_rps (void)
void	setYawRate_rps (double value)
Static Public Attributes
static const uint16_t	ID = 0x4415
Private Types
enum	pvEnum {   VELOCITYX_MPS = 0, VELOCITYY_MPS = 1, VELOCITYZ_MPS = 2, ROLLRATE_RPS = 3,   PITCHRATE_RPS = 4, YAWRATE_RPS = 5 }
Private Attributes
VelocityCommandTypeEnumeration	commandType
LinearVelocityScaledInteger	velocityX_mps
LinearVelocityScaledInteger	velocityY_mps
LinearVelocityScaledInteger	velocityZ_mps
AngularVelocityScaledInteger	rollRate_rps
AngularVelocityScaledInteger	pitchRate_rps
AngularVelocityScaledInteger	yawRate_rps
uint8_t	presenceVector

---

Detailed Description

This message is used to provide the receiver the commanded linear velocity and rotational rate of the platform. The message data and mapping of the presence vector of this message are identical to ID 0415h: SetVelocityCommand.

---

Member Enumeration Documentation

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

Enumerator:

VELOCITYX_MPS
VELOCITYY_MPS
VELOCITYZ_MPS
ROLLRATE_RPS
PITCHRATE_RPS
YAWRATE_RPS

---

Constructor & Destructor Documentation

openjaus::mobility::ReportVelocityCommand::ReportVelocityCommand

(

)

openjaus::mobility::ReportVelocityCommand::ReportVelocityCommand

(

model::Message *

message

)

openjaus::mobility::ReportVelocityCommand::~ReportVelocityCommand

(

)

---

Member Function Documentation

void openjaus::mobility::ReportVelocityCommand::disablePitchRate

(

void

)

void openjaus::mobility::ReportVelocityCommand::disableRollRate

(

void

)

void openjaus::mobility::ReportVelocityCommand::disableVelocityX

(

void

)

void openjaus::mobility::ReportVelocityCommand::disableVelocityY

(

void

)

void openjaus::mobility::ReportVelocityCommand::disableVelocityZ

(

void

)

void openjaus::mobility::ReportVelocityCommand::disableYawRate

(

void

)

void openjaus::mobility::ReportVelocityCommand::enablePitchRate

(

void

)

void openjaus::mobility::ReportVelocityCommand::enableRollRate

(

void

)

void openjaus::mobility::ReportVelocityCommand::enableVelocityX

(

void

)

void openjaus::mobility::ReportVelocityCommand::enableVelocityY

(

void

)

void openjaus::mobility::ReportVelocityCommand::enableVelocityZ

(

void

)

void openjaus::mobility::ReportVelocityCommand::enableYawRate

(

void

)

int openjaus::mobility::ReportVelocityCommand::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.

VelocityCommandTypeEnumeration::VelocityCommandTypeEnum openjaus::mobility::ReportVelocityCommand::getCommandType

(

void

)

double openjaus::mobility::ReportVelocityCommand::getPitchRate_rps

(

void

)

uint8_t openjaus::mobility::ReportVelocityCommand::getPresenceVector

(

void

)

const

double openjaus::mobility::ReportVelocityCommand::getRollRate_rps

(

void

)

double openjaus::mobility::ReportVelocityCommand::getVelocityX_mps

(

void

)

double openjaus::mobility::ReportVelocityCommand::getVelocityY_mps

(

void

)

double openjaus::mobility::ReportVelocityCommand::getVelocityZ_mps

(

void

)

double openjaus::mobility::ReportVelocityCommand::getYawRate_rps

(

void

)

bool openjaus::mobility::ReportVelocityCommand::isPitchRateEnabled

(

void

)

const

bool openjaus::mobility::ReportVelocityCommand::isRollRateEnabled

(

void

)

const

bool openjaus::mobility::ReportVelocityCommand::isVelocityXEnabled

(

void

)

const

bool openjaus::mobility::ReportVelocityCommand::isVelocityYEnabled

(

void

)

const

bool openjaus::mobility::ReportVelocityCommand::isVelocityZEnabled

(

void

)

const

bool openjaus::mobility::ReportVelocityCommand::isYawRateEnabled

(

void

)

const

int openjaus::mobility::ReportVelocityCommand::length

(

void

)

[virtual]

The number of bytes this message would occupy in a buffer

Reimplemented from openjaus::model::Message.

void openjaus::mobility::ReportVelocityCommand::setCommandType

(

VelocityCommandTypeEnumeration::VelocityCommandTypeEnum

value

)

void openjaus::mobility::ReportVelocityCommand::setPitchRate_rps

(

double

value

)

void openjaus::mobility::ReportVelocityCommand::setPresenceVector

(

uint8_t

value

)

void openjaus::mobility::ReportVelocityCommand::setRollRate_rps

(

double

value

)

void openjaus::mobility::ReportVelocityCommand::setVelocityX_mps

(

double

value

)

void openjaus::mobility::ReportVelocityCommand::setVelocityY_mps

(

double

value

)

void openjaus::mobility::ReportVelocityCommand::setVelocityZ_mps

(

double

value

)

void openjaus::mobility::ReportVelocityCommand::setYawRate_rps

(

double

value

)

int openjaus::mobility::ReportVelocityCommand::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::ReportVelocityCommand::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

VelocityCommandTypeEnumeration openjaus::mobility::ReportVelocityCommand::commandType [private]

const uint16_t openjaus::mobility::ReportVelocityCommand::ID = 0x4415 [static]

AngularVelocityScaledInteger openjaus::mobility::ReportVelocityCommand::pitchRate_rps [private]

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

AngularVelocityScaledInteger openjaus::mobility::ReportVelocityCommand::rollRate_rps [private]

LinearVelocityScaledInteger openjaus::mobility::ReportVelocityCommand::velocityX_mps [private]

LinearVelocityScaledInteger openjaus::mobility::ReportVelocityCommand::velocityY_mps [private]

LinearVelocityScaledInteger openjaus::mobility::ReportVelocityCommand::velocityZ_mps [private]

AngularVelocityScaledInteger openjaus::mobility::ReportVelocityCommand::yawRate_rps [private]

---

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

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