#include <LocalWaypointRecord.h>

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

Public Member Functions
	LocalWaypointRecord ()

	LocalWaypointRecord (const LocalWaypointRecord &source)

	~LocalWaypointRecord ()

void	copy (LocalWaypointRecord &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	isZEnabled (void) const

void	enableZ (void)

void	disableZ (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	isWaypointToleranceEnabled (void) const

void	enableWaypointTolerance (void)

void	disableWaypointTolerance (void)

bool	isPathToleranceEnabled (void) const

void	enablePathTolerance (void)

void	disablePathTolerance (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	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	getWaypointTolerance_m (void)

bool	setWaypointTolerance_m (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_Z = 0x1

static const uint8_t	PV_ROLL = 0x2

static const uint8_t	PV_PITCH = 0x4

static const uint8_t	PV_YAW = 0x8

static const uint8_t	PV_WAYPOINTTOLERANCE = 0x10

static const uint8_t	PV_PATHTOLERANCE = 0x20

static const uint8_t	PV_ALL_FIELDS = PV_NO_FIELDS \| PV_Z \| PV_ROLL \| PV_PITCH \| PV_YAW \| PV_WAYPOINTTOLERANCE \| PV_PATHTOLERANCE

Protected Attributes
LocalPositionScaledInteger	x_m

LocalPositionScaledInteger	y_m

LocalPositionScaledInteger	z_m

OrientationScaledInteger	roll_rad

OrientationScaledInteger	pitch_rad

OrientationScaledInteger	yaw_rad

WaypointToleranceRefScaledInteger	waypointTolerance_m

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

◆ LocalWaypointRecord() [1/2]

openjaus::mobility_v1_0::LocalWaypointRecord::LocalWaypointRecord ( )

◆ LocalWaypointRecord() [2/2]

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

◆ ~LocalWaypointRecord()

openjaus::mobility_v1_0::LocalWaypointRecord::~LocalWaypointRecord ( )

Member Function Documentation

◆ copy()

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

◆ disablePathTolerance()

void openjaus::mobility_v1_0::LocalWaypointRecord::disablePathTolerance ( void )

◆ disablePitch()

void openjaus::mobility_v1_0::LocalWaypointRecord::disablePitch ( void )

◆ disableRoll()

void openjaus::mobility_v1_0::LocalWaypointRecord::disableRoll ( void )

◆ disableWaypointTolerance()

void openjaus::mobility_v1_0::LocalWaypointRecord::disableWaypointTolerance ( void )

◆ disableYaw()

void openjaus::mobility_v1_0::LocalWaypointRecord::disableYaw ( void )

◆ disableZ()

void openjaus::mobility_v1_0::LocalWaypointRecord::disableZ ( void )

◆ enablePathTolerance()

void openjaus::mobility_v1_0::LocalWaypointRecord::enablePathTolerance ( void )

◆ enablePitch()

void openjaus::mobility_v1_0::LocalWaypointRecord::enablePitch ( void )

◆ enableRoll()

void openjaus::mobility_v1_0::LocalWaypointRecord::enableRoll ( void )

◆ enableWaypointTolerance()

void openjaus::mobility_v1_0::LocalWaypointRecord::enableWaypointTolerance ( void )

◆ enableYaw()

void openjaus::mobility_v1_0::LocalWaypointRecord::enableYaw ( void )

◆ enableZ()

void openjaus::mobility_v1_0::LocalWaypointRecord::enableZ ( void )

◆ from()

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

◆ getPathTolerance()

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

◆ getPitch_rad()

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

◆ getPresenceVector()

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

◆ getRoll_rad()

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

◆ getWaypointTolerance_m()

double openjaus::mobility_v1_0::LocalWaypointRecord::getWaypointTolerance_m ( void )

◆ getX_m()

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

◆ getY_m()

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

◆ getYaw_rad()

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

◆ getZ_m()

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

◆ isPathToleranceEnabled()

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

◆ isPitchEnabled()

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

◆ isRollEnabled()

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

◆ isWaypointToleranceEnabled()

bool openjaus::mobility_v1_0::LocalWaypointRecord::isWaypointToleranceEnabled ( void ) const

◆ isYawEnabled()

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

◆ isZEnabled()

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

◆ length()

uint64 openjaus::mobility_v1_0::LocalWaypointRecord::length ( void ) const

virtual

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

◆ setPathTolerance()

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

◆ setPitch_rad()

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

◆ setPresenceVector()

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

◆ setRoll_rad()

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

◆ setWaypointTolerance_m()

bool openjaus::mobility_v1_0::LocalWaypointRecord::setWaypointTolerance_m ( double value )

◆ setX_m()

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

◆ setY_m()

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

◆ setYaw_rad()

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

◆ setZ_m()

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

◆ to()

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

Member Data Documentation

◆ pathTolerance

PathToleranceRefScaledInteger openjaus::mobility_v1_0::LocalWaypointRecord::pathTolerance

protected

◆ pitch_rad

OrientationScaledInteger openjaus::mobility_v1_0::LocalWaypointRecord::pitch_rad

protected

◆ presenceVector

uint8_t openjaus::mobility_v1_0::LocalWaypointRecord::presenceVector

protected

◆ PV_ALL_FIELDS

static

◆ PV_NO_FIELDS

const uint8_t openjaus::mobility_v1_0::LocalWaypointRecord::PV_NO_FIELDS = 0x0

static

◆ PV_PATHTOLERANCE

const uint8_t openjaus::mobility_v1_0::LocalWaypointRecord::PV_PATHTOLERANCE = 0x20

static

◆ PV_PITCH

const uint8_t openjaus::mobility_v1_0::LocalWaypointRecord::PV_PITCH = 0x4

static

◆ PV_ROLL

const uint8_t openjaus::mobility_v1_0::LocalWaypointRecord::PV_ROLL = 0x2

static

◆ PV_WAYPOINTTOLERANCE

const uint8_t openjaus::mobility_v1_0::LocalWaypointRecord::PV_WAYPOINTTOLERANCE = 0x10

static

◆ PV_YAW

const uint8_t openjaus::mobility_v1_0::LocalWaypointRecord::PV_YAW = 0x8

static

◆ PV_Z

const uint8_t openjaus::mobility_v1_0::LocalWaypointRecord::PV_Z = 0x1

static

◆ roll_rad

OrientationScaledInteger openjaus::mobility_v1_0::LocalWaypointRecord::roll_rad

protected

◆ waypointTolerance_m

WaypointToleranceRefScaledInteger openjaus::mobility_v1_0::LocalWaypointRecord::waypointTolerance_m

protected

◆ x_m

LocalPositionScaledInteger openjaus::mobility_v1_0::LocalWaypointRecord::x_m

protected

◆ y_m

LocalPositionScaledInteger openjaus::mobility_v1_0::LocalWaypointRecord::y_m

protected

◆ yaw_rad

OrientationScaledInteger openjaus::mobility_v1_0::LocalWaypointRecord::yaw_rad

protected

◆ z_m

LocalPositionScaledInteger openjaus::mobility_v1_0::LocalWaypointRecord::z_m

protected

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

include/openjaus/mobility_v1_0/Triggers/Fields/LocalWaypointRecord.h
src/openjaus/mobility_v1_0/Triggers/Fields/LocalWaypointRecord.cpp

Public Member Functions

Static Public Attributes

Protected Attributes

Constructor & Destructor Documentation

◆ LocalWaypointRecord() [1/2]

◆ LocalWaypointRecord() [2/2]

◆ ~LocalWaypointRecord()

Member Function Documentation

◆ copy()

◆ disablePathTolerance()

◆ disablePitch()

◆ disableRoll()

◆ disableWaypointTolerance()

◆ disableYaw()

◆ disableZ()

◆ enablePathTolerance()

◆ enablePitch()

◆ enableRoll()

◆ enableWaypointTolerance()

◆ enableYaw()

◆ enableZ()

◆ from()

◆ getPathTolerance()

◆ getPitch_rad()

◆ getPresenceVector()

◆ getRoll_rad()

◆ getWaypointTolerance_m()

◆ getX_m()

◆ getY_m()

◆ getYaw_rad()

◆ getZ_m()

◆ isPathToleranceEnabled()

◆ isPitchEnabled()

◆ isRollEnabled()

◆ isWaypointToleranceEnabled()

◆ isYawEnabled()

◆ isZEnabled()

◆ length()

◆ setPathTolerance()

◆ setPitch_rad()

◆ setPresenceVector()

◆ setRoll_rad()

◆ setWaypointTolerance_m()

◆ setX_m()

◆ setY_m()

◆ setYaw_rad()

◆ setZ_m()

◆ to()

◆ toXml()

Member Data Documentation

◆ pathTolerance

◆ pitch_rad

◆ presenceVector

◆ PV_ALL_FIELDS

◆ PV_NO_FIELDS

◆ PV_PATHTOLERANCE

◆ PV_PITCH

◆ PV_ROLL

◆ PV_WAYPOINTTOLERANCE

◆ PV_YAW

◆ PV_Z

◆ roll_rad

◆ waypointTolerance_m

◆ x_m

◆ y_m

◆ yaw_rad

◆ z_m