openjaus::mobility::ReportGlobalPathSegment Class Reference

ReportGlobalPathSegment Message Implementation. More...

#include <ReportGlobalPathSegment.h>

Inherits openjaus::model::Message.

List of all members.

Public Member Functions
	ReportGlobalPathSegment ()
	ReportGlobalPathSegment (model::Message *message)
	~ReportGlobalPathSegment ()
virtual int	to (system::Buffer *dst)
	Pack this message to the given openjaus::system::Buffer.
virtual int	from (system::Buffer *src)
	Unpack this message from the given openjaus::system::Buffer.
virtual int	length ()
	Get the number of bytes this message would occupy in a serialized buffer.
std::string	toXml (unsigned char level=0) const
	Used to serialize the runtime state of the message to an XML format.
void	setPresenceVector (uint8_t value)
uint8_t	getPresenceVector (void) const
bool	isP1AltitudeEnabled (void) const
void	enableP1Altitude (void)
void	disableP1Altitude (void)
bool	isP2AltitudeEnabled (void) const
void	enableP2Altitude (void)
void	disableP2Altitude (void)
bool	isPathToleranceEnabled (void) const
void	enablePathTolerance (void)
void	disablePathTolerance (void)
double	getP1Latitude_deg (void)
void	setP1Latitude_deg (double value)
double	getP1Longitude_deg (void)
void	setP1Longitude_deg (double value)
double	getP1Altitude_m (void)
void	setP1Altitude_m (double value)
double	getP2Latitude_deg (void)
void	setP2Latitude_deg (double value)
double	getP2Longitude_deg (void)
void	setP2Longitude_deg (double value)
double	getP2Altitude_m (void)
void	setP2Altitude_m (double value)
double	getWeightingFactor (void)
void	setWeightingFactor (double value)
double	getPathTolerance (void)
void	setPathTolerance (double value)
Static Public Attributes
static const uint16_t	ID = 0x440F
Private Types
enum	pvEnum { P1ALTITUDE_M = 0, P2ALTITUDE_M = 1, PATHTOLERANCE = 2 }
Private Attributes
JausLatitudeScaledInteger	p1Latitude_deg
JausLongitudeScaledInteger	p1Longitude_deg
JausAltitudeScaledInteger	p1Altitude_m
JausLatitudeScaledInteger	p2Latitude_deg
JausLongitudeScaledInteger	p2Longitude_deg
JausAltitudeScaledInteger	p2Altitude_m
WeightingFactorRefScaledInteger	weightingFactor
PathToleranceRefScaledInteger	pathTolerance
uint8_t	presenceVector

---

Detailed Description

This message is used to provide the receiver the values of the current path segment. The message data and mapping of the presence vector of this message are identical to ID 040Fh: SetGlobalPathSegment.

---

Member Enumeration Documentation

enum openjaus::mobility::ReportGlobalPathSegment::pvEnum [private]

Enumerator:

P1ALTITUDE_M
P2ALTITUDE_M
PATHTOLERANCE

---

Constructor & Destructor Documentation

openjaus::mobility::ReportGlobalPathSegment::ReportGlobalPathSegment

(

)

openjaus::mobility::ReportGlobalPathSegment::ReportGlobalPathSegment

(

model::Message *

message

)

openjaus::mobility::ReportGlobalPathSegment::~ReportGlobalPathSegment

(

)

---

Member Function Documentation

void openjaus::mobility::ReportGlobalPathSegment::disableP1Altitude

(

void

)

void openjaus::mobility::ReportGlobalPathSegment::disableP2Altitude

(

void

)

void openjaus::mobility::ReportGlobalPathSegment::disablePathTolerance

(

void

)

void openjaus::mobility::ReportGlobalPathSegment::enableP1Altitude

(

void

)

void openjaus::mobility::ReportGlobalPathSegment::enableP2Altitude

(

void

)

void openjaus::mobility::ReportGlobalPathSegment::enablePathTolerance

(

void

)

int openjaus::mobility::ReportGlobalPathSegment::from

(

system::Buffer *

src

)

[virtual]

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::model::Message.

double openjaus::mobility::ReportGlobalPathSegment::getP1Altitude_m

(

void

)

double openjaus::mobility::ReportGlobalPathSegment::getP1Latitude_deg

(

void

)

double openjaus::mobility::ReportGlobalPathSegment::getP1Longitude_deg

(

void

)

double openjaus::mobility::ReportGlobalPathSegment::getP2Altitude_m

(

void

)

double openjaus::mobility::ReportGlobalPathSegment::getP2Latitude_deg

(

void

)

double openjaus::mobility::ReportGlobalPathSegment::getP2Longitude_deg

(

void

)

double openjaus::mobility::ReportGlobalPathSegment::getPathTolerance

(

void

)

uint8_t openjaus::mobility::ReportGlobalPathSegment::getPresenceVector

(

void

)

const

double openjaus::mobility::ReportGlobalPathSegment::getWeightingFactor

(

void

)

bool openjaus::mobility::ReportGlobalPathSegment::isP1AltitudeEnabled

(

void

)

const

bool openjaus::mobility::ReportGlobalPathSegment::isP2AltitudeEnabled

(

void

)

const

bool openjaus::mobility::ReportGlobalPathSegment::isPathToleranceEnabled

(

void

)

const

int openjaus::mobility::ReportGlobalPathSegment::length

(

void

)

[virtual]

The number of bytes this message would occupy in a buffer

Reimplemented from openjaus::model::Message.

void openjaus::mobility::ReportGlobalPathSegment::setP1Altitude_m

(

double

value

)

void openjaus::mobility::ReportGlobalPathSegment::setP1Latitude_deg

(

double

value

)

void openjaus::mobility::ReportGlobalPathSegment::setP1Longitude_deg

(

double

value

)

void openjaus::mobility::ReportGlobalPathSegment::setP2Altitude_m

(

double

value

)

void openjaus::mobility::ReportGlobalPathSegment::setP2Latitude_deg

(

double

value

)

void openjaus::mobility::ReportGlobalPathSegment::setP2Longitude_deg

(

double

value

)

void openjaus::mobility::ReportGlobalPathSegment::setPathTolerance

(

double

value

)

void openjaus::mobility::ReportGlobalPathSegment::setPresenceVector

(

uint8_t

value

)

void openjaus::mobility::ReportGlobalPathSegment::setWeightingFactor

(

double

value

)

int openjaus::mobility::ReportGlobalPathSegment::to

(

system::Buffer *

dst

)

[virtual]

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::model::Message.

std::string openjaus::mobility::ReportGlobalPathSegment::toXml

(

unsigned char

level = 0

)

const

level - Used to determine how many tabs are inserted per line for pretty formating.

Returns:

The serialized XML string

---

Member Data Documentation

const uint16_t openjaus::mobility::ReportGlobalPathSegment::ID = 0x440F [static]

JausAltitudeScaledInteger openjaus::mobility::ReportGlobalPathSegment::p1Altitude_m [private]

JausLatitudeScaledInteger openjaus::mobility::ReportGlobalPathSegment::p1Latitude_deg [private]

JausLongitudeScaledInteger openjaus::mobility::ReportGlobalPathSegment::p1Longitude_deg [private]

JausAltitudeScaledInteger openjaus::mobility::ReportGlobalPathSegment::p2Altitude_m [private]

JausLatitudeScaledInteger openjaus::mobility::ReportGlobalPathSegment::p2Latitude_deg [private]

JausLongitudeScaledInteger openjaus::mobility::ReportGlobalPathSegment::p2Longitude_deg [private]

PathToleranceRefScaledInteger openjaus::mobility::ReportGlobalPathSegment::pathTolerance [private]

uint8_t openjaus::mobility::ReportGlobalPathSegment::presenceVector [private]

WeightingFactorRefScaledInteger openjaus::mobility::ReportGlobalPathSegment::weightingFactor [private]

---

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

• include/openjaus/mobility/Triggers/ReportGlobalPathSegment.h
• src/openjaus/mobility/Triggers/ReportGlobalPathSegment.cpp