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

SetLocalPathSegment Message Implementation. More...

#include <SetLocalPathSegment.h>

Inherits openjaus::model::Message.

Public Member Functions

 SetLocalPathSegment ()
 
 SetLocalPathSegment (model::Message *message)
 
 ~SetLocalPathSegment ()
 
virtual int to (system::Buffer *dst)
 Pack this message to the given openjaus::system::Buffer. More...
 
virtual int from (system::Buffer *src)
 Unpack this message from the given openjaus::system::Buffer. More...
 
virtual int length ()
 Get the number of bytes this message would occupy in a serialized buffer. More...
 
std::string toXml (unsigned char ojIndentLevel=0) const
 Used to serialize the runtime state of the message to an XML format. More...
 
std::string toString () const
 Returns a string populated with the Message name and ID More...
 
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::Message
 Message ()
 
virtual ~Message ()
 
 Message (Message *message)
 
int to (system::Buffer *dst)
 Operation to. More...
 
int from (system::Buffer *src)
 Operation from. More...
 
- Public Member Functions inherited from openjaus::transport::Wrapper
 Wrapper ()
 
virtual ~Wrapper ()
 
AckNakType getAckNak () const
 Accessor to get the value of ackNak. More...
 
bool setAckNak (AckNakType ackNak)
 Accessor to set value of ackNak. More...
 
bool isCompressible () const
 Accessor to get the value of compressible. More...
 
bool setCompressible (bool compressible)
 Accessor to set value of compressible. More...
 
bool isMustArrive () const
 Accessor to get the value of mustArrive. More...
 
bool setMustArrive (bool mustArrive)
 Accessor to set value of mustArrive. More...
 
uint16_t getSequenceNumber () const
 Accessor to get the value of sequenceNumber. More...
 
bool setSequenceNumber (uint16_t sequenceNumber)
 Accessor to set value of sequenceNumber. More...
 
WrapperType getType () const
 Accessor to get the value of type. More...
 
bool setType (WrapperType type)
 Accessor to set value of type. More...
 
Priority getPriority () const
 Accessor to get the value of priority. More...
 
bool setPriority (Priority priority)
 Accessor to set value of priority. More...
 
BroadcastType getBroadcastFlag () const
 Accessor to get the value of broadcastFlag. More...
 
bool setBroadcastFlag (BroadcastType broadcastFlag)
 Accessor to set value of broadcastFlag. More...
 
LargeMessageType getLargeMessageFlag () const
 Accessor to get the value of largeMessageFlag. More...
 
bool setLargeMessageFlag (LargeMessageType largeMessageFlag)
 Accessor to set value of largeMessageFlag. More...
 
const AddressgetDestination () const
 Accessor to get the value of destination. More...
 
bool setDestination (const Address &destination)
 Accessor to set value of destination. More...
 
system::TransportablegetPayload () const
 Accessor to get the value of payload. More...
 
bool setPayload (system::Transportable *payload)
 Accessor to set value of payload. More...
 
const AddressgetSource () const
 Accessor to get the value of source. More...
 
bool setSource (const Address &source)
 Accessor to set value of source. More...
 
TransportDatagetTransportData () const
 Accessor to get the value of transportData. More...
 
bool setTransportData (TransportData *transportData)
 Accessor to set value of transportData. More...
 
virtual int prioritizedValue ()
 Operation prioritizedValue. More...
 
virtual Wrapperclone ()
 
- Public Member Functions inherited from openjaus::system::Transportable
virtual ~Transportable ()
 
 Transportable ()
 
- Public Member Functions inherited from openjaus::system::Prioritized
virtual ~Prioritized ()
 
- Public Member Functions inherited from openjaus::model::Trigger
 Trigger ()
 
virtual ~Trigger ()
 
double getTriggerTimestamp_sec () const
 Accessor to get the value of triggerTimestamp_sec. More...
 
bool setTriggerTimestamp_sec (double triggerTimestamp_sec)
 Accessor to set value of triggerTimestamp_sec. More...
 
uint32_t getId () const
 Accessor to get the value of id. More...
 
bool setId (uint32_t id)
 Accessor to set value of id. More...
 
std::string idString ()
 Operation idString. More...
 

Static Public Attributes

static const uint16_t ID = 0x0410
 
static const uint8_t PV_ALL_FIELDS = 0xFF
 
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 double P1X_MIN_VALUE = -100000.0
 
static const double P1X_MAX_VALUE = 100000.0
 
static const double P1Y_MIN_VALUE = -100000.0
 
static const double P1Y_MAX_VALUE = 100000.0
 
static const double P1Z_MIN_VALUE = -10000.0
 
static const double P1Z_MAX_VALUE = 35000.0
 
static const double P2X_MIN_VALUE = -100000.0
 
static const double P2X_MAX_VALUE = 100000.0
 
static const double P2Y_MIN_VALUE = -100000.0
 
static const double P2Y_MAX_VALUE = 100000.0
 
static const double P2Z_MIN_VALUE = -10000.0
 
static const double P2Z_MAX_VALUE = 35000.0
 
static const double WEIGHTINGFACTOR_MIN_VALUE = 0.0
 
static const double WEIGHTINGFACTOR_MAX_VALUE = 500.0
 
static const double PATHTOLERANCE_MIN_VALUE = 0.0
 
static const double PATHTOLERANCE_MAX_VALUE = 100000.0
 

Private 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
 

Friends

OPENJAUS_EXPORT friend std::ostream & operator<< (std::ostream &output, const SetLocalPathSegment &object)
 OStream operator for Message object More...
 
OPENJAUS_EXPORT friend std::ostream & operator<< (std::ostream &output, const SetLocalPathSegment *object)
 OStream operator for Message pointer More...
 

Additional Inherited Members

- Protected Member Functions inherited from openjaus::transport::Wrapper
 Wrapper (const Wrapper &wrapper)
 
- Protected Attributes inherited from openjaus::transport::Wrapper
AckNakType ackNak
 
bool compressible
 
bool mustArrive
 
uint16_t sequenceNumber
 
WrapperType type
 
Priority priority
 
BroadcastType broadcastFlag
 
LargeMessageType largeMessageFlag
 
Address destination
 
system::Transportablepayload
 
Address source
 
TransportDatatransportData
 
- Protected Attributes inherited from openjaus::model::Trigger
double triggerTimestamp_sec
 
uint32_t id
 

Detailed Description

This message is used to set the path segment data based on the local coordinate system. A local path segment is defined in this message using three points, P0, P1 and P2 and a weighting factor. For the first path segment, i.e. the first element in a list of path segments, P0 is assumed to be the current location of the platform as defined by Report Local Pose. For each successive path segments, i.e. where the path segment number is greater than zero, P0 is equal to the previous path segment P2. Therefore, for each message, only P1, P2, and a weighting factor must be set in order to define a path segment. Each point is defined in the Local Coordinate System by setting its X, Y, and Z. Both the X and Y are required fields, but the Z field is optional.

Constructor & Destructor Documentation

§ SetLocalPathSegment() [1/2]

openjaus::mobility::SetLocalPathSegment::SetLocalPathSegment ( )

§ SetLocalPathSegment() [2/2]

openjaus::mobility::SetLocalPathSegment::SetLocalPathSegment ( model::Message message)

§ ~SetLocalPathSegment()

openjaus::mobility::SetLocalPathSegment::~SetLocalPathSegment ( )

Member Function Documentation

§ disableP1Z()

void openjaus::mobility::SetLocalPathSegment::disableP1Z ( void  )

§ disableP2Z()

void openjaus::mobility::SetLocalPathSegment::disableP2Z ( void  )

§ disablePathTolerance()

void openjaus::mobility::SetLocalPathSegment::disablePathTolerance ( void  )

§ enableP1Z()

void openjaus::mobility::SetLocalPathSegment::enableP1Z ( void  )

§ enableP2Z()

void openjaus::mobility::SetLocalPathSegment::enableP2Z ( void  )

§ enablePathTolerance()

void openjaus::mobility::SetLocalPathSegment::enablePathTolerance ( void  )

§ from()

int openjaus::mobility::SetLocalPathSegment::from ( system::Buffer src)
virtual
Parameters
[in]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::transport::Wrapper.

§ getP1X_m()

double openjaus::mobility::SetLocalPathSegment::getP1X_m ( void  )

§ getP1Y_m()

double openjaus::mobility::SetLocalPathSegment::getP1Y_m ( void  )

§ getP1Z_m()

double openjaus::mobility::SetLocalPathSegment::getP1Z_m ( void  )

§ getP2X_m()

double openjaus::mobility::SetLocalPathSegment::getP2X_m ( void  )

§ getP2Y_m()

double openjaus::mobility::SetLocalPathSegment::getP2Y_m ( void  )

§ getP2Z_m()

double openjaus::mobility::SetLocalPathSegment::getP2Z_m ( void  )

§ getPathTolerance()

double openjaus::mobility::SetLocalPathSegment::getPathTolerance ( void  )

§ getPresenceVector()

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

§ getWeightingFactor()

double openjaus::mobility::SetLocalPathSegment::getWeightingFactor ( void  )

§ isP1ZEnabled()

bool openjaus::mobility::SetLocalPathSegment::isP1ZEnabled ( void  ) const

§ isP2ZEnabled()

bool openjaus::mobility::SetLocalPathSegment::isP2ZEnabled ( void  ) const

§ isPathToleranceEnabled()

bool openjaus::mobility::SetLocalPathSegment::isPathToleranceEnabled ( void  ) const

§ length()

int openjaus::mobility::SetLocalPathSegment::length ( void  )
virtual
Returns
The number of bytes this message would occupy in a buffer

Reimplemented from openjaus::model::Message.

§ setP1X_m()

bool openjaus::mobility::SetLocalPathSegment::setP1X_m ( double  value)

§ setP1Y_m()

bool openjaus::mobility::SetLocalPathSegment::setP1Y_m ( double  value)

§ setP1Z_m()

bool openjaus::mobility::SetLocalPathSegment::setP1Z_m ( double  value)

§ setP2X_m()

bool openjaus::mobility::SetLocalPathSegment::setP2X_m ( double  value)

§ setP2Y_m()

bool openjaus::mobility::SetLocalPathSegment::setP2Y_m ( double  value)

§ setP2Z_m()

bool openjaus::mobility::SetLocalPathSegment::setP2Z_m ( double  value)

§ setPathTolerance()

bool openjaus::mobility::SetLocalPathSegment::setPathTolerance ( double  value)

§ setPresenceVector()

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

§ setWeightingFactor()

bool openjaus::mobility::SetLocalPathSegment::setWeightingFactor ( double  value)

§ to()

int openjaus::mobility::SetLocalPathSegment::to ( system::Buffer dst)
virtual
Parameters
[out]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::transport::Wrapper.

§ toString()

std::string openjaus::mobility::SetLocalPathSegment::toString ( ) const
virtual
Returns
The string

Reimplemented from openjaus::model::Message.

§ toXml()

std::string openjaus::mobility::SetLocalPathSegment::toXml ( unsigned char  ojIndentLevel = 0) const
Parameters
[in]ojIndentLevel- Used to determine how many tabs are inserted per line for pretty formating.
Returns
The serialized XML string

Friends And Related Function Documentation

§ operator<< [1/2]

OPENJAUS_EXPORT friend std::ostream& operator<< ( std::ostream &  output,
const SetLocalPathSegment object 
)
friend

§ operator<< [2/2]

OPENJAUS_EXPORT friend std::ostream& operator<< ( std::ostream &  output,
const SetLocalPathSegment object 
)
friend

Member Data Documentation

§ ID

const uint16_t openjaus::mobility::SetLocalPathSegment::ID = 0x0410
static

§ p1X_m

LocalPositionScaledInteger openjaus::mobility::SetLocalPathSegment::p1X_m
private

§ P1X_MAX_VALUE

const double openjaus::mobility::SetLocalPathSegment::P1X_MAX_VALUE = 100000.0
static

§ P1X_MIN_VALUE

const double openjaus::mobility::SetLocalPathSegment::P1X_MIN_VALUE = -100000.0
static

§ p1Y_m

LocalPositionScaledInteger openjaus::mobility::SetLocalPathSegment::p1Y_m
private

§ P1Y_MAX_VALUE

const double openjaus::mobility::SetLocalPathSegment::P1Y_MAX_VALUE = 100000.0
static

§ P1Y_MIN_VALUE

const double openjaus::mobility::SetLocalPathSegment::P1Y_MIN_VALUE = -100000.0
static

§ p1Z_m

JausAltitudeScaledInteger openjaus::mobility::SetLocalPathSegment::p1Z_m
private

§ P1Z_MAX_VALUE

const double openjaus::mobility::SetLocalPathSegment::P1Z_MAX_VALUE = 35000.0
static

§ P1Z_MIN_VALUE

const double openjaus::mobility::SetLocalPathSegment::P1Z_MIN_VALUE = -10000.0
static

§ p2X_m

LocalPositionScaledInteger openjaus::mobility::SetLocalPathSegment::p2X_m
private

§ P2X_MAX_VALUE

const double openjaus::mobility::SetLocalPathSegment::P2X_MAX_VALUE = 100000.0
static

§ P2X_MIN_VALUE

const double openjaus::mobility::SetLocalPathSegment::P2X_MIN_VALUE = -100000.0
static

§ p2Y_m

LocalPositionScaledInteger openjaus::mobility::SetLocalPathSegment::p2Y_m
private

§ P2Y_MAX_VALUE

const double openjaus::mobility::SetLocalPathSegment::P2Y_MAX_VALUE = 100000.0
static

§ P2Y_MIN_VALUE

const double openjaus::mobility::SetLocalPathSegment::P2Y_MIN_VALUE = -100000.0
static

§ p2Z_m

JausAltitudeScaledInteger openjaus::mobility::SetLocalPathSegment::p2Z_m
private

§ P2Z_MAX_VALUE

const double openjaus::mobility::SetLocalPathSegment::P2Z_MAX_VALUE = 35000.0
static

§ P2Z_MIN_VALUE

const double openjaus::mobility::SetLocalPathSegment::P2Z_MIN_VALUE = -10000.0
static

§ pathTolerance

PathToleranceRefScaledInteger openjaus::mobility::SetLocalPathSegment::pathTolerance
private

§ PATHTOLERANCE_MAX_VALUE

const double openjaus::mobility::SetLocalPathSegment::PATHTOLERANCE_MAX_VALUE = 100000.0
static

§ PATHTOLERANCE_MIN_VALUE

const double openjaus::mobility::SetLocalPathSegment::PATHTOLERANCE_MIN_VALUE = 0.0
static

§ presenceVector

uint8_t openjaus::mobility::SetLocalPathSegment::presenceVector
private

§ PV_ALL_FIELDS

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

§ PV_NO_FIELDS

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

§ PV_P1Z

const uint8_t openjaus::mobility::SetLocalPathSegment::PV_P1Z = 0x1
static

§ PV_P2Z

const uint8_t openjaus::mobility::SetLocalPathSegment::PV_P2Z = 0x2
static

§ PV_PATHTOLERANCE

const uint8_t openjaus::mobility::SetLocalPathSegment::PV_PATHTOLERANCE = 0x4
static

§ weightingFactor

WeightingFactorRefScaledInteger openjaus::mobility::SetLocalPathSegment::weightingFactor
private

§ WEIGHTINGFACTOR_MAX_VALUE

const double openjaus::mobility::SetLocalPathSegment::WEIGHTINGFACTOR_MAX_VALUE = 500.0
static

§ WEIGHTINGFACTOR_MIN_VALUE

const double openjaus::mobility::SetLocalPathSegment::WEIGHTINGFACTOR_MIN_VALUE = 0.0
static

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