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

#include <VelocityCommandRecord.h>

Inherits openjaus::model::fields::Record.

Public Member Functions

 VelocityCommandRecord ()
 
 VelocityCommandRecord (const VelocityCommandRecord &source)
 
 ~VelocityCommandRecord ()
 
void copy (VelocityCommandRecord &source)
 
virtual int to (system::Buffer *dst)
 Operation to. More...
 
virtual int from (system::Buffer *src)
 Operation from. More...
 
virtual int length (void)
 Serializes object to internal transport buffer. More...
 
std::string toXml (unsigned char ojIndentLevel=0) const
 
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::fields::Record
 Record ()
 
virtual ~Record ()
 
const std::vector< Field *> & getFields () const
 Accessor to get the value of fields. More...
 
bool setFields (const Field &fields)
 Accessor to set value of fields. More...
 
virtual std::string toString () const
 
- Public Member Functions inherited from openjaus::model::fields::ComplexField
virtual ~ComplexField ()
 
- Public Member Functions inherited from openjaus::model::fields::Field
 Field ()
 
virtual ~Field ()
 
std::string getName () const
 Accessor to get the value of name. More...
 
bool setName (std::string name)
 Accessor to set value of name. More...
 
- Public Member Functions inherited from openjaus::system::Transportable
virtual ~Transportable ()
 
 Transportable ()
 

Static Public Attributes

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
 

Protected Attributes

VelocityCommandTypeEnumeration commandType
 
LinearVelocityScaledInteger velocityX_mps
 
LinearVelocityScaledInteger velocityY_mps
 
LinearVelocityScaledInteger velocityZ_mps
 
AngularVelocityScaledInteger rollRate_rps
 
AngularVelocityScaledInteger pitchRate_rps
 
AngularVelocityScaledInteger yawRate_rps
 
uint8_t presenceVector
 
- Protected Attributes inherited from openjaus::model::fields::Record
std::vector< Field *> fields
 
- Protected Attributes inherited from openjaus::model::fields::Field
std::string name
 

Constructor & Destructor Documentation

§ VelocityCommandRecord() [1/2]

openjaus::mobility::VelocityCommandRecord::VelocityCommandRecord ( )

§ VelocityCommandRecord() [2/2]

openjaus::mobility::VelocityCommandRecord::VelocityCommandRecord ( const VelocityCommandRecord source)

§ ~VelocityCommandRecord()

openjaus::mobility::VelocityCommandRecord::~VelocityCommandRecord ( )

Member Function Documentation

§ copy()

void openjaus::mobility::VelocityCommandRecord::copy ( VelocityCommandRecord source)

§ disablePitchRate()

void openjaus::mobility::VelocityCommandRecord::disablePitchRate ( void  )

§ disableRollRate()

void openjaus::mobility::VelocityCommandRecord::disableRollRate ( void  )

§ disableVelocityX()

void openjaus::mobility::VelocityCommandRecord::disableVelocityX ( void  )

§ disableVelocityY()

void openjaus::mobility::VelocityCommandRecord::disableVelocityY ( void  )

§ disableVelocityZ()

void openjaus::mobility::VelocityCommandRecord::disableVelocityZ ( void  )

§ disableYawRate()

void openjaus::mobility::VelocityCommandRecord::disableYawRate ( void  )

§ enablePitchRate()

void openjaus::mobility::VelocityCommandRecord::enablePitchRate ( void  )

§ enableRollRate()

void openjaus::mobility::VelocityCommandRecord::enableRollRate ( void  )

§ enableVelocityX()

void openjaus::mobility::VelocityCommandRecord::enableVelocityX ( void  )

§ enableVelocityY()

void openjaus::mobility::VelocityCommandRecord::enableVelocityY ( void  )

§ enableVelocityZ()

void openjaus::mobility::VelocityCommandRecord::enableVelocityZ ( void  )

§ enableYawRate()

void openjaus::mobility::VelocityCommandRecord::enableYawRate ( void  )

§ from()

int openjaus::mobility::VelocityCommandRecord::from ( system::Buffer src)
virtual
Parameters
src

Reimplemented from openjaus::model::fields::Record.

§ getCommandType()

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

§ getCommandTypeToString()

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

§ getPitchRate_rps()

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

§ getPresenceVector()

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

§ getRollRate_rps()

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

§ getVelocityX_mps()

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

§ getVelocityY_mps()

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

§ getVelocityZ_mps()

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

§ getYawRate_rps()

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

§ isPitchRateEnabled()

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

§ isRollRateEnabled()

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

§ isVelocityXEnabled()

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

§ isVelocityYEnabled()

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

§ isVelocityZEnabled()

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

§ isYawRateEnabled()

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

§ length()

int openjaus::mobility::VelocityCommandRecord::length ( void  )
virtual

Reimplemented from openjaus::model::fields::Record.

§ setCommandType()

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

§ setPitchRate_rps()

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

§ setPresenceVector()

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

§ setRollRate_rps()

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

§ setVelocityX_mps()

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

§ setVelocityY_mps()

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

§ setVelocityZ_mps()

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

§ setYawRate_rps()

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

§ to()

int openjaus::mobility::VelocityCommandRecord::to ( system::Buffer dst)
virtual
Parameters
dst

Reimplemented from openjaus::model::fields::Record.

§ toXml()

std::string openjaus::mobility::VelocityCommandRecord::toXml ( unsigned char  ojIndentLevel = 0) const

Member Data Documentation

§ commandType

VelocityCommandTypeEnumeration openjaus::mobility::VelocityCommandRecord::commandType
protected

§ pitchRate_rps

AngularVelocityScaledInteger openjaus::mobility::VelocityCommandRecord::pitchRate_rps
protected

§ presenceVector

uint8_t openjaus::mobility::VelocityCommandRecord::presenceVector
protected

§ PV_ALL_FIELDS

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

§ PV_NO_FIELDS

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

§ PV_PITCHRATE

const uint8_t openjaus::mobility::VelocityCommandRecord::PV_PITCHRATE = 0x10
static

§ PV_ROLLRATE

const uint8_t openjaus::mobility::VelocityCommandRecord::PV_ROLLRATE = 0x8
static

§ PV_VELOCITYX

const uint8_t openjaus::mobility::VelocityCommandRecord::PV_VELOCITYX = 0x1
static

§ PV_VELOCITYY

const uint8_t openjaus::mobility::VelocityCommandRecord::PV_VELOCITYY = 0x2
static

§ PV_VELOCITYZ

const uint8_t openjaus::mobility::VelocityCommandRecord::PV_VELOCITYZ = 0x4
static

§ PV_YAWRATE

const uint8_t openjaus::mobility::VelocityCommandRecord::PV_YAWRATE = 0x20
static

§ rollRate_rps

AngularVelocityScaledInteger openjaus::mobility::VelocityCommandRecord::rollRate_rps
protected

§ velocityX_mps

LinearVelocityScaledInteger openjaus::mobility::VelocityCommandRecord::velocityX_mps
protected

§ velocityY_mps

LinearVelocityScaledInteger openjaus::mobility::VelocityCommandRecord::velocityY_mps
protected

§ velocityZ_mps

LinearVelocityScaledInteger openjaus::mobility::VelocityCommandRecord::velocityZ_mps
protected

§ yawRate_rps

AngularVelocityScaledInteger openjaus::mobility::VelocityCommandRecord::yawRate_rps
protected

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