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

SetAccelerationLimit Message Implementation. More...

#include <SetAccelerationLimit.h>

Inherits openjaus::model::Message.

Public Member Functions

 SetAccelerationLimit ()
 
 SetAccelerationLimit (model::Message *message)
 
 ~SetAccelerationLimit ()
 
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 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)
 
bool setCommandType (AccelerationCommandTypeEnumeration::AccelerationCommandTypeEnum value)
 
std::string getCommandTypeToString (void)
 
double getAccelerationX_mps2 (void)
 
bool setAccelerationX_mps2 (double value)
 
double getAccelerationY_mps2 (void)
 
bool setAccelerationY_mps2 (double value)
 
double getAccelerationZ_mps2 (void)
 
bool setAccelerationZ_mps2 (double value)
 
double getRollAcceleration_rps2 (void)
 
bool setRollAcceleration_rps2 (double value)
 
double getPitchAcceleration_rps2 (void)
 
bool setPitchAcceleration_rps2 (double value)
 
double getYawAcceleration_rps2 (void)
 
bool setYawAcceleration_rps2 (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 = 0x0416
 
static const uint8_t PV_ALL_FIELDS = 0xFF
 
static const uint8_t PV_NO_FIELDS = 0x0
 
static const uint8_t PV_ACCELERATIONX = 0x1
 
static const uint8_t PV_ACCELERATIONY = 0x2
 
static const uint8_t PV_ACCELERATIONZ = 0x4
 
static const uint8_t PV_ROLLACCELERATION = 0x8
 
static const uint8_t PV_PITCHACCELERATION = 0x10
 
static const uint8_t PV_YAWACCELERATION = 0x20
 
static const double ACCELERATIONX_MIN_VALUE = -1310.68
 
static const double ACCELERATIONX_MAX_VALUE = 1310.68
 
static const double ACCELERATIONY_MIN_VALUE = -1310.68
 
static const double ACCELERATIONY_MAX_VALUE = 1310.68
 
static const double ACCELERATIONZ_MIN_VALUE = -1310.68
 
static const double ACCELERATIONZ_MAX_VALUE = 1310.68
 
static const double ROLLACCELERATION_MIN_VALUE = -13106.8
 
static const double ROLLACCELERATION_MAX_VALUE = 13106.8
 
static const double PITCHACCELERATION_MIN_VALUE = -13106.8
 
static const double PITCHACCELERATION_MAX_VALUE = 13106.8
 
static const double YAWACCELERATION_MIN_VALUE = -13106.8
 
static const double YAWACCELERATION_MAX_VALUE = 13106.8
 

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
 

Friends

OPENJAUS_EXPORT friend std::ostream & operator<< (std::ostream &output, const SetAccelerationLimit &object)
 OStream operator for Message object More...
 
OPENJAUS_EXPORT friend std::ostream & operator<< (std::ostream &output, const SetAccelerationLimit *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
 
system::Transportablepayload
 
Address source
 
TransportDatatransportData
 
- Protected Attributes inherited from openjaus::model::Trigger
double triggerTimestamp_sec
 
uint32_t id
 

Detailed Description

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

Constructor & Destructor Documentation

§ SetAccelerationLimit() [1/2]

openjaus::mobility::SetAccelerationLimit::SetAccelerationLimit ( )

§ SetAccelerationLimit() [2/2]

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

§ ~SetAccelerationLimit()

openjaus::mobility::SetAccelerationLimit::~SetAccelerationLimit ( )

Member Function Documentation

§ disableAccelerationX()

void openjaus::mobility::SetAccelerationLimit::disableAccelerationX ( void  )

§ disableAccelerationY()

void openjaus::mobility::SetAccelerationLimit::disableAccelerationY ( void  )

§ disableAccelerationZ()

void openjaus::mobility::SetAccelerationLimit::disableAccelerationZ ( void  )

§ disablePitchAcceleration()

void openjaus::mobility::SetAccelerationLimit::disablePitchAcceleration ( void  )

§ disableRollAcceleration()

void openjaus::mobility::SetAccelerationLimit::disableRollAcceleration ( void  )

§ disableYawAcceleration()

void openjaus::mobility::SetAccelerationLimit::disableYawAcceleration ( void  )

§ enableAccelerationX()

void openjaus::mobility::SetAccelerationLimit::enableAccelerationX ( void  )

§ enableAccelerationY()

void openjaus::mobility::SetAccelerationLimit::enableAccelerationY ( void  )

§ enableAccelerationZ()

void openjaus::mobility::SetAccelerationLimit::enableAccelerationZ ( void  )

§ enablePitchAcceleration()

void openjaus::mobility::SetAccelerationLimit::enablePitchAcceleration ( void  )

§ enableRollAcceleration()

void openjaus::mobility::SetAccelerationLimit::enableRollAcceleration ( void  )

§ enableYawAcceleration()

void openjaus::mobility::SetAccelerationLimit::enableYawAcceleration ( void  )

§ from()

int openjaus::mobility::SetAccelerationLimit::from ( system::Buffer src)
virtual
Parameters
[in]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::transport::Wrapper.

§ getAccelerationX_mps2()

double openjaus::mobility::SetAccelerationLimit::getAccelerationX_mps2 ( void  )

§ getAccelerationY_mps2()

double openjaus::mobility::SetAccelerationLimit::getAccelerationY_mps2 ( void  )

§ getAccelerationZ_mps2()

double openjaus::mobility::SetAccelerationLimit::getAccelerationZ_mps2 ( void  )

§ getCommandType()

AccelerationCommandTypeEnumeration::AccelerationCommandTypeEnum openjaus::mobility::SetAccelerationLimit::getCommandType ( void  )

§ getCommandTypeToString()

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

§ getPitchAcceleration_rps2()

double openjaus::mobility::SetAccelerationLimit::getPitchAcceleration_rps2 ( void  )

§ getPresenceVector()

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

§ getRollAcceleration_rps2()

double openjaus::mobility::SetAccelerationLimit::getRollAcceleration_rps2 ( void  )

§ getYawAcceleration_rps2()

double openjaus::mobility::SetAccelerationLimit::getYawAcceleration_rps2 ( void  )

§ isAccelerationXEnabled()

bool openjaus::mobility::SetAccelerationLimit::isAccelerationXEnabled ( void  ) const

§ isAccelerationYEnabled()

bool openjaus::mobility::SetAccelerationLimit::isAccelerationYEnabled ( void  ) const

§ isAccelerationZEnabled()

bool openjaus::mobility::SetAccelerationLimit::isAccelerationZEnabled ( void  ) const

§ isPitchAccelerationEnabled()

bool openjaus::mobility::SetAccelerationLimit::isPitchAccelerationEnabled ( void  ) const

§ isRollAccelerationEnabled()

bool openjaus::mobility::SetAccelerationLimit::isRollAccelerationEnabled ( void  ) const

§ isYawAccelerationEnabled()

bool openjaus::mobility::SetAccelerationLimit::isYawAccelerationEnabled ( void  ) const

§ length()

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

Reimplemented from openjaus::model::Message.

§ setAccelerationX_mps2()

bool openjaus::mobility::SetAccelerationLimit::setAccelerationX_mps2 ( double  value)

§ setAccelerationY_mps2()

bool openjaus::mobility::SetAccelerationLimit::setAccelerationY_mps2 ( double  value)

§ setAccelerationZ_mps2()

bool openjaus::mobility::SetAccelerationLimit::setAccelerationZ_mps2 ( double  value)

§ setCommandType()

bool openjaus::mobility::SetAccelerationLimit::setCommandType ( AccelerationCommandTypeEnumeration::AccelerationCommandTypeEnum  value)

§ setPitchAcceleration_rps2()

bool openjaus::mobility::SetAccelerationLimit::setPitchAcceleration_rps2 ( double  value)

§ setPresenceVector()

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

§ setRollAcceleration_rps2()

bool openjaus::mobility::SetAccelerationLimit::setRollAcceleration_rps2 ( double  value)

§ setYawAcceleration_rps2()

bool openjaus::mobility::SetAccelerationLimit::setYawAcceleration_rps2 ( double  value)

§ to()

int openjaus::mobility::SetAccelerationLimit::to ( system::Buffer dst)
virtual
Parameters
[out]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::transport::Wrapper.

§ toString()

std::string openjaus::mobility::SetAccelerationLimit::toString ( ) const
virtual
Returns
The string

Reimplemented from openjaus::model::Message.

§ toXml()

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

Friends And Related Function Documentation

§ operator<< [1/2]

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

§ operator<< [2/2]

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

Member Data Documentation

§ ACCELERATIONX_MAX_VALUE

const double openjaus::mobility::SetAccelerationLimit::ACCELERATIONX_MAX_VALUE = 1310.68
static

§ ACCELERATIONX_MIN_VALUE

const double openjaus::mobility::SetAccelerationLimit::ACCELERATIONX_MIN_VALUE = -1310.68
static

§ accelerationX_mps2

LinearAccelerationScaledInteger openjaus::mobility::SetAccelerationLimit::accelerationX_mps2
private

§ ACCELERATIONY_MAX_VALUE

const double openjaus::mobility::SetAccelerationLimit::ACCELERATIONY_MAX_VALUE = 1310.68
static

§ ACCELERATIONY_MIN_VALUE

const double openjaus::mobility::SetAccelerationLimit::ACCELERATIONY_MIN_VALUE = -1310.68
static

§ accelerationY_mps2

LinearAccelerationScaledInteger openjaus::mobility::SetAccelerationLimit::accelerationY_mps2
private

§ ACCELERATIONZ_MAX_VALUE

const double openjaus::mobility::SetAccelerationLimit::ACCELERATIONZ_MAX_VALUE = 1310.68
static

§ ACCELERATIONZ_MIN_VALUE

const double openjaus::mobility::SetAccelerationLimit::ACCELERATIONZ_MIN_VALUE = -1310.68
static

§ accelerationZ_mps2

LinearAccelerationScaledInteger openjaus::mobility::SetAccelerationLimit::accelerationZ_mps2
private

§ commandType

AccelerationCommandTypeEnumeration openjaus::mobility::SetAccelerationLimit::commandType
private

§ ID

const uint16_t openjaus::mobility::SetAccelerationLimit::ID = 0x0416
static

§ PITCHACCELERATION_MAX_VALUE

const double openjaus::mobility::SetAccelerationLimit::PITCHACCELERATION_MAX_VALUE = 13106.8
static

§ PITCHACCELERATION_MIN_VALUE

const double openjaus::mobility::SetAccelerationLimit::PITCHACCELERATION_MIN_VALUE = -13106.8
static

§ pitchAcceleration_rps2

AngularAccelerationScaledInteger openjaus::mobility::SetAccelerationLimit::pitchAcceleration_rps2
private

§ presenceVector

uint8_t openjaus::mobility::SetAccelerationLimit::presenceVector
private

§ PV_ACCELERATIONX

const uint8_t openjaus::mobility::SetAccelerationLimit::PV_ACCELERATIONX = 0x1
static

§ PV_ACCELERATIONY

const uint8_t openjaus::mobility::SetAccelerationLimit::PV_ACCELERATIONY = 0x2
static

§ PV_ACCELERATIONZ

const uint8_t openjaus::mobility::SetAccelerationLimit::PV_ACCELERATIONZ = 0x4
static

§ PV_ALL_FIELDS

const uint8_t openjaus::mobility::SetAccelerationLimit::PV_ALL_FIELDS = 0xFF
static

§ PV_NO_FIELDS

const uint8_t openjaus::mobility::SetAccelerationLimit::PV_NO_FIELDS = 0x0
static

§ PV_PITCHACCELERATION

const uint8_t openjaus::mobility::SetAccelerationLimit::PV_PITCHACCELERATION = 0x10
static

§ PV_ROLLACCELERATION

const uint8_t openjaus::mobility::SetAccelerationLimit::PV_ROLLACCELERATION = 0x8
static

§ PV_YAWACCELERATION

const uint8_t openjaus::mobility::SetAccelerationLimit::PV_YAWACCELERATION = 0x20
static

§ ROLLACCELERATION_MAX_VALUE

const double openjaus::mobility::SetAccelerationLimit::ROLLACCELERATION_MAX_VALUE = 13106.8
static

§ ROLLACCELERATION_MIN_VALUE

const double openjaus::mobility::SetAccelerationLimit::ROLLACCELERATION_MIN_VALUE = -13106.8
static

§ rollAcceleration_rps2

AngularAccelerationScaledInteger openjaus::mobility::SetAccelerationLimit::rollAcceleration_rps2
private

§ YAWACCELERATION_MAX_VALUE

const double openjaus::mobility::SetAccelerationLimit::YAWACCELERATION_MAX_VALUE = 13106.8
static

§ YAWACCELERATION_MIN_VALUE

const double openjaus::mobility::SetAccelerationLimit::YAWACCELERATION_MIN_VALUE = -13106.8
static

§ yawAcceleration_rps2

AngularAccelerationScaledInteger openjaus::mobility::SetAccelerationLimit::yawAcceleration_rps2
private

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