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

#include <LocalPathSegmentRecord.h>

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

Public Member Functions

 LocalPathSegmentRecord ()
 
 LocalPathSegmentRecord (const LocalPathSegmentRecord &source)
 
 ~LocalPathSegmentRecord ()
 
void copy (LocalPathSegmentRecord &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 (uint8_t value)
 
uint8_t getPresenceVector (void) const
 
bool isP1ZEnabled (void) const
 
void enableP1Z (void)
 
void disableP1Z (void)
 
bool isP2ZEnabled (void) const
 
void enableP2Z (void)
 
void disableP2Z (void)
 
bool isPathToleranceEnabled (void) const
 
void enablePathTolerance (void)
 
void disablePathTolerance (void)
 
double getP1X_m (void)
 
bool setP1X_m (double value)
 
double getP1Y_m (void)
 
bool setP1Y_m (double value)
 
double getP1Z_m (void)
 
bool setP1Z_m (double value)
 
double getP2X_m (void)
 
bool setP2X_m (double value)
 
double getP2Y_m (void)
 
bool setP2Y_m (double value)
 
double getP2Z_m (void)
 
bool setP2Z_m (double value)
 
double getWeightingFactor (void)
 
bool setWeightingFactor (double value)
 
double getPathTolerance (void)
 
bool setPathTolerance (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
 Transportable ()
 
virtual ~Transportable ()
 

Static Public Attributes

static const uint8_t PV_NO_FIELDS = 0x0
 
static const uint8_t PV_P1Z = 0x1
 
static const uint8_t PV_P2Z = 0x2
 
static const uint8_t PV_PATHTOLERANCE = 0x4
 
static const uint8_t PV_ALL_FIELDS = PV_NO_FIELDS | PV_P1Z | PV_P2Z | PV_PATHTOLERANCE
 

Protected Attributes

LocalPositionScaledInteger p1X_m
 
LocalPositionScaledInteger p1Y_m
 
JausAltitudeScaledInteger p1Z_m
 
LocalPositionScaledInteger p2X_m
 
LocalPositionScaledInteger p2Y_m
 
JausAltitudeScaledInteger p2Z_m
 
WeightingFactorRefScaledInteger weightingFactor
 
PathToleranceRefScaledInteger pathTolerance
 
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

◆ LocalPathSegmentRecord() [1/2]

openjaus::mobility_v1_0::LocalPathSegmentRecord::LocalPathSegmentRecord ( )

◆ LocalPathSegmentRecord() [2/2]

openjaus::mobility_v1_0::LocalPathSegmentRecord::LocalPathSegmentRecord ( const LocalPathSegmentRecord source)

◆ ~LocalPathSegmentRecord()

openjaus::mobility_v1_0::LocalPathSegmentRecord::~LocalPathSegmentRecord ( )

Member Function Documentation

◆ copy()

void openjaus::mobility_v1_0::LocalPathSegmentRecord::copy ( LocalPathSegmentRecord source)

◆ disableP1Z()

void openjaus::mobility_v1_0::LocalPathSegmentRecord::disableP1Z ( void  )

◆ disableP2Z()

void openjaus::mobility_v1_0::LocalPathSegmentRecord::disableP2Z ( void  )

◆ disablePathTolerance()

void openjaus::mobility_v1_0::LocalPathSegmentRecord::disablePathTolerance ( void  )

◆ enableP1Z()

void openjaus::mobility_v1_0::LocalPathSegmentRecord::enableP1Z ( void  )

◆ enableP2Z()

void openjaus::mobility_v1_0::LocalPathSegmentRecord::enableP2Z ( void  )

◆ enablePathTolerance()

void openjaus::mobility_v1_0::LocalPathSegmentRecord::enablePathTolerance ( void  )

◆ from()

uint64 openjaus::mobility_v1_0::LocalPathSegmentRecord::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.

◆ getP1X_m()

double openjaus::mobility_v1_0::LocalPathSegmentRecord::getP1X_m ( void  )

◆ getP1Y_m()

double openjaus::mobility_v1_0::LocalPathSegmentRecord::getP1Y_m ( void  )

◆ getP1Z_m()

double openjaus::mobility_v1_0::LocalPathSegmentRecord::getP1Z_m ( void  )

◆ getP2X_m()

double openjaus::mobility_v1_0::LocalPathSegmentRecord::getP2X_m ( void  )

◆ getP2Y_m()

double openjaus::mobility_v1_0::LocalPathSegmentRecord::getP2Y_m ( void  )

◆ getP2Z_m()

double openjaus::mobility_v1_0::LocalPathSegmentRecord::getP2Z_m ( void  )

◆ getPathTolerance()

double openjaus::mobility_v1_0::LocalPathSegmentRecord::getPathTolerance ( void  )

◆ getPresenceVector()

uint8_t openjaus::mobility_v1_0::LocalPathSegmentRecord::getPresenceVector ( void  ) const

◆ getWeightingFactor()

double openjaus::mobility_v1_0::LocalPathSegmentRecord::getWeightingFactor ( void  )

◆ isP1ZEnabled()

bool openjaus::mobility_v1_0::LocalPathSegmentRecord::isP1ZEnabled ( void  ) const

◆ isP2ZEnabled()

bool openjaus::mobility_v1_0::LocalPathSegmentRecord::isP2ZEnabled ( void  ) const

◆ isPathToleranceEnabled()

bool openjaus::mobility_v1_0::LocalPathSegmentRecord::isPathToleranceEnabled ( void  ) const

◆ length()

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

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

◆ setP1X_m()

bool openjaus::mobility_v1_0::LocalPathSegmentRecord::setP1X_m ( double  value)

◆ setP1Y_m()

bool openjaus::mobility_v1_0::LocalPathSegmentRecord::setP1Y_m ( double  value)

◆ setP1Z_m()

bool openjaus::mobility_v1_0::LocalPathSegmentRecord::setP1Z_m ( double  value)

◆ setP2X_m()

bool openjaus::mobility_v1_0::LocalPathSegmentRecord::setP2X_m ( double  value)

◆ setP2Y_m()

bool openjaus::mobility_v1_0::LocalPathSegmentRecord::setP2Y_m ( double  value)

◆ setP2Z_m()

bool openjaus::mobility_v1_0::LocalPathSegmentRecord::setP2Z_m ( double  value)

◆ setPathTolerance()

bool openjaus::mobility_v1_0::LocalPathSegmentRecord::setPathTolerance ( double  value)

◆ setPresenceVector()

void openjaus::mobility_v1_0::LocalPathSegmentRecord::setPresenceVector ( uint8_t  value)

◆ setWeightingFactor()

bool openjaus::mobility_v1_0::LocalPathSegmentRecord::setWeightingFactor ( double  value)

◆ to()

uint64 openjaus::mobility_v1_0::LocalPathSegmentRecord::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::LocalPathSegmentRecord::toXml ( unsigned char  ojIndentLevel = 0) const

Member Data Documentation

◆ p1X_m

LocalPositionScaledInteger openjaus::mobility_v1_0::LocalPathSegmentRecord::p1X_m
protected

◆ p1Y_m

LocalPositionScaledInteger openjaus::mobility_v1_0::LocalPathSegmentRecord::p1Y_m
protected

◆ p1Z_m

JausAltitudeScaledInteger openjaus::mobility_v1_0::LocalPathSegmentRecord::p1Z_m
protected

◆ p2X_m

LocalPositionScaledInteger openjaus::mobility_v1_0::LocalPathSegmentRecord::p2X_m
protected

◆ p2Y_m

LocalPositionScaledInteger openjaus::mobility_v1_0::LocalPathSegmentRecord::p2Y_m
protected

◆ p2Z_m

JausAltitudeScaledInteger openjaus::mobility_v1_0::LocalPathSegmentRecord::p2Z_m
protected

◆ pathTolerance

PathToleranceRefScaledInteger openjaus::mobility_v1_0::LocalPathSegmentRecord::pathTolerance
protected

◆ presenceVector

uint8_t openjaus::mobility_v1_0::LocalPathSegmentRecord::presenceVector
protected

◆ PV_ALL_FIELDS

const uint8_t openjaus::mobility_v1_0::LocalPathSegmentRecord::PV_ALL_FIELDS = PV_NO_FIELDS | PV_P1Z | PV_P2Z | PV_PATHTOLERANCE
static

◆ PV_NO_FIELDS

const uint8_t openjaus::mobility_v1_0::LocalPathSegmentRecord::PV_NO_FIELDS = 0x0
static

◆ PV_P1Z

const uint8_t openjaus::mobility_v1_0::LocalPathSegmentRecord::PV_P1Z = 0x1
static

◆ PV_P2Z

const uint8_t openjaus::mobility_v1_0::LocalPathSegmentRecord::PV_P2Z = 0x2
static

◆ PV_PATHTOLERANCE

const uint8_t openjaus::mobility_v1_0::LocalPathSegmentRecord::PV_PATHTOLERANCE = 0x4
static

◆ weightingFactor

WeightingFactorRefScaledInteger openjaus::mobility_v1_0::LocalPathSegmentRecord::weightingFactor
protected

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