openjaus::ugv_v1_0::SkidsteerSpecificsRecord Class Reference

#include <SkidsteerSpecificsRecord.h>

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

Public Member Functions
	SkidsteerSpecificsRecord ()
	SkidsteerSpecificsRecord (const SkidsteerSpecificsRecord &source)
	~SkidsteerSpecificsRecord ()
void	copy (SkidsteerSpecificsRecord &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	isTrackSeparationEnabled (void) const
void	enableTrackSeparation (void)
void	disableTrackSeparation (void)
bool	isDriveWheelRadiusEnabled (void) const
void	enableDriveWheelRadius (void)
void	disableDriveWheelRadius (void)
double	getTrackSeparation_m (void)
bool	setTrackSeparation_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
	Transportable ()
virtual	~Transportable ()

Static Public Attributes
static const uint8_t	PV_NO_FIELDS = 0x0
static const uint8_t	PV_TRACKSEPARATION = 0x1
static const uint8_t	PV_DRIVEWHEELRADIUS = 0x2
static const uint8_t	PV_ALL_FIELDS = PV_NO_FIELDS | PV_TRACKSEPARATION | PV_DRIVEWHEELRADIUS

Protected Attributes
TrackSeparationScaledInteger	trackSeparation_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

SkidsteerSpecificsRecord() [1/2]

openjaus::ugv_v1_0::SkidsteerSpecificsRecord::SkidsteerSpecificsRecord

(

)

SkidsteerSpecificsRecord() [2/2]

openjaus::ugv_v1_0::SkidsteerSpecificsRecord::SkidsteerSpecificsRecord

(

const SkidsteerSpecificsRecord &

source

)

~SkidsteerSpecificsRecord()

openjaus::ugv_v1_0::SkidsteerSpecificsRecord::~SkidsteerSpecificsRecord

(

)

Member Function Documentation

copy()

void openjaus::ugv_v1_0::SkidsteerSpecificsRecord::copy

(

SkidsteerSpecificsRecord &

source

)

disableDriveWheelRadius()

void openjaus::ugv_v1_0::SkidsteerSpecificsRecord::disableDriveWheelRadius

(

void

)

disableTrackSeparation()

void openjaus::ugv_v1_0::SkidsteerSpecificsRecord::disableTrackSeparation

(

void

)

enableDriveWheelRadius()

void openjaus::ugv_v1_0::SkidsteerSpecificsRecord::enableDriveWheelRadius

(

void

)

enableTrackSeparation()

void openjaus::ugv_v1_0::SkidsteerSpecificsRecord::enableTrackSeparation

(

void

)

from()

uint64 openjaus::ugv_v1_0::SkidsteerSpecificsRecord::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.

getDriveWheelRadius_m()

double openjaus::ugv_v1_0::SkidsteerSpecificsRecord::getDriveWheelRadius_m

(

void

)

getPresenceVector()

uint8_t openjaus::ugv_v1_0::SkidsteerSpecificsRecord::getPresenceVector

(

void

)

const

getTrackSeparation_m()

double openjaus::ugv_v1_0::SkidsteerSpecificsRecord::getTrackSeparation_m

(

void

)

isDriveWheelRadiusEnabled()

bool openjaus::ugv_v1_0::SkidsteerSpecificsRecord::isDriveWheelRadiusEnabled

(

void

)

const

isTrackSeparationEnabled()

bool openjaus::ugv_v1_0::SkidsteerSpecificsRecord::isTrackSeparationEnabled

(

void

)

const

length()

uint64 openjaus::ugv_v1_0::SkidsteerSpecificsRecord::length ( void  ) const

virtual

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

setDriveWheelRadius_m()

bool openjaus::ugv_v1_0::SkidsteerSpecificsRecord::setDriveWheelRadius_m

(

double

value

)

setPresenceVector()

void openjaus::ugv_v1_0::SkidsteerSpecificsRecord::setPresenceVector

(

uint8_t

value

)

setTrackSeparation_m()

bool openjaus::ugv_v1_0::SkidsteerSpecificsRecord::setTrackSeparation_m

(

double

value

)

to()

uint64 openjaus::ugv_v1_0::SkidsteerSpecificsRecord::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::ugv_v1_0::SkidsteerSpecificsRecord::toXml

(

unsigned char

ojIndentLevel = 0

)

const

Member Data Documentation

driveWheelRadius_m

DriveWheelRadiusScaledInteger openjaus::ugv_v1_0::SkidsteerSpecificsRecord::driveWheelRadius_m

protected

presenceVector

uint8_t openjaus::ugv_v1_0::SkidsteerSpecificsRecord::presenceVector

protected

PV_ALL_FIELDS

const uint8_t openjaus::ugv_v1_0::SkidsteerSpecificsRecord::PV_ALL_FIELDS = PV_NO_FIELDS | PV_TRACKSEPARATION | PV_DRIVEWHEELRADIUS

static

PV_DRIVEWHEELRADIUS

const uint8_t openjaus::ugv_v1_0::SkidsteerSpecificsRecord::PV_DRIVEWHEELRADIUS = 0x2

static

PV_NO_FIELDS

const uint8_t openjaus::ugv_v1_0::SkidsteerSpecificsRecord::PV_NO_FIELDS = 0x0

static

PV_TRACKSEPARATION

const uint8_t openjaus::ugv_v1_0::SkidsteerSpecificsRecord::PV_TRACKSEPARATION = 0x1

static

trackSeparation_m

TrackSeparationScaledInteger openjaus::ugv_v1_0::SkidsteerSpecificsRecord::trackSeparation_m

protected

---

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

• include/openjaus/ugv_v1_0/Triggers/Fields/SkidsteerSpecificsRecord.h
• src/openjaus/ugv_v1_0/Triggers/Fields/SkidsteerSpecificsRecord.cpp