openjaus::mobility::LocalWaypointRecord Class Reference

#include <LocalWaypointRecord.h>

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

Public Member Functions
	LocalWaypointRecord ()
	LocalWaypointRecord (const LocalWaypointRecord &source)
	~LocalWaypointRecord ()
void	copy (LocalWaypointRecord &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 (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
virtual	~Transportable ()
	Transportable ()

Static Public Attributes
static const uint8_t	PV_ALL_FIELDS = 0xFF
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

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::LocalWaypointRecord::LocalWaypointRecord

(

)

LocalWaypointRecord() [2/2]

openjaus::mobility::LocalWaypointRecord::LocalWaypointRecord

(

const LocalWaypointRecord &

source

)

~LocalWaypointRecord()

openjaus::mobility::LocalWaypointRecord::~LocalWaypointRecord

(

)

Member Function Documentation

copy()

void openjaus::mobility::LocalWaypointRecord::copy

(

LocalWaypointRecord &

source

)

disablePathTolerance()

void openjaus::mobility::LocalWaypointRecord::disablePathTolerance

(

void

)

disablePitch()

void openjaus::mobility::LocalWaypointRecord::disablePitch

(

void

)

disableRoll()

void openjaus::mobility::LocalWaypointRecord::disableRoll

(

void

)

disableWaypointTolerance()

void openjaus::mobility::LocalWaypointRecord::disableWaypointTolerance

(

void

)

disableYaw()

void openjaus::mobility::LocalWaypointRecord::disableYaw

(

void

)

disableZ()

void openjaus::mobility::LocalWaypointRecord::disableZ

(

void

)

enablePathTolerance()

void openjaus::mobility::LocalWaypointRecord::enablePathTolerance

(

void

)

enablePitch()

void openjaus::mobility::LocalWaypointRecord::enablePitch

(

void

)

enableRoll()

void openjaus::mobility::LocalWaypointRecord::enableRoll

(

void

)

enableWaypointTolerance()

void openjaus::mobility::LocalWaypointRecord::enableWaypointTolerance

(

void

)

enableYaw()

void openjaus::mobility::LocalWaypointRecord::enableYaw

(

void

)

enableZ()

void openjaus::mobility::LocalWaypointRecord::enableZ

(

void

)

from()

int openjaus::mobility::LocalWaypointRecord::from ( system::Buffer *  src )

virtual

Parameters

src

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

getPathTolerance()

double openjaus::mobility::LocalWaypointRecord::getPathTolerance

(

void

)

getPitch_rad()

double openjaus::mobility::LocalWaypointRecord::getPitch_rad

(

void

)

getPresenceVector()

uint8_t openjaus::mobility::LocalWaypointRecord::getPresenceVector

(

void

)

const

getRoll_rad()

double openjaus::mobility::LocalWaypointRecord::getRoll_rad

(

void

)

getWaypointTolerance_m()

double openjaus::mobility::LocalWaypointRecord::getWaypointTolerance_m

(

void

)

getX_m()

double openjaus::mobility::LocalWaypointRecord::getX_m

(

void

)

getY_m()

double openjaus::mobility::LocalWaypointRecord::getY_m

(

void

)

getYaw_rad()

double openjaus::mobility::LocalWaypointRecord::getYaw_rad

(

void

)

getZ_m()

double openjaus::mobility::LocalWaypointRecord::getZ_m

(

void

)

isPathToleranceEnabled()

bool openjaus::mobility::LocalWaypointRecord::isPathToleranceEnabled

(

void

)

const

isPitchEnabled()

bool openjaus::mobility::LocalWaypointRecord::isPitchEnabled

(

void

)

const

isRollEnabled()

bool openjaus::mobility::LocalWaypointRecord::isRollEnabled

(

void

)

const

isWaypointToleranceEnabled()

bool openjaus::mobility::LocalWaypointRecord::isWaypointToleranceEnabled

(

void

)

const

isYawEnabled()

bool openjaus::mobility::LocalWaypointRecord::isYawEnabled

(

void

)

const

isZEnabled()

bool openjaus::mobility::LocalWaypointRecord::isZEnabled

(

void

)

const

length()

int openjaus::mobility::LocalWaypointRecord::length ( void  )

virtual

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

setPathTolerance()

bool openjaus::mobility::LocalWaypointRecord::setPathTolerance

(

double

value

)

setPitch_rad()

bool openjaus::mobility::LocalWaypointRecord::setPitch_rad

(

double

value

)

setPresenceVector()

void openjaus::mobility::LocalWaypointRecord::setPresenceVector

(

uint8_t

value

)

setRoll_rad()

bool openjaus::mobility::LocalWaypointRecord::setRoll_rad

(

double

value

)

setWaypointTolerance_m()

bool openjaus::mobility::LocalWaypointRecord::setWaypointTolerance_m

(

double

value

)

setX_m()

bool openjaus::mobility::LocalWaypointRecord::setX_m

(

double

value

)

setY_m()

bool openjaus::mobility::LocalWaypointRecord::setY_m

(

double

value

)

setYaw_rad()

bool openjaus::mobility::LocalWaypointRecord::setYaw_rad

(

double

value

)

setZ_m()

bool openjaus::mobility::LocalWaypointRecord::setZ_m

(

double

value

)

to()

int openjaus::mobility::LocalWaypointRecord::to ( system::Buffer *  dst )

virtual

Parameters

dst

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

toXml()

std::string openjaus::mobility::LocalWaypointRecord::toXml

(

unsigned char

ojIndentLevel = 0

)

const

Member Data Documentation

pathTolerance

PathToleranceRefScaledInteger openjaus::mobility::LocalWaypointRecord::pathTolerance

protected

pitch_rad

OrientationScaledInteger openjaus::mobility::LocalWaypointRecord::pitch_rad

protected

presenceVector

uint8_t openjaus::mobility::LocalWaypointRecord::presenceVector

protected

PV_ALL_FIELDS

const uint8_t openjaus::mobility::LocalWaypointRecord::PV_ALL_FIELDS = 0xFF

static

PV_NO_FIELDS

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

static

PV_PATHTOLERANCE

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

static

PV_PITCH

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

static

PV_ROLL

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

static

PV_WAYPOINTTOLERANCE

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

static

PV_YAW

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

static

PV_Z

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

static

roll_rad

OrientationScaledInteger openjaus::mobility::LocalWaypointRecord::roll_rad

protected

waypointTolerance_m

WaypointToleranceRefScaledInteger openjaus::mobility::LocalWaypointRecord::waypointTolerance_m

protected

x_m

LocalPositionScaledInteger openjaus::mobility::LocalWaypointRecord::x_m

protected

y_m

LocalPositionScaledInteger openjaus::mobility::LocalWaypointRecord::y_m

protected

yaw_rad

OrientationScaledInteger openjaus::mobility::LocalWaypointRecord::yaw_rad

protected

z_m

LocalPositionScaledInteger openjaus::mobility::LocalWaypointRecord::z_m

protected

---

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

• include/openjaus/mobility/Triggers/Fields/LocalWaypointRecord.h
• src/openjaus/mobility/Triggers/Fields/LocalWaypointRecord.cpp