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

#include <PlatformSpecRecord.h>

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

Public Member Functions

 PlatformSpecRecord ()
 
 PlatformSpecRecord (const PlatformSpecRecord &source)
 
 ~PlatformSpecRecord ()
 
void copy (PlatformSpecRecord &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 (uint16_t value)
 
uint16_t getPresenceVector (void) const
 
bool isFrontEnabled (void) const
 
void enableFront (void)
 
void disableFront (void)
 
bool isBackEnabled (void) const
 
void enableBack (void)
 
void disableBack (void)
 
bool isRightEnabled (void) const
 
void enableRight (void)
 
void disableRight (void)
 
bool isLeftEnabled (void) const
 
void enableLeft (void)
 
void disableLeft (void)
 
bool isBottomEnabled (void) const
 
void enableBottom (void)
 
void disableBottom (void)
 
bool isTopEnabled (void) const
 
void enableTop (void)
 
void disableTop (void)
 
bool isXcgEnabled (void) const
 
void enableXcg (void)
 
void disableXcg (void)
 
bool isYcgEnabled (void) const
 
void enableYcg (void)
 
void disableYcg (void)
 
bool isZcgEnabled (void) const
 
void enableZcg (void)
 
void disableZcg (void)
 
bool isWheelBaseEnabled (void) const
 
void enableWheelBase (void)
 
void disableWheelBase (void)
 
bool isStaticPitchOverEnabled (void) const
 
void enableStaticPitchOver (void)
 
void disableStaticPitchOver (void)
 
bool isStaticRollOverEnabled (void) const
 
void enableStaticRollOver (void)
 
void disableStaticRollOver (void)
 
bool isVehicleWeightEnabled (void) const
 
void enableVehicleWeight (void)
 
void disableVehicleWeight (void)
 
bool isApproachAngleEnabled (void) const
 
void enableApproachAngle (void)
 
void disableApproachAngle (void)
 
bool isDepartureAngleEnabled (void) const
 
void enableDepartureAngle (void)
 
void disableDepartureAngle (void)
 
bool isBreakOverAngleEnabled (void) const
 
void enableBreakOverAngle (void)
 
void disableBreakOverAngle (void)
 
std::string getMobilityPlatformName (void)
 
bool setMobilityPlatformName (std::string value)
 
double getFront_m (void)
 
bool setFront_m (double value)
 
double getBack_m (void)
 
bool setBack_m (double value)
 
double getRight_m (void)
 
bool setRight_m (double value)
 
double getLeft_m (void)
 
bool setLeft_m (double value)
 
double getBottom_m (void)
 
bool setBottom_m (double value)
 
double getTop_m (void)
 
bool setTop_m (double value)
 
double getXcg_m (void)
 
bool setXcg_m (double value)
 
double getYcg_m (void)
 
bool setYcg_m (double value)
 
double getZcg_m (void)
 
bool setZcg_m (double value)
 
double getWheelBase_m (void)
 
bool setWheelBase_m (double value)
 
double getStaticPitchOver_rad (void)
 
bool setStaticPitchOver_rad (double value)
 
double getStaticRollOver_rad (void)
 
bool setStaticRollOver_rad (double value)
 
double getVehicleWeight_kg (void)
 
bool setVehicleWeight_kg (double value)
 
double getApproachAngle_rad (void)
 
bool setApproachAngle_rad (double value)
 
double getDepartureAngle_rad (void)
 
bool setDepartureAngle_rad (double value)
 
double getBreakOverAngle_rad (void)
 
bool setBreakOverAngle_rad (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 uint16_t PV_ALL_FIELDS = 0xFFFF
 
static const uint16_t PV_NO_FIELDS = 0x0
 
static const uint16_t PV_FRONT = 0x1
 
static const uint16_t PV_BACK = 0x2
 
static const uint16_t PV_RIGHT = 0x4
 
static const uint16_t PV_LEFT = 0x8
 
static const uint16_t PV_BOTTOM = 0x10
 
static const uint16_t PV_TOP = 0x20
 
static const uint16_t PV_XCG = 0x40
 
static const uint16_t PV_YCG = 0x80
 
static const uint16_t PV_ZCG = 0x100
 
static const uint16_t PV_WHEELBASE = 0x200
 
static const uint16_t PV_STATICPITCHOVER = 0x400
 
static const uint16_t PV_STATICROLLOVER = 0x800
 
static const uint16_t PV_VEHICLEWEIGHT = 0x1000
 
static const uint16_t PV_APPROACHANGLE = 0x2000
 
static const uint16_t PV_DEPARTUREANGLE = 0x4000
 
static const uint16_t PV_BREAKOVERANGLE = 0x8000
 

Protected Attributes

model::fields::VariableLengthString mobilityPlatformName
 
PlatformSizeScaledInteger front_m
 
PlatformSizeScaledInteger back_m
 
PlatformSizeScaledInteger right_m
 
PlatformSizeScaledInteger left_m
 
PlatformSizeScaledInteger bottom_m
 
PlatformSizeScaledInteger top_m
 
VehiclePositionScaledInteger xcg_m
 
VehiclePositionScaledInteger ycg_m
 
VehiclePositionScaledInteger zcg_m
 
WheelBaseScaledInteger wheelBase_m
 
PlusMinusPiScaledInteger staticPitchOver_rad
 
PlusMinusPiScaledInteger staticRollOver_rad
 
VehicleWeightScaledInteger vehicleWeight_kg
 
HalfPiScaledInteger approachAngle_rad
 
HalfPiScaledInteger departureAngle_rad
 
HalfPiScaledInteger breakOverAngle_rad
 
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

§ PlatformSpecRecord() [1/2]

openjaus::ugv::PlatformSpecRecord::PlatformSpecRecord ( )

§ PlatformSpecRecord() [2/2]

openjaus::ugv::PlatformSpecRecord::PlatformSpecRecord ( const PlatformSpecRecord source)

§ ~PlatformSpecRecord()

openjaus::ugv::PlatformSpecRecord::~PlatformSpecRecord ( )

Member Function Documentation

§ copy()

void openjaus::ugv::PlatformSpecRecord::copy ( PlatformSpecRecord source)

§ disableApproachAngle()

void openjaus::ugv::PlatformSpecRecord::disableApproachAngle ( void  )

§ disableBack()

void openjaus::ugv::PlatformSpecRecord::disableBack ( void  )

§ disableBottom()

void openjaus::ugv::PlatformSpecRecord::disableBottom ( void  )

§ disableBreakOverAngle()

void openjaus::ugv::PlatformSpecRecord::disableBreakOverAngle ( void  )

§ disableDepartureAngle()

void openjaus::ugv::PlatformSpecRecord::disableDepartureAngle ( void  )

§ disableFront()

void openjaus::ugv::PlatformSpecRecord::disableFront ( void  )

§ disableLeft()

void openjaus::ugv::PlatformSpecRecord::disableLeft ( void  )

§ disableRight()

void openjaus::ugv::PlatformSpecRecord::disableRight ( void  )

§ disableStaticPitchOver()

void openjaus::ugv::PlatformSpecRecord::disableStaticPitchOver ( void  )

§ disableStaticRollOver()

void openjaus::ugv::PlatformSpecRecord::disableStaticRollOver ( void  )

§ disableTop()

void openjaus::ugv::PlatformSpecRecord::disableTop ( void  )

§ disableVehicleWeight()

void openjaus::ugv::PlatformSpecRecord::disableVehicleWeight ( void  )

§ disableWheelBase()

void openjaus::ugv::PlatformSpecRecord::disableWheelBase ( void  )

§ disableXcg()

void openjaus::ugv::PlatformSpecRecord::disableXcg ( void  )

§ disableYcg()

void openjaus::ugv::PlatformSpecRecord::disableYcg ( void  )

§ disableZcg()

void openjaus::ugv::PlatformSpecRecord::disableZcg ( void  )

§ enableApproachAngle()

void openjaus::ugv::PlatformSpecRecord::enableApproachAngle ( void  )

§ enableBack()

void openjaus::ugv::PlatformSpecRecord::enableBack ( void  )

§ enableBottom()

void openjaus::ugv::PlatformSpecRecord::enableBottom ( void  )

§ enableBreakOverAngle()

void openjaus::ugv::PlatformSpecRecord::enableBreakOverAngle ( void  )

§ enableDepartureAngle()

void openjaus::ugv::PlatformSpecRecord::enableDepartureAngle ( void  )

§ enableFront()

void openjaus::ugv::PlatformSpecRecord::enableFront ( void  )

§ enableLeft()

void openjaus::ugv::PlatformSpecRecord::enableLeft ( void  )

§ enableRight()

void openjaus::ugv::PlatformSpecRecord::enableRight ( void  )

§ enableStaticPitchOver()

void openjaus::ugv::PlatformSpecRecord::enableStaticPitchOver ( void  )

§ enableStaticRollOver()

void openjaus::ugv::PlatformSpecRecord::enableStaticRollOver ( void  )

§ enableTop()

void openjaus::ugv::PlatformSpecRecord::enableTop ( void  )

§ enableVehicleWeight()

void openjaus::ugv::PlatformSpecRecord::enableVehicleWeight ( void  )

§ enableWheelBase()

void openjaus::ugv::PlatformSpecRecord::enableWheelBase ( void  )

§ enableXcg()

void openjaus::ugv::PlatformSpecRecord::enableXcg ( void  )

§ enableYcg()

void openjaus::ugv::PlatformSpecRecord::enableYcg ( void  )

§ enableZcg()

void openjaus::ugv::PlatformSpecRecord::enableZcg ( void  )

§ from()

int openjaus::ugv::PlatformSpecRecord::from ( system::Buffer src)
virtual
Parameters
src

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

§ getApproachAngle_rad()

double openjaus::ugv::PlatformSpecRecord::getApproachAngle_rad ( void  )

§ getBack_m()

double openjaus::ugv::PlatformSpecRecord::getBack_m ( void  )

§ getBottom_m()

double openjaus::ugv::PlatformSpecRecord::getBottom_m ( void  )

§ getBreakOverAngle_rad()

double openjaus::ugv::PlatformSpecRecord::getBreakOverAngle_rad ( void  )

§ getDepartureAngle_rad()

double openjaus::ugv::PlatformSpecRecord::getDepartureAngle_rad ( void  )

§ getFront_m()

double openjaus::ugv::PlatformSpecRecord::getFront_m ( void  )

§ getLeft_m()

double openjaus::ugv::PlatformSpecRecord::getLeft_m ( void  )

§ getMobilityPlatformName()

std::string openjaus::ugv::PlatformSpecRecord::getMobilityPlatformName ( void  )

§ getPresenceVector()

uint16_t openjaus::ugv::PlatformSpecRecord::getPresenceVector ( void  ) const

§ getRight_m()

double openjaus::ugv::PlatformSpecRecord::getRight_m ( void  )

§ getStaticPitchOver_rad()

double openjaus::ugv::PlatformSpecRecord::getStaticPitchOver_rad ( void  )

§ getStaticRollOver_rad()

double openjaus::ugv::PlatformSpecRecord::getStaticRollOver_rad ( void  )

§ getTop_m()

double openjaus::ugv::PlatformSpecRecord::getTop_m ( void  )

§ getVehicleWeight_kg()

double openjaus::ugv::PlatformSpecRecord::getVehicleWeight_kg ( void  )

§ getWheelBase_m()

double openjaus::ugv::PlatformSpecRecord::getWheelBase_m ( void  )

§ getXcg_m()

double openjaus::ugv::PlatformSpecRecord::getXcg_m ( void  )

§ getYcg_m()

double openjaus::ugv::PlatformSpecRecord::getYcg_m ( void  )

§ getZcg_m()

double openjaus::ugv::PlatformSpecRecord::getZcg_m ( void  )

§ isApproachAngleEnabled()

bool openjaus::ugv::PlatformSpecRecord::isApproachAngleEnabled ( void  ) const

§ isBackEnabled()

bool openjaus::ugv::PlatformSpecRecord::isBackEnabled ( void  ) const

§ isBottomEnabled()

bool openjaus::ugv::PlatformSpecRecord::isBottomEnabled ( void  ) const

§ isBreakOverAngleEnabled()

bool openjaus::ugv::PlatformSpecRecord::isBreakOverAngleEnabled ( void  ) const

§ isDepartureAngleEnabled()

bool openjaus::ugv::PlatformSpecRecord::isDepartureAngleEnabled ( void  ) const

§ isFrontEnabled()

bool openjaus::ugv::PlatformSpecRecord::isFrontEnabled ( void  ) const

§ isLeftEnabled()

bool openjaus::ugv::PlatformSpecRecord::isLeftEnabled ( void  ) const

§ isRightEnabled()

bool openjaus::ugv::PlatformSpecRecord::isRightEnabled ( void  ) const

§ isStaticPitchOverEnabled()

bool openjaus::ugv::PlatformSpecRecord::isStaticPitchOverEnabled ( void  ) const

§ isStaticRollOverEnabled()

bool openjaus::ugv::PlatformSpecRecord::isStaticRollOverEnabled ( void  ) const

§ isTopEnabled()

bool openjaus::ugv::PlatformSpecRecord::isTopEnabled ( void  ) const

§ isVehicleWeightEnabled()

bool openjaus::ugv::PlatformSpecRecord::isVehicleWeightEnabled ( void  ) const

§ isWheelBaseEnabled()

bool openjaus::ugv::PlatformSpecRecord::isWheelBaseEnabled ( void  ) const

§ isXcgEnabled()

bool openjaus::ugv::PlatformSpecRecord::isXcgEnabled ( void  ) const

§ isYcgEnabled()

bool openjaus::ugv::PlatformSpecRecord::isYcgEnabled ( void  ) const

§ isZcgEnabled()

bool openjaus::ugv::PlatformSpecRecord::isZcgEnabled ( void  ) const

§ length()

int openjaus::ugv::PlatformSpecRecord::length ( void  )
virtual

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

§ setApproachAngle_rad()

bool openjaus::ugv::PlatformSpecRecord::setApproachAngle_rad ( double  value)

§ setBack_m()

bool openjaus::ugv::PlatformSpecRecord::setBack_m ( double  value)

§ setBottom_m()

bool openjaus::ugv::PlatformSpecRecord::setBottom_m ( double  value)

§ setBreakOverAngle_rad()

bool openjaus::ugv::PlatformSpecRecord::setBreakOverAngle_rad ( double  value)

§ setDepartureAngle_rad()

bool openjaus::ugv::PlatformSpecRecord::setDepartureAngle_rad ( double  value)

§ setFront_m()

bool openjaus::ugv::PlatformSpecRecord::setFront_m ( double  value)

§ setLeft_m()

bool openjaus::ugv::PlatformSpecRecord::setLeft_m ( double  value)

§ setMobilityPlatformName()

bool openjaus::ugv::PlatformSpecRecord::setMobilityPlatformName ( std::string  value)

§ setPresenceVector()

void openjaus::ugv::PlatformSpecRecord::setPresenceVector ( uint16_t  value)

§ setRight_m()

bool openjaus::ugv::PlatformSpecRecord::setRight_m ( double  value)

§ setStaticPitchOver_rad()

bool openjaus::ugv::PlatformSpecRecord::setStaticPitchOver_rad ( double  value)

§ setStaticRollOver_rad()

bool openjaus::ugv::PlatformSpecRecord::setStaticRollOver_rad ( double  value)

§ setTop_m()

bool openjaus::ugv::PlatformSpecRecord::setTop_m ( double  value)

§ setVehicleWeight_kg()

bool openjaus::ugv::PlatformSpecRecord::setVehicleWeight_kg ( double  value)

§ setWheelBase_m()

bool openjaus::ugv::PlatformSpecRecord::setWheelBase_m ( double  value)

§ setXcg_m()

bool openjaus::ugv::PlatformSpecRecord::setXcg_m ( double  value)

§ setYcg_m()

bool openjaus::ugv::PlatformSpecRecord::setYcg_m ( double  value)

§ setZcg_m()

bool openjaus::ugv::PlatformSpecRecord::setZcg_m ( double  value)

§ to()

int openjaus::ugv::PlatformSpecRecord::to ( system::Buffer dst)
virtual
Parameters
dst

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

§ toXml()

std::string openjaus::ugv::PlatformSpecRecord::toXml ( unsigned char  ojIndentLevel = 0) const

Member Data Documentation

§ approachAngle_rad

HalfPiScaledInteger openjaus::ugv::PlatformSpecRecord::approachAngle_rad
protected

§ back_m

PlatformSizeScaledInteger openjaus::ugv::PlatformSpecRecord::back_m
protected

§ bottom_m

PlatformSizeScaledInteger openjaus::ugv::PlatformSpecRecord::bottom_m
protected

§ breakOverAngle_rad

HalfPiScaledInteger openjaus::ugv::PlatformSpecRecord::breakOverAngle_rad
protected

§ departureAngle_rad

HalfPiScaledInteger openjaus::ugv::PlatformSpecRecord::departureAngle_rad
protected

§ front_m

PlatformSizeScaledInteger openjaus::ugv::PlatformSpecRecord::front_m
protected

§ left_m

PlatformSizeScaledInteger openjaus::ugv::PlatformSpecRecord::left_m
protected

§ mobilityPlatformName

model::fields::VariableLengthString openjaus::ugv::PlatformSpecRecord::mobilityPlatformName
protected

§ presenceVector

uint16_t openjaus::ugv::PlatformSpecRecord::presenceVector
protected

§ PV_ALL_FIELDS

const uint16_t openjaus::ugv::PlatformSpecRecord::PV_ALL_FIELDS = 0xFFFF
static

§ PV_APPROACHANGLE

const uint16_t openjaus::ugv::PlatformSpecRecord::PV_APPROACHANGLE = 0x2000
static

§ PV_BACK

const uint16_t openjaus::ugv::PlatformSpecRecord::PV_BACK = 0x2
static

§ PV_BOTTOM

const uint16_t openjaus::ugv::PlatformSpecRecord::PV_BOTTOM = 0x10
static

§ PV_BREAKOVERANGLE

const uint16_t openjaus::ugv::PlatformSpecRecord::PV_BREAKOVERANGLE = 0x8000
static

§ PV_DEPARTUREANGLE

const uint16_t openjaus::ugv::PlatformSpecRecord::PV_DEPARTUREANGLE = 0x4000
static

§ PV_FRONT

const uint16_t openjaus::ugv::PlatformSpecRecord::PV_FRONT = 0x1
static

§ PV_LEFT

const uint16_t openjaus::ugv::PlatformSpecRecord::PV_LEFT = 0x8
static

§ PV_NO_FIELDS

const uint16_t openjaus::ugv::PlatformSpecRecord::PV_NO_FIELDS = 0x0
static

§ PV_RIGHT

const uint16_t openjaus::ugv::PlatformSpecRecord::PV_RIGHT = 0x4
static

§ PV_STATICPITCHOVER

const uint16_t openjaus::ugv::PlatformSpecRecord::PV_STATICPITCHOVER = 0x400
static

§ PV_STATICROLLOVER

const uint16_t openjaus::ugv::PlatformSpecRecord::PV_STATICROLLOVER = 0x800
static

§ PV_TOP

const uint16_t openjaus::ugv::PlatformSpecRecord::PV_TOP = 0x20
static

§ PV_VEHICLEWEIGHT

const uint16_t openjaus::ugv::PlatformSpecRecord::PV_VEHICLEWEIGHT = 0x1000
static

§ PV_WHEELBASE

const uint16_t openjaus::ugv::PlatformSpecRecord::PV_WHEELBASE = 0x200
static

§ PV_XCG

const uint16_t openjaus::ugv::PlatformSpecRecord::PV_XCG = 0x40
static

§ PV_YCG

const uint16_t openjaus::ugv::PlatformSpecRecord::PV_YCG = 0x80
static

§ PV_ZCG

const uint16_t openjaus::ugv::PlatformSpecRecord::PV_ZCG = 0x100
static

§ right_m

PlatformSizeScaledInteger openjaus::ugv::PlatformSpecRecord::right_m
protected

§ staticPitchOver_rad

PlusMinusPiScaledInteger openjaus::ugv::PlatformSpecRecord::staticPitchOver_rad
protected

§ staticRollOver_rad

PlusMinusPiScaledInteger openjaus::ugv::PlatformSpecRecord::staticRollOver_rad
protected

§ top_m

PlatformSizeScaledInteger openjaus::ugv::PlatformSpecRecord::top_m
protected

§ vehicleWeight_kg

VehicleWeightScaledInteger openjaus::ugv::PlatformSpecRecord::vehicleWeight_kg
protected

§ wheelBase_m

WheelBaseScaledInteger openjaus::ugv::PlatformSpecRecord::wheelBase_m
protected

§ xcg_m

VehiclePositionScaledInteger openjaus::ugv::PlatformSpecRecord::xcg_m
protected

§ ycg_m

VehiclePositionScaledInteger openjaus::ugv::PlatformSpecRecord::ycg_m
protected

§ zcg_m

VehiclePositionScaledInteger openjaus::ugv::PlatformSpecRecord::zcg_m
protected

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