OpenJAUS SAE SDK  6.0.0
Public Member Functions | Static Public Attributes | Protected Attributes | List of all members
openjaus::mobility_v1_0::LocalPoseRecord Class Reference

#include <LocalPoseRecord.h>

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

Public Member Functions

 LocalPoseRecord ()
 
 LocalPoseRecord (const LocalPoseRecord &source)
 
 ~LocalPoseRecord ()
 
void copy (LocalPoseRecord &source)
 
virtual uint64 to (system::BufferWriter &dst) const
 Serializes the contents of this object into the Buffer connected to the provided BufferWriter. More...
 
virtual uint64 from (system::BufferReader &src)
 Deserializes the contents the Buffer connected to the provided BufferReader into this object. More...
 
virtual uint64 length (void) const
 Gets the serialized length of this object. More...
 
std::string toXml (unsigned char ojIndentLevel=0) const
 
void setPresenceVector (uint16_t value)
 
uint16_t getPresenceVector (void) const
 
bool isXEnabled (void) const
 
void enableX (void)
 
void disableX (void)
 
bool isYEnabled (void) const
 
void enableY (void)
 
void disableY (void)
 
bool isZEnabled (void) const
 
void enableZ (void)
 
void disableZ (void)
 
bool isPositionRmsEnabled (void) const
 
void enablePositionRms (void)
 
void disablePositionRms (void)
 
bool isRollEnabled (void) const
 
void enableRoll (void)
 
void disableRoll (void)
 
bool isPitchEnabled (void) const
 
void enablePitch (void)
 
void disablePitch (void)
 
bool isYawEnabled (void) const
 
void enableYaw (void)
 
void disableYaw (void)
 
bool isAttitudeRmsEnabled (void) const
 
void enableAttitudeRms (void)
 
void disableAttitudeRms (void)
 
bool isTimeStampEnabled (void) const
 
void enableTimeStamp (void)
 
void disableTimeStamp (void)
 
double getX_m (void)
 
bool setX_m (double value)
 
double getY_m (void)
 
bool setY_m (double value)
 
double getZ_m (void)
 
bool setZ_m (double value)
 
double getPositionRms_m (void)
 
bool setPositionRms_m (double value)
 
double getRoll_rad (void)
 
bool setRoll_rad (double value)
 
double getPitch_rad (void)
 
bool setPitch_rad (double value)
 
double getYaw_rad (void)
 
bool setYaw_rad (double value)
 
double getAttitudeRms_rad (void)
 
bool setAttitudeRms_rad (double value)
 
model::fields::TimeStamp & getTimeStamp (void)
 
- 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
 Transportable ()
 
virtual ~Transportable ()
 

Static Public Attributes

static const uint16_t PV_NO_FIELDS = 0x0
 
static const uint16_t PV_X = 0x1
 
static const uint16_t PV_Y = 0x2
 
static const uint16_t PV_Z = 0x4
 
static const uint16_t PV_POSITIONRMS = 0x8
 
static const uint16_t PV_ROLL = 0x10
 
static const uint16_t PV_PITCH = 0x20
 
static const uint16_t PV_YAW = 0x40
 
static const uint16_t PV_ATTITUDERMS = 0x80
 
static const uint16_t PV_TIMESTAMP = 0x100
 
static const uint16_t PV_ALL_FIELDS = PV_NO_FIELDS | PV_X | PV_Y | PV_Z | PV_POSITIONRMS | PV_ROLL | PV_PITCH | PV_YAW | PV_ATTITUDERMS | PV_TIMESTAMP
 

Protected Attributes

LocalPositionScaledInteger x_m
 
LocalPositionScaledInteger y_m
 
LocalPositionScaledInteger z_m
 
LocalPositionRmsScaledInteger positionRms_m
 
OrientationScaledInteger roll_rad
 
OrientationScaledInteger pitch_rad
 
OrientationScaledInteger yaw_rad
 
OrientationRmsScaledInteger attitudeRms_rad
 
model::fields::TimeStamp timeStamp
 
uint16_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

◆ LocalPoseRecord() [1/2]

openjaus::mobility_v1_0::LocalPoseRecord::LocalPoseRecord ( )

◆ LocalPoseRecord() [2/2]

openjaus::mobility_v1_0::LocalPoseRecord::LocalPoseRecord ( const LocalPoseRecord &  source)

◆ ~LocalPoseRecord()

openjaus::mobility_v1_0::LocalPoseRecord::~LocalPoseRecord ( )

Member Function Documentation

◆ copy()

void openjaus::mobility_v1_0::LocalPoseRecord::copy ( LocalPoseRecord &  source)

◆ disableAttitudeRms()

void openjaus::mobility_v1_0::LocalPoseRecord::disableAttitudeRms ( void  )

◆ disablePitch()

void openjaus::mobility_v1_0::LocalPoseRecord::disablePitch ( void  )

◆ disablePositionRms()

void openjaus::mobility_v1_0::LocalPoseRecord::disablePositionRms ( void  )

◆ disableRoll()

void openjaus::mobility_v1_0::LocalPoseRecord::disableRoll ( void  )

◆ disableTimeStamp()

void openjaus::mobility_v1_0::LocalPoseRecord::disableTimeStamp ( void  )

◆ disableX()

void openjaus::mobility_v1_0::LocalPoseRecord::disableX ( void  )

◆ disableY()

void openjaus::mobility_v1_0::LocalPoseRecord::disableY ( void  )

◆ disableYaw()

void openjaus::mobility_v1_0::LocalPoseRecord::disableYaw ( void  )

◆ disableZ()

void openjaus::mobility_v1_0::LocalPoseRecord::disableZ ( void  )

◆ enableAttitudeRms()

void openjaus::mobility_v1_0::LocalPoseRecord::enableAttitudeRms ( void  )

◆ enablePitch()

void openjaus::mobility_v1_0::LocalPoseRecord::enablePitch ( void  )

◆ enablePositionRms()

void openjaus::mobility_v1_0::LocalPoseRecord::enablePositionRms ( void  )

◆ enableRoll()

void openjaus::mobility_v1_0::LocalPoseRecord::enableRoll ( void  )

◆ enableTimeStamp()

void openjaus::mobility_v1_0::LocalPoseRecord::enableTimeStamp ( void  )

◆ enableX()

void openjaus::mobility_v1_0::LocalPoseRecord::enableX ( void  )

◆ enableY()

void openjaus::mobility_v1_0::LocalPoseRecord::enableY ( void  )

◆ enableYaw()

void openjaus::mobility_v1_0::LocalPoseRecord::enableYaw ( void  )

◆ enableZ()

void openjaus::mobility_v1_0::LocalPoseRecord::enableZ ( void  )

◆ from()

uint64 openjaus::mobility_v1_0::LocalPoseRecord::from ( system::BufferReader &  src)
virtual

Deserializes the contents the Buffer connected to the provided BufferReader into this object. The BufferReader position will be advanced inside this method such that calling from() again will attempt to read the next Transportable object from the Buffer.

Parameters
src

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

◆ getAttitudeRms_rad()

double openjaus::mobility_v1_0::LocalPoseRecord::getAttitudeRms_rad ( void  )

◆ getPitch_rad()

double openjaus::mobility_v1_0::LocalPoseRecord::getPitch_rad ( void  )

◆ getPositionRms_m()

double openjaus::mobility_v1_0::LocalPoseRecord::getPositionRms_m ( void  )

◆ getPresenceVector()

uint16_t openjaus::mobility_v1_0::LocalPoseRecord::getPresenceVector ( void  ) const

◆ getRoll_rad()

double openjaus::mobility_v1_0::LocalPoseRecord::getRoll_rad ( void  )

◆ getTimeStamp()

model::fields::TimeStamp & openjaus::mobility_v1_0::LocalPoseRecord::getTimeStamp ( void  )

◆ getX_m()

double openjaus::mobility_v1_0::LocalPoseRecord::getX_m ( void  )

◆ getY_m()

double openjaus::mobility_v1_0::LocalPoseRecord::getY_m ( void  )

◆ getYaw_rad()

double openjaus::mobility_v1_0::LocalPoseRecord::getYaw_rad ( void  )

◆ getZ_m()

double openjaus::mobility_v1_0::LocalPoseRecord::getZ_m ( void  )

◆ isAttitudeRmsEnabled()

bool openjaus::mobility_v1_0::LocalPoseRecord::isAttitudeRmsEnabled ( void  ) const

◆ isPitchEnabled()

bool openjaus::mobility_v1_0::LocalPoseRecord::isPitchEnabled ( void  ) const

◆ isPositionRmsEnabled()

bool openjaus::mobility_v1_0::LocalPoseRecord::isPositionRmsEnabled ( void  ) const

◆ isRollEnabled()

bool openjaus::mobility_v1_0::LocalPoseRecord::isRollEnabled ( void  ) const

◆ isTimeStampEnabled()

bool openjaus::mobility_v1_0::LocalPoseRecord::isTimeStampEnabled ( void  ) const

◆ isXEnabled()

bool openjaus::mobility_v1_0::LocalPoseRecord::isXEnabled ( void  ) const

◆ isYawEnabled()

bool openjaus::mobility_v1_0::LocalPoseRecord::isYawEnabled ( void  ) const

◆ isYEnabled()

bool openjaus::mobility_v1_0::LocalPoseRecord::isYEnabled ( void  ) const

◆ isZEnabled()

bool openjaus::mobility_v1_0::LocalPoseRecord::isZEnabled ( void  ) const

◆ length()

uint64 openjaus::mobility_v1_0::LocalPoseRecord::length ( void  ) const
virtual

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

◆ setAttitudeRms_rad()

bool openjaus::mobility_v1_0::LocalPoseRecord::setAttitudeRms_rad ( double  value)

◆ setPitch_rad()

bool openjaus::mobility_v1_0::LocalPoseRecord::setPitch_rad ( double  value)

◆ setPositionRms_m()

bool openjaus::mobility_v1_0::LocalPoseRecord::setPositionRms_m ( double  value)

◆ setPresenceVector()

void openjaus::mobility_v1_0::LocalPoseRecord::setPresenceVector ( uint16_t  value)

◆ setRoll_rad()

bool openjaus::mobility_v1_0::LocalPoseRecord::setRoll_rad ( double  value)

◆ setX_m()

bool openjaus::mobility_v1_0::LocalPoseRecord::setX_m ( double  value)

◆ setY_m()

bool openjaus::mobility_v1_0::LocalPoseRecord::setY_m ( double  value)

◆ setYaw_rad()

bool openjaus::mobility_v1_0::LocalPoseRecord::setYaw_rad ( double  value)

◆ setZ_m()

bool openjaus::mobility_v1_0::LocalPoseRecord::setZ_m ( double  value)

◆ to()

uint64 openjaus::mobility_v1_0::LocalPoseRecord::to ( system::BufferWriter &  dst) const
virtual

Serializes the contents of this object into the Buffer connected to the provided BufferWriter. The BufferWriter position will be advanced inside this method such that calling to() again will write the Transportable object into the Buffer a second time.

Parameters
dst

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

◆ toXml()

std::string openjaus::mobility_v1_0::LocalPoseRecord::toXml ( unsigned char  ojIndentLevel = 0) const

Member Data Documentation

◆ attitudeRms_rad

OrientationRmsScaledInteger openjaus::mobility_v1_0::LocalPoseRecord::attitudeRms_rad
protected

◆ pitch_rad

OrientationScaledInteger openjaus::mobility_v1_0::LocalPoseRecord::pitch_rad
protected

◆ positionRms_m

LocalPositionRmsScaledInteger openjaus::mobility_v1_0::LocalPoseRecord::positionRms_m
protected

◆ presenceVector

uint16_t openjaus::mobility_v1_0::LocalPoseRecord::presenceVector
protected

◆ PV_ALL_FIELDS

const uint16_t openjaus::mobility_v1_0::LocalPoseRecord::PV_ALL_FIELDS = PV_NO_FIELDS | PV_X | PV_Y | PV_Z | PV_POSITIONRMS | PV_ROLL | PV_PITCH | PV_YAW | PV_ATTITUDERMS | PV_TIMESTAMP
static

◆ PV_ATTITUDERMS

const uint16_t openjaus::mobility_v1_0::LocalPoseRecord::PV_ATTITUDERMS = 0x80
static

◆ PV_NO_FIELDS

const uint16_t openjaus::mobility_v1_0::LocalPoseRecord::PV_NO_FIELDS = 0x0
static

◆ PV_PITCH

const uint16_t openjaus::mobility_v1_0::LocalPoseRecord::PV_PITCH = 0x20
static

◆ PV_POSITIONRMS

const uint16_t openjaus::mobility_v1_0::LocalPoseRecord::PV_POSITIONRMS = 0x8
static

◆ PV_ROLL

const uint16_t openjaus::mobility_v1_0::LocalPoseRecord::PV_ROLL = 0x10
static

◆ PV_TIMESTAMP

const uint16_t openjaus::mobility_v1_0::LocalPoseRecord::PV_TIMESTAMP = 0x100
static

◆ PV_X

const uint16_t openjaus::mobility_v1_0::LocalPoseRecord::PV_X = 0x1
static

◆ PV_Y

const uint16_t openjaus::mobility_v1_0::LocalPoseRecord::PV_Y = 0x2
static

◆ PV_YAW

const uint16_t openjaus::mobility_v1_0::LocalPoseRecord::PV_YAW = 0x40
static

◆ PV_Z

const uint16_t openjaus::mobility_v1_0::LocalPoseRecord::PV_Z = 0x4
static

◆ roll_rad

OrientationScaledInteger openjaus::mobility_v1_0::LocalPoseRecord::roll_rad
protected

◆ timeStamp

model::fields::TimeStamp openjaus::mobility_v1_0::LocalPoseRecord::timeStamp
protected

◆ x_m

LocalPositionScaledInteger openjaus::mobility_v1_0::LocalPoseRecord::x_m
protected

◆ y_m

LocalPositionScaledInteger openjaus::mobility_v1_0::LocalPoseRecord::y_m
protected

◆ yaw_rad

OrientationScaledInteger openjaus::mobility_v1_0::LocalPoseRecord::yaw_rad
protected

◆ z_m

LocalPositionScaledInteger openjaus::mobility_v1_0::LocalPoseRecord::z_m
protected
The documentation for this class was generated from the following files: