openjaus::ugv::AckermannSpecificsRecord Class Reference

#include <AckermannSpecificsRecord.h>

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

Public Member Functions
	AckermannSpecificsRecord ()
	AckermannSpecificsRecord (const AckermannSpecificsRecord &source)
	~AckermannSpecificsRecord ()
void	copy (AckermannSpecificsRecord &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	isSteeringAngleRangeEnabled (void) const
void	enableSteeringAngleRange (void)
void	disableSteeringAngleRange (void)
bool	isMinTurnRadiusEnabled (void) const
void	enableMinTurnRadius (void)
void	disableMinTurnRadius (void)
bool	isWheelSeparationEnabled (void) const
void	enableWheelSeparation (void)
void	disableWheelSeparation (void)
bool	isDriveWheelRadiusEnabled (void) const
void	enableDriveWheelRadius (void)
void	disableDriveWheelRadius (void)
double	getSteeringAngleRange_rad (void)
bool	setSteeringAngleRange_rad (double value)
double	getMinTurnRadius_m (void)
bool	setMinTurnRadius_m (double value)
double	getWheelSeparation_m (void)
bool	setWheelSeparation_m (double value)
double	getDriveWheelRadius_m (void)
bool	setDriveWheelRadius_m (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_STEERINGANGLERANGE = 0x1
static const uint8_t	PV_MINTURNRADIUS = 0x2
static const uint8_t	PV_WHEELSEPARATION = 0x4
static const uint8_t	PV_DRIVEWHEELRADIUS = 0x8

Protected Attributes
SteeringAngleRangeScaledInteger	steeringAngleRange_rad
MinTurnRadiusScaledInteger	minTurnRadius_m
WheelSeparationScaledInteger	wheelSeparation_m
DriveWheelRadiusScaledInteger	driveWheelRadius_m
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

AckermannSpecificsRecord() [1/2]

openjaus::ugv::AckermannSpecificsRecord::AckermannSpecificsRecord

(

)

AckermannSpecificsRecord() [2/2]

openjaus::ugv::AckermannSpecificsRecord::AckermannSpecificsRecord

(

const AckermannSpecificsRecord &

source

)

~AckermannSpecificsRecord()

openjaus::ugv::AckermannSpecificsRecord::~AckermannSpecificsRecord

(

)

Member Function Documentation

copy()

void openjaus::ugv::AckermannSpecificsRecord::copy

(

AckermannSpecificsRecord &

source

)

disableDriveWheelRadius()

void openjaus::ugv::AckermannSpecificsRecord::disableDriveWheelRadius

(

void

)

disableMinTurnRadius()

void openjaus::ugv::AckermannSpecificsRecord::disableMinTurnRadius

(

void

)

disableSteeringAngleRange()

void openjaus::ugv::AckermannSpecificsRecord::disableSteeringAngleRange

(

void

)

disableWheelSeparation()

void openjaus::ugv::AckermannSpecificsRecord::disableWheelSeparation

(

void

)

enableDriveWheelRadius()

void openjaus::ugv::AckermannSpecificsRecord::enableDriveWheelRadius

(

void

)

enableMinTurnRadius()

void openjaus::ugv::AckermannSpecificsRecord::enableMinTurnRadius

(

void

)

enableSteeringAngleRange()

void openjaus::ugv::AckermannSpecificsRecord::enableSteeringAngleRange

(

void

)

enableWheelSeparation()

void openjaus::ugv::AckermannSpecificsRecord::enableWheelSeparation

(

void

)

from()

int openjaus::ugv::AckermannSpecificsRecord::from ( system::Buffer *  src )

virtual

Parameters

src

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

getDriveWheelRadius_m()

double openjaus::ugv::AckermannSpecificsRecord::getDriveWheelRadius_m

(

void

)

getMinTurnRadius_m()

double openjaus::ugv::AckermannSpecificsRecord::getMinTurnRadius_m

(

void

)

getPresenceVector()

uint8_t openjaus::ugv::AckermannSpecificsRecord::getPresenceVector

(

void

)

const

getSteeringAngleRange_rad()

double openjaus::ugv::AckermannSpecificsRecord::getSteeringAngleRange_rad

(

void

)

getWheelSeparation_m()

double openjaus::ugv::AckermannSpecificsRecord::getWheelSeparation_m

(

void

)

isDriveWheelRadiusEnabled()

bool openjaus::ugv::AckermannSpecificsRecord::isDriveWheelRadiusEnabled

(

void

)

const

isMinTurnRadiusEnabled()

bool openjaus::ugv::AckermannSpecificsRecord::isMinTurnRadiusEnabled

(

void

)

const

isSteeringAngleRangeEnabled()

bool openjaus::ugv::AckermannSpecificsRecord::isSteeringAngleRangeEnabled

(

void

)

const

isWheelSeparationEnabled()

bool openjaus::ugv::AckermannSpecificsRecord::isWheelSeparationEnabled

(

void

)

const

length()

int openjaus::ugv::AckermannSpecificsRecord::length ( void  )

virtual

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

setDriveWheelRadius_m()

bool openjaus::ugv::AckermannSpecificsRecord::setDriveWheelRadius_m

(

double

value

)

setMinTurnRadius_m()

bool openjaus::ugv::AckermannSpecificsRecord::setMinTurnRadius_m

(

double

value

)

setPresenceVector()

void openjaus::ugv::AckermannSpecificsRecord::setPresenceVector

(

uint8_t

value

)

setSteeringAngleRange_rad()

bool openjaus::ugv::AckermannSpecificsRecord::setSteeringAngleRange_rad

(

double

value

)

setWheelSeparation_m()

bool openjaus::ugv::AckermannSpecificsRecord::setWheelSeparation_m

(

double

value

)

to()

int openjaus::ugv::AckermannSpecificsRecord::to ( system::Buffer *  dst )

virtual

Parameters

dst

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

toXml()

std::string openjaus::ugv::AckermannSpecificsRecord::toXml

(

unsigned char

ojIndentLevel = 0

)

const

Member Data Documentation

driveWheelRadius_m

DriveWheelRadiusScaledInteger openjaus::ugv::AckermannSpecificsRecord::driveWheelRadius_m

protected

minTurnRadius_m

MinTurnRadiusScaledInteger openjaus::ugv::AckermannSpecificsRecord::minTurnRadius_m

protected

presenceVector

uint8_t openjaus::ugv::AckermannSpecificsRecord::presenceVector

protected

PV_ALL_FIELDS

const uint8_t openjaus::ugv::AckermannSpecificsRecord::PV_ALL_FIELDS = 0xFF

static

PV_DRIVEWHEELRADIUS

const uint8_t openjaus::ugv::AckermannSpecificsRecord::PV_DRIVEWHEELRADIUS = 0x8

static

PV_MINTURNRADIUS

const uint8_t openjaus::ugv::AckermannSpecificsRecord::PV_MINTURNRADIUS = 0x2

static

PV_NO_FIELDS

const uint8_t openjaus::ugv::AckermannSpecificsRecord::PV_NO_FIELDS = 0x0

static

PV_STEERINGANGLERANGE

const uint8_t openjaus::ugv::AckermannSpecificsRecord::PV_STEERINGANGLERANGE = 0x1

static

PV_WHEELSEPARATION

const uint8_t openjaus::ugv::AckermannSpecificsRecord::PV_WHEELSEPARATION = 0x4

static

steeringAngleRange_rad

SteeringAngleRangeScaledInteger openjaus::ugv::AckermannSpecificsRecord::steeringAngleRange_rad

protected

wheelSeparation_m

WheelSeparationScaledInteger openjaus::ugv::AckermannSpecificsRecord::wheelSeparation_m

protected

---

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

• include/openjaus/ugv/Triggers/Fields/AckermannSpecificsRecord.h
• src/openjaus/ugv/Triggers/Fields/AckermannSpecificsRecord.cpp