OpenJAUS Software Development Kit  4.3.1
Public Member Functions | Static Public Attributes | Private Attributes | Friends | List of all members
openjaus::mobility::ReportVelocityCommand Class Reference

ReportVelocityCommand Message Implementation. More...

#include <ReportVelocityCommand.h>

Inherits openjaus::model::Message.

Public Member Functions

 ReportVelocityCommand ()
 ReportVelocityCommand (model::Message *message)
 ~ReportVelocityCommand ()
virtual int to (system::Buffer *dst)
 Pack this message to the given openjaus::system::Buffer. More...
virtual int from (system::Buffer *src)
 Unpack this message from the given openjaus::system::Buffer. More...
virtual int length ()
 Get the number of bytes this message would occupy in a serialized buffer. More...
std::string toXml (unsigned char ojIndentLevel=0) const
 Used to serialize the runtime state of the message to an XML format. More...
std::string toString () const
 Returns a string populated with the Message name and ID More...
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)
bool setCommandType (VelocityCommandTypeEnumeration::VelocityCommandTypeEnum value)
std::string getCommandTypeToString (void)
double getVelocityX_mps (void)
bool setVelocityX_mps (double value)
double getVelocityY_mps (void)
bool setVelocityY_mps (double value)
double getVelocityZ_mps (void)
bool setVelocityZ_mps (double value)
double getRollRate_rps (void)
bool setRollRate_rps (double value)
double getPitchRate_rps (void)
bool setPitchRate_rps (double value)
double getYawRate_rps (void)
bool setYawRate_rps (double value)
- Public Member Functions inherited from openjaus::model::Message
 Message ()
virtual ~Message ()
 Message (Message *message)
int to (system::Buffer *dst)
 Operation to. More...
int from (system::Buffer *src)
 Operation from. More...
- Public Member Functions inherited from openjaus::transport::Wrapper
 Wrapper ()
virtual ~Wrapper ()
AckNakType getAckNak () const
 Accessor to get the value of ackNak. More...
bool setAckNak (AckNakType ackNak)
 Accessor to set value of ackNak. More...
bool isCompressible () const
 Accessor to get the value of compressible. More...
bool setCompressible (bool compressible)
 Accessor to set value of compressible. More...
bool isMustArrive () const
 Accessor to get the value of mustArrive. More...
bool setMustArrive (bool mustArrive)
 Accessor to set value of mustArrive. More...
uint16_t getSequenceNumber () const
 Accessor to get the value of sequenceNumber. More...
bool setSequenceNumber (uint16_t sequenceNumber)
 Accessor to set value of sequenceNumber. More...
WrapperType getType () const
 Accessor to get the value of type. More...
bool setType (WrapperType type)
 Accessor to set value of type. More...
Priority getPriority () const
 Accessor to get the value of priority. More...
bool setPriority (Priority priority)
 Accessor to set value of priority. More...
BroadcastType getBroadcastFlag () const
 Accessor to get the value of broadcastFlag. More...
bool setBroadcastFlag (BroadcastType broadcastFlag)
 Accessor to set value of broadcastFlag. More...
LargeMessageType getLargeMessageFlag () const
 Accessor to get the value of largeMessageFlag. More...
bool setLargeMessageFlag (LargeMessageType largeMessageFlag)
 Accessor to set value of largeMessageFlag. More...
const AddressgetDestination () const
 Accessor to get the value of destination. More...
bool setDestination (const Address &destination)
 Accessor to set value of destination. More...
system::TransportablegetPayload () const
 Accessor to get the value of payload. More...
bool setPayload (system::Transportable *payload)
 Accessor to set value of payload. More...
const AddressgetSource () const
 Accessor to get the value of source. More...
bool setSource (const Address &source)
 Accessor to set value of source. More...
TransportDatagetTransportData () const
 Accessor to get the value of transportData. More...
bool setTransportData (TransportData *transportData)
 Accessor to set value of transportData. More...
virtual int prioritizedValue ()
 Operation prioritizedValue. More...
virtual Wrapperclone ()
- Public Member Functions inherited from openjaus::system::Transportable
virtual ~Transportable ()
 Transportable ()
- Public Member Functions inherited from openjaus::system::Prioritized
virtual ~Prioritized ()
- Public Member Functions inherited from openjaus::model::Trigger
 Trigger ()
virtual ~Trigger ()
double getTriggerTimestamp_sec () const
 Accessor to get the value of triggerTimestamp_sec. More...
bool setTriggerTimestamp_sec (double triggerTimestamp_sec)
 Accessor to set value of triggerTimestamp_sec. More...
uint32_t getId () const
 Accessor to get the value of id. More...
bool setId (uint32_t id)
 Accessor to set value of id. More...
std::string idString ()
 Operation idString. More...

Static Public Attributes

static const uint16_t ID = 0x4415
static const uint8_t PV_ALL_FIELDS = 0xFF
static const uint8_t PV_NO_FIELDS = 0x0
static const uint8_t PV_VELOCITYX = 0x1
static const uint8_t PV_VELOCITYY = 0x2
static const uint8_t PV_VELOCITYZ = 0x4
static const uint8_t PV_ROLLRATE = 0x8
static const uint8_t PV_PITCHRATE = 0x10
static const uint8_t PV_YAWRATE = 0x20
static const double VELOCITYX_MIN_VALUE = -327.68
static const double VELOCITYX_MAX_VALUE = 327.67
static const double VELOCITYY_MIN_VALUE = -327.68
static const double VELOCITYY_MAX_VALUE = 327.67
static const double VELOCITYZ_MIN_VALUE = -327.68
static const double VELOCITYZ_MAX_VALUE = 327.67
static const double ROLLRATE_MIN_VALUE = -32.768
static const double ROLLRATE_MAX_VALUE = 32.767
static const double PITCHRATE_MIN_VALUE = -32.768
static const double PITCHRATE_MAX_VALUE = 32.767
static const double YAWRATE_MIN_VALUE = -32.768
static const double YAWRATE_MAX_VALUE = 32.767

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


OPENJAUS_EXPORT friend std::ostream & operator<< (std::ostream &output, const ReportVelocityCommand &object)
 OStream operator for Message object More...
OPENJAUS_EXPORT friend std::ostream & operator<< (std::ostream &output, const ReportVelocityCommand *object)
 OStream operator for Message pointer More...

Additional Inherited Members

- Protected Member Functions inherited from openjaus::transport::Wrapper
 Wrapper (const Wrapper &wrapper)
- Protected Attributes inherited from openjaus::transport::Wrapper
AckNakType ackNak
bool compressible
bool mustArrive
uint16_t sequenceNumber
WrapperType type
Priority priority
BroadcastType broadcastFlag
LargeMessageType largeMessageFlag
Address destination
Address source
- Protected Attributes inherited from openjaus::model::Trigger
double triggerTimestamp_sec
uint32_t id

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.

Constructor & Destructor Documentation

§ ReportVelocityCommand() [1/2]

openjaus::mobility::ReportVelocityCommand::ReportVelocityCommand ( )

§ ReportVelocityCommand() [2/2]

openjaus::mobility::ReportVelocityCommand::ReportVelocityCommand ( model::Message message)

§ ~ReportVelocityCommand()

openjaus::mobility::ReportVelocityCommand::~ReportVelocityCommand ( )

Member Function Documentation

§ disablePitchRate()

void openjaus::mobility::ReportVelocityCommand::disablePitchRate ( void  )

§ disableRollRate()

void openjaus::mobility::ReportVelocityCommand::disableRollRate ( void  )

§ disableVelocityX()

void openjaus::mobility::ReportVelocityCommand::disableVelocityX ( void  )

§ disableVelocityY()

void openjaus::mobility::ReportVelocityCommand::disableVelocityY ( void  )

§ disableVelocityZ()

void openjaus::mobility::ReportVelocityCommand::disableVelocityZ ( void  )

§ disableYawRate()

void openjaus::mobility::ReportVelocityCommand::disableYawRate ( void  )

§ enablePitchRate()

void openjaus::mobility::ReportVelocityCommand::enablePitchRate ( void  )

§ enableRollRate()

void openjaus::mobility::ReportVelocityCommand::enableRollRate ( void  )

§ enableVelocityX()

void openjaus::mobility::ReportVelocityCommand::enableVelocityX ( void  )

§ enableVelocityY()

void openjaus::mobility::ReportVelocityCommand::enableVelocityY ( void  )

§ enableVelocityZ()

void openjaus::mobility::ReportVelocityCommand::enableVelocityZ ( void  )

§ enableYawRate()

void openjaus::mobility::ReportVelocityCommand::enableYawRate ( void  )

§ from()

int openjaus::mobility::ReportVelocityCommand::from ( system::Buffer src)
[in]src- The source openjaus::system::Buffer from which this message will be unpacked.
The number of bytes unpacked from the source buffer

Reimplemented from openjaus::transport::Wrapper.

§ getCommandType()

VelocityCommandTypeEnumeration::VelocityCommandTypeEnum openjaus::mobility::ReportVelocityCommand::getCommandType ( void  )

§ getCommandTypeToString()

std::string openjaus::mobility::ReportVelocityCommand::getCommandTypeToString ( void  )

§ getPitchRate_rps()

double openjaus::mobility::ReportVelocityCommand::getPitchRate_rps ( void  )

§ getPresenceVector()

uint8_t openjaus::mobility::ReportVelocityCommand::getPresenceVector ( void  ) const

§ getRollRate_rps()

double openjaus::mobility::ReportVelocityCommand::getRollRate_rps ( void  )

§ getVelocityX_mps()

double openjaus::mobility::ReportVelocityCommand::getVelocityX_mps ( void  )

§ getVelocityY_mps()

double openjaus::mobility::ReportVelocityCommand::getVelocityY_mps ( void  )

§ getVelocityZ_mps()

double openjaus::mobility::ReportVelocityCommand::getVelocityZ_mps ( void  )

§ getYawRate_rps()

double openjaus::mobility::ReportVelocityCommand::getYawRate_rps ( void  )

§ isPitchRateEnabled()

bool openjaus::mobility::ReportVelocityCommand::isPitchRateEnabled ( void  ) const

§ isRollRateEnabled()

bool openjaus::mobility::ReportVelocityCommand::isRollRateEnabled ( void  ) const

§ isVelocityXEnabled()

bool openjaus::mobility::ReportVelocityCommand::isVelocityXEnabled ( void  ) const

§ isVelocityYEnabled()

bool openjaus::mobility::ReportVelocityCommand::isVelocityYEnabled ( void  ) const

§ isVelocityZEnabled()

bool openjaus::mobility::ReportVelocityCommand::isVelocityZEnabled ( void  ) const

§ isYawRateEnabled()

bool openjaus::mobility::ReportVelocityCommand::isYawRateEnabled ( void  ) const

§ length()

int openjaus::mobility::ReportVelocityCommand::length ( void  )
The number of bytes this message would occupy in a buffer

Reimplemented from openjaus::model::Message.

§ setCommandType()

bool openjaus::mobility::ReportVelocityCommand::setCommandType ( VelocityCommandTypeEnumeration::VelocityCommandTypeEnum  value)

§ setPitchRate_rps()

bool openjaus::mobility::ReportVelocityCommand::setPitchRate_rps ( double  value)

§ setPresenceVector()

void openjaus::mobility::ReportVelocityCommand::setPresenceVector ( uint8_t  value)

§ setRollRate_rps()

bool openjaus::mobility::ReportVelocityCommand::setRollRate_rps ( double  value)

§ setVelocityX_mps()

bool openjaus::mobility::ReportVelocityCommand::setVelocityX_mps ( double  value)

§ setVelocityY_mps()

bool openjaus::mobility::ReportVelocityCommand::setVelocityY_mps ( double  value)

§ setVelocityZ_mps()

bool openjaus::mobility::ReportVelocityCommand::setVelocityZ_mps ( double  value)

§ setYawRate_rps()

bool openjaus::mobility::ReportVelocityCommand::setYawRate_rps ( double  value)

§ to()

int openjaus::mobility::ReportVelocityCommand::to ( system::Buffer dst)
[out]dst- The destination openjaus::system::Buffer to which this message will be packed.
The number of bytes packed into the destination buffer

Reimplemented from openjaus::transport::Wrapper.

§ toString()

std::string openjaus::mobility::ReportVelocityCommand::toString ( ) const
The string

Reimplemented from openjaus::model::Message.

§ toXml()

std::string openjaus::mobility::ReportVelocityCommand::toXml ( unsigned char  ojIndentLevel = 0) const
[in]ojIndentLevel- Used to determine how many tabs are inserted per line for pretty formating.
The serialized XML string

Friends And Related Function Documentation

§ operator<< [1/2]

OPENJAUS_EXPORT friend std::ostream& operator<< ( std::ostream &  output,
const ReportVelocityCommand object 

§ operator<< [2/2]

OPENJAUS_EXPORT friend std::ostream& operator<< ( std::ostream &  output,
const ReportVelocityCommand object 

Member Data Documentation

§ commandType

VelocityCommandTypeEnumeration openjaus::mobility::ReportVelocityCommand::commandType

§ ID

const uint16_t openjaus::mobility::ReportVelocityCommand::ID = 0x4415


const double openjaus::mobility::ReportVelocityCommand::PITCHRATE_MAX_VALUE = 32.767


const double openjaus::mobility::ReportVelocityCommand::PITCHRATE_MIN_VALUE = -32.768

§ pitchRate_rps

AngularVelocityScaledInteger openjaus::mobility::ReportVelocityCommand::pitchRate_rps

§ presenceVector

uint8_t openjaus::mobility::ReportVelocityCommand::presenceVector


const uint8_t openjaus::mobility::ReportVelocityCommand::PV_ALL_FIELDS = 0xFF


const uint8_t openjaus::mobility::ReportVelocityCommand::PV_NO_FIELDS = 0x0


const uint8_t openjaus::mobility::ReportVelocityCommand::PV_PITCHRATE = 0x10


const uint8_t openjaus::mobility::ReportVelocityCommand::PV_ROLLRATE = 0x8


const uint8_t openjaus::mobility::ReportVelocityCommand::PV_VELOCITYX = 0x1


const uint8_t openjaus::mobility::ReportVelocityCommand::PV_VELOCITYY = 0x2


const uint8_t openjaus::mobility::ReportVelocityCommand::PV_VELOCITYZ = 0x4


const uint8_t openjaus::mobility::ReportVelocityCommand::PV_YAWRATE = 0x20


const double openjaus::mobility::ReportVelocityCommand::ROLLRATE_MAX_VALUE = 32.767


const double openjaus::mobility::ReportVelocityCommand::ROLLRATE_MIN_VALUE = -32.768

§ rollRate_rps

AngularVelocityScaledInteger openjaus::mobility::ReportVelocityCommand::rollRate_rps


const double openjaus::mobility::ReportVelocityCommand::VELOCITYX_MAX_VALUE = 327.67


const double openjaus::mobility::ReportVelocityCommand::VELOCITYX_MIN_VALUE = -327.68

§ velocityX_mps

LinearVelocityScaledInteger openjaus::mobility::ReportVelocityCommand::velocityX_mps


const double openjaus::mobility::ReportVelocityCommand::VELOCITYY_MAX_VALUE = 327.67


const double openjaus::mobility::ReportVelocityCommand::VELOCITYY_MIN_VALUE = -327.68

§ velocityY_mps

LinearVelocityScaledInteger openjaus::mobility::ReportVelocityCommand::velocityY_mps


const double openjaus::mobility::ReportVelocityCommand::VELOCITYZ_MAX_VALUE = 327.67


const double openjaus::mobility::ReportVelocityCommand::VELOCITYZ_MIN_VALUE = -327.68

§ velocityZ_mps

LinearVelocityScaledInteger openjaus::mobility::ReportVelocityCommand::velocityZ_mps


const double openjaus::mobility::ReportVelocityCommand::YAWRATE_MAX_VALUE = 32.767


const double openjaus::mobility::ReportVelocityCommand::YAWRATE_MIN_VALUE = -32.768

§ yawRate_rps

AngularVelocityScaledInteger openjaus::mobility::ReportVelocityCommand::yawRate_rps

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