openjaus::environment::RangeSensorCapabilitiesRecord Class Reference

#include <RangeSensorCapabilitiesRecord.h>

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

Public Member Functions
	RangeSensorCapabilitiesRecord ()
	RangeSensorCapabilitiesRecord (const RangeSensorCapabilitiesRecord &source)
	~RangeSensorCapabilitiesRecord ()
void	copy (RangeSensorCapabilitiesRecord &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 (uint16_t value)
uint16_t	getPresenceVector (void) const
bool	isSupportedStatesEnabled (void) const
void	enableSupportedStates (void)
void	disableSupportedStates (void)
bool	isMinimumHorizontalFieldOfViewStartAngleEnabled (void) const
void	enableMinimumHorizontalFieldOfViewStartAngle (void)
void	disableMinimumHorizontalFieldOfViewStartAngle (void)
bool	isMaximumHorizontalFieldOfViewStopAngleEnabled (void) const
void	enableMaximumHorizontalFieldOfViewStopAngle (void)
void	disableMaximumHorizontalFieldOfViewStopAngle (void)
bool	isMinimumVerticalFieldOfViewStartAngleEnabled (void) const
void	enableMinimumVerticalFieldOfViewStartAngle (void)
void	disableMinimumVerticalFieldOfViewStartAngle (void)
bool	isMaximumVerticalFieldOfViewStopAngleEnabled (void) const
void	enableMaximumVerticalFieldOfViewStopAngle (void)
void	disableMaximumVerticalFieldOfViewStopAngle (void)
bool	isMiniumumUpdateRateEnabled (void) const
void	enableMiniumumUpdateRate (void)
void	disableMiniumumUpdateRate (void)
bool	isMaximumUpdateRateEnabled (void) const
void	enableMaximumUpdateRate (void)
void	disableMaximumUpdateRate (void)
bool	isMinimumRangeEnabled (void) const
void	enableMinimumRange (void)
void	disableMinimumRange (void)
bool	isMaximumRangeEnabled (void) const
void	enableMaximumRange (void)
void	disableMaximumRange (void)
bool	isSupportedCompressionEnabled (void) const
void	enableSupportedCompression (void)
void	disableSupportedCompression (void)
bool	isCoordinateTransformationSupportedEnabled (void) const
void	enableCoordinateTransformationSupported (void)
void	disableCoordinateTransformationSupported (void)
uint16_t	getSensorID (void)
bool	setSensorID (uint16_t value)
std::string	getSensorName (void)
bool	setSensorName (std::string value)
SupportedStatesBitField &	getSupportedStates (void)
double	getMinimumHorizontalFieldOfViewStartAngle_rad (void)
bool	setMinimumHorizontalFieldOfViewStartAngle_rad (double value)
double	getMaximumHorizontalFieldOfViewStopAngle_rad (void)
bool	setMaximumHorizontalFieldOfViewStopAngle_rad (double value)
double	getMinimumVerticalFieldOfViewStartAngle_rad (void)
bool	setMinimumVerticalFieldOfViewStartAngle_rad (double value)
double	getMaximumVerticalFieldOfViewStopAngle_rad (void)
bool	setMaximumVerticalFieldOfViewStopAngle_rad (double value)
double	getMiniumumUpdateRate_Hz (void)
bool	setMiniumumUpdateRate_Hz (double value)
double	getMaximumUpdateRate_Hz (void)
bool	setMaximumUpdateRate_Hz (double value)
double	getMinimumRange_m (void)
bool	setMinimumRange_m (double value)
double	getMaximumRange_m (void)
bool	setMaximumRange_m (double value)
SupportedCompressionBitField &	getSupportedCompression (void)
CoordinateTransformationSupportedEnumeration::CoordinateTransformationSupportedEnum	getCoordinateTransformationSupported (void)
bool	setCoordinateTransformationSupported (CoordinateTransformationSupportedEnumeration::CoordinateTransformationSupportedEnum value)
std::string	getCoordinateTransformationSupportedToString (void)
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 uint16_t	PV_ALL_FIELDS = 0xFFFF
static const uint16_t	PV_NO_FIELDS = 0x0
static const uint16_t	PV_SUPPORTEDSTATES = 0x1
static const uint16_t	PV_MINIMUMHORIZONTALFIELDOFVIEWSTARTANGLE = 0x2
static const uint16_t	PV_MAXIMUMHORIZONTALFIELDOFVIEWSTOPANGLE = 0x4
static const uint16_t	PV_MINIMUMVERTICALFIELDOFVIEWSTARTANGLE = 0x8
static const uint16_t	PV_MAXIMUMVERTICALFIELDOFVIEWSTOPANGLE = 0x10
static const uint16_t	PV_MINIUMUMUPDATERATE = 0x20
static const uint16_t	PV_MAXIMUMUPDATERATE = 0x40
static const uint16_t	PV_MINIMUMRANGE = 0x80
static const uint16_t	PV_MAXIMUMRANGE = 0x100
static const uint16_t	PV_SUPPORTEDCOMPRESSION = 0x200
static const uint16_t	PV_COORDINATETRANSFORMATIONSUPPORTED = 0x400

Protected Attributes
model::fields::UnsignedShort	sensorID
model::fields::VariableLengthString	sensorName
SupportedStatesBitField	supportedStates
MinimumHorizontalFieldOfViewStartAngleScaledInteger	minimumHorizontalFieldOfViewStartAngle_rad
MaximumHorizontalFieldOfViewStopAngleScaledInteger	maximumHorizontalFieldOfViewStopAngle_rad
MinimumVerticalFieldOfViewStartAngleScaledInteger	minimumVerticalFieldOfViewStartAngle_rad
MaximumVerticalFieldOfViewStopAngleScaledInteger	maximumVerticalFieldOfViewStopAngle_rad
MiniumumUpdateRateScaledInteger	miniumumUpdateRate_Hz
MaximumUpdateRateScaledInteger	maximumUpdateRate_Hz
MinimumRangeScaledInteger	minimumRange_m
MaximumRangeScaledInteger	maximumRange_m
SupportedCompressionBitField	supportedCompression
CoordinateTransformationSupportedEnumeration	coordinateTransformationSupported
uint16_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

RangeSensorCapabilitiesRecord() [1/2]

openjaus::environment::RangeSensorCapabilitiesRecord::RangeSensorCapabilitiesRecord

(

)

RangeSensorCapabilitiesRecord() [2/2]

openjaus::environment::RangeSensorCapabilitiesRecord::RangeSensorCapabilitiesRecord

(

const RangeSensorCapabilitiesRecord &

source

)

~RangeSensorCapabilitiesRecord()

openjaus::environment::RangeSensorCapabilitiesRecord::~RangeSensorCapabilitiesRecord

(

)

Member Function Documentation

copy()

void openjaus::environment::RangeSensorCapabilitiesRecord::copy

(

RangeSensorCapabilitiesRecord &

source

)

disableCoordinateTransformationSupported()

void openjaus::environment::RangeSensorCapabilitiesRecord::disableCoordinateTransformationSupported

(

void

)

disableMaximumHorizontalFieldOfViewStopAngle()

void openjaus::environment::RangeSensorCapabilitiesRecord::disableMaximumHorizontalFieldOfViewStopAngle

(

void

)

disableMaximumRange()

void openjaus::environment::RangeSensorCapabilitiesRecord::disableMaximumRange

(

void

)

disableMaximumUpdateRate()

void openjaus::environment::RangeSensorCapabilitiesRecord::disableMaximumUpdateRate

(

void

)

disableMaximumVerticalFieldOfViewStopAngle()

void openjaus::environment::RangeSensorCapabilitiesRecord::disableMaximumVerticalFieldOfViewStopAngle

(

void

)

disableMinimumHorizontalFieldOfViewStartAngle()

void openjaus::environment::RangeSensorCapabilitiesRecord::disableMinimumHorizontalFieldOfViewStartAngle

(

void

)

disableMinimumRange()

void openjaus::environment::RangeSensorCapabilitiesRecord::disableMinimumRange

(

void

)

disableMinimumVerticalFieldOfViewStartAngle()

void openjaus::environment::RangeSensorCapabilitiesRecord::disableMinimumVerticalFieldOfViewStartAngle

(

void

)

disableMiniumumUpdateRate()

void openjaus::environment::RangeSensorCapabilitiesRecord::disableMiniumumUpdateRate

(

void

)

disableSupportedCompression()

void openjaus::environment::RangeSensorCapabilitiesRecord::disableSupportedCompression

(

void

)

disableSupportedStates()

void openjaus::environment::RangeSensorCapabilitiesRecord::disableSupportedStates

(

void

)

enableCoordinateTransformationSupported()

void openjaus::environment::RangeSensorCapabilitiesRecord::enableCoordinateTransformationSupported

(

void

)

enableMaximumHorizontalFieldOfViewStopAngle()

void openjaus::environment::RangeSensorCapabilitiesRecord::enableMaximumHorizontalFieldOfViewStopAngle

(

void

)

enableMaximumRange()

void openjaus::environment::RangeSensorCapabilitiesRecord::enableMaximumRange

(

void

)

enableMaximumUpdateRate()

void openjaus::environment::RangeSensorCapabilitiesRecord::enableMaximumUpdateRate

(

void

)

enableMaximumVerticalFieldOfViewStopAngle()

void openjaus::environment::RangeSensorCapabilitiesRecord::enableMaximumVerticalFieldOfViewStopAngle

(

void

)

enableMinimumHorizontalFieldOfViewStartAngle()

void openjaus::environment::RangeSensorCapabilitiesRecord::enableMinimumHorizontalFieldOfViewStartAngle

(

void

)

enableMinimumRange()

void openjaus::environment::RangeSensorCapabilitiesRecord::enableMinimumRange

(

void

)

enableMinimumVerticalFieldOfViewStartAngle()

void openjaus::environment::RangeSensorCapabilitiesRecord::enableMinimumVerticalFieldOfViewStartAngle

(

void

)

enableMiniumumUpdateRate()

void openjaus::environment::RangeSensorCapabilitiesRecord::enableMiniumumUpdateRate

(

void

)

enableSupportedCompression()

void openjaus::environment::RangeSensorCapabilitiesRecord::enableSupportedCompression

(

void

)

enableSupportedStates()

void openjaus::environment::RangeSensorCapabilitiesRecord::enableSupportedStates

(

void

)

from()

int openjaus::environment::RangeSensorCapabilitiesRecord::from ( system::Buffer *  src )

virtual

Parameters

src

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

getCoordinateTransformationSupported()

CoordinateTransformationSupportedEnumeration::CoordinateTransformationSupportedEnum openjaus::environment::RangeSensorCapabilitiesRecord::getCoordinateTransformationSupported

(

void

)

getCoordinateTransformationSupportedToString()

std::string openjaus::environment::RangeSensorCapabilitiesRecord::getCoordinateTransformationSupportedToString

(

void

)

getMaximumHorizontalFieldOfViewStopAngle_rad()

double openjaus::environment::RangeSensorCapabilitiesRecord::getMaximumHorizontalFieldOfViewStopAngle_rad

(

void

)

getMaximumRange_m()

double openjaus::environment::RangeSensorCapabilitiesRecord::getMaximumRange_m

(

void

)

getMaximumUpdateRate_Hz()

double openjaus::environment::RangeSensorCapabilitiesRecord::getMaximumUpdateRate_Hz

(

void

)

getMaximumVerticalFieldOfViewStopAngle_rad()

double openjaus::environment::RangeSensorCapabilitiesRecord::getMaximumVerticalFieldOfViewStopAngle_rad

(

void

)

getMinimumHorizontalFieldOfViewStartAngle_rad()

double openjaus::environment::RangeSensorCapabilitiesRecord::getMinimumHorizontalFieldOfViewStartAngle_rad

(

void

)

getMinimumRange_m()

double openjaus::environment::RangeSensorCapabilitiesRecord::getMinimumRange_m

(

void

)

getMinimumVerticalFieldOfViewStartAngle_rad()

double openjaus::environment::RangeSensorCapabilitiesRecord::getMinimumVerticalFieldOfViewStartAngle_rad

(

void

)

getMiniumumUpdateRate_Hz()

double openjaus::environment::RangeSensorCapabilitiesRecord::getMiniumumUpdateRate_Hz

(

void

)

getPresenceVector()

uint16_t openjaus::environment::RangeSensorCapabilitiesRecord::getPresenceVector

(

void

)

const

getSensorID()

uint16_t openjaus::environment::RangeSensorCapabilitiesRecord::getSensorID

(

void

)

getSensorName()

std::string openjaus::environment::RangeSensorCapabilitiesRecord::getSensorName

(

void

)

getSupportedCompression()

SupportedCompressionBitField & openjaus::environment::RangeSensorCapabilitiesRecord::getSupportedCompression

(

void

)

getSupportedStates()

SupportedStatesBitField & openjaus::environment::RangeSensorCapabilitiesRecord::getSupportedStates

(

void

)

isCoordinateTransformationSupportedEnabled()

bool openjaus::environment::RangeSensorCapabilitiesRecord::isCoordinateTransformationSupportedEnabled

(

void

)

const

isMaximumHorizontalFieldOfViewStopAngleEnabled()

bool openjaus::environment::RangeSensorCapabilitiesRecord::isMaximumHorizontalFieldOfViewStopAngleEnabled

(

void

)

const

isMaximumRangeEnabled()

bool openjaus::environment::RangeSensorCapabilitiesRecord::isMaximumRangeEnabled

(

void

)

const

isMaximumUpdateRateEnabled()

bool openjaus::environment::RangeSensorCapabilitiesRecord::isMaximumUpdateRateEnabled

(

void

)

const

isMaximumVerticalFieldOfViewStopAngleEnabled()

bool openjaus::environment::RangeSensorCapabilitiesRecord::isMaximumVerticalFieldOfViewStopAngleEnabled

(

void

)

const

isMinimumHorizontalFieldOfViewStartAngleEnabled()

bool openjaus::environment::RangeSensorCapabilitiesRecord::isMinimumHorizontalFieldOfViewStartAngleEnabled

(

void

)

const

isMinimumRangeEnabled()

bool openjaus::environment::RangeSensorCapabilitiesRecord::isMinimumRangeEnabled

(

void

)

const

isMinimumVerticalFieldOfViewStartAngleEnabled()

bool openjaus::environment::RangeSensorCapabilitiesRecord::isMinimumVerticalFieldOfViewStartAngleEnabled

(

void

)

const

isMiniumumUpdateRateEnabled()

bool openjaus::environment::RangeSensorCapabilitiesRecord::isMiniumumUpdateRateEnabled

(

void

)

const

isSupportedCompressionEnabled()

bool openjaus::environment::RangeSensorCapabilitiesRecord::isSupportedCompressionEnabled

(

void

)

const

isSupportedStatesEnabled()

bool openjaus::environment::RangeSensorCapabilitiesRecord::isSupportedStatesEnabled

(

void

)

const

length()

int openjaus::environment::RangeSensorCapabilitiesRecord::length ( void  )

virtual

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

setCoordinateTransformationSupported()

bool openjaus::environment::RangeSensorCapabilitiesRecord::setCoordinateTransformationSupported

(

CoordinateTransformationSupportedEnumeration::CoordinateTransformationSupportedEnum

value

)

setMaximumHorizontalFieldOfViewStopAngle_rad()

bool openjaus::environment::RangeSensorCapabilitiesRecord::setMaximumHorizontalFieldOfViewStopAngle_rad

(

double

value

)

setMaximumRange_m()

bool openjaus::environment::RangeSensorCapabilitiesRecord::setMaximumRange_m

(

double

value

)

setMaximumUpdateRate_Hz()

bool openjaus::environment::RangeSensorCapabilitiesRecord::setMaximumUpdateRate_Hz

(

double

value

)

setMaximumVerticalFieldOfViewStopAngle_rad()

bool openjaus::environment::RangeSensorCapabilitiesRecord::setMaximumVerticalFieldOfViewStopAngle_rad

(

double

value

)

setMinimumHorizontalFieldOfViewStartAngle_rad()

bool openjaus::environment::RangeSensorCapabilitiesRecord::setMinimumHorizontalFieldOfViewStartAngle_rad

(

double

value

)

setMinimumRange_m()

bool openjaus::environment::RangeSensorCapabilitiesRecord::setMinimumRange_m

(

double

value

)

setMinimumVerticalFieldOfViewStartAngle_rad()

bool openjaus::environment::RangeSensorCapabilitiesRecord::setMinimumVerticalFieldOfViewStartAngle_rad

(

double

value

)

setMiniumumUpdateRate_Hz()

bool openjaus::environment::RangeSensorCapabilitiesRecord::setMiniumumUpdateRate_Hz

(

double

value

)

setPresenceVector()

void openjaus::environment::RangeSensorCapabilitiesRecord::setPresenceVector

(

uint16_t

value

)

setSensorID()

bool openjaus::environment::RangeSensorCapabilitiesRecord::setSensorID

(

uint16_t

value

)

setSensorName()

bool openjaus::environment::RangeSensorCapabilitiesRecord::setSensorName

(

std::string

value

)

to()

int openjaus::environment::RangeSensorCapabilitiesRecord::to ( system::Buffer *  dst )

virtual

Parameters

dst

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

toXml()

std::string openjaus::environment::RangeSensorCapabilitiesRecord::toXml

(

unsigned char

ojIndentLevel = 0

)

const

Member Data Documentation

coordinateTransformationSupported

CoordinateTransformationSupportedEnumeration openjaus::environment::RangeSensorCapabilitiesRecord::coordinateTransformationSupported

protected

maximumHorizontalFieldOfViewStopAngle_rad

MaximumHorizontalFieldOfViewStopAngleScaledInteger openjaus::environment::RangeSensorCapabilitiesRecord::maximumHorizontalFieldOfViewStopAngle_rad

protected

maximumRange_m

MaximumRangeScaledInteger openjaus::environment::RangeSensorCapabilitiesRecord::maximumRange_m

protected

maximumUpdateRate_Hz

MaximumUpdateRateScaledInteger openjaus::environment::RangeSensorCapabilitiesRecord::maximumUpdateRate_Hz

protected

maximumVerticalFieldOfViewStopAngle_rad

MaximumVerticalFieldOfViewStopAngleScaledInteger openjaus::environment::RangeSensorCapabilitiesRecord::maximumVerticalFieldOfViewStopAngle_rad

protected

minimumHorizontalFieldOfViewStartAngle_rad

MinimumHorizontalFieldOfViewStartAngleScaledInteger openjaus::environment::RangeSensorCapabilitiesRecord::minimumHorizontalFieldOfViewStartAngle_rad

protected

minimumRange_m

MinimumRangeScaledInteger openjaus::environment::RangeSensorCapabilitiesRecord::minimumRange_m

protected

minimumVerticalFieldOfViewStartAngle_rad

MinimumVerticalFieldOfViewStartAngleScaledInteger openjaus::environment::RangeSensorCapabilitiesRecord::minimumVerticalFieldOfViewStartAngle_rad

protected

miniumumUpdateRate_Hz

MiniumumUpdateRateScaledInteger openjaus::environment::RangeSensorCapabilitiesRecord::miniumumUpdateRate_Hz

protected

presenceVector

uint16_t openjaus::environment::RangeSensorCapabilitiesRecord::presenceVector

protected

PV_ALL_FIELDS

const uint16_t openjaus::environment::RangeSensorCapabilitiesRecord::PV_ALL_FIELDS = 0xFFFF

static

PV_COORDINATETRANSFORMATIONSUPPORTED

const uint16_t openjaus::environment::RangeSensorCapabilitiesRecord::PV_COORDINATETRANSFORMATIONSUPPORTED = 0x400

static

PV_MAXIMUMHORIZONTALFIELDOFVIEWSTOPANGLE

const uint16_t openjaus::environment::RangeSensorCapabilitiesRecord::PV_MAXIMUMHORIZONTALFIELDOFVIEWSTOPANGLE = 0x4

static

PV_MAXIMUMRANGE

const uint16_t openjaus::environment::RangeSensorCapabilitiesRecord::PV_MAXIMUMRANGE = 0x100

static

PV_MAXIMUMUPDATERATE

const uint16_t openjaus::environment::RangeSensorCapabilitiesRecord::PV_MAXIMUMUPDATERATE = 0x40

static

PV_MAXIMUMVERTICALFIELDOFVIEWSTOPANGLE

const uint16_t openjaus::environment::RangeSensorCapabilitiesRecord::PV_MAXIMUMVERTICALFIELDOFVIEWSTOPANGLE = 0x10

static

PV_MINIMUMHORIZONTALFIELDOFVIEWSTARTANGLE

const uint16_t openjaus::environment::RangeSensorCapabilitiesRecord::PV_MINIMUMHORIZONTALFIELDOFVIEWSTARTANGLE = 0x2

static

PV_MINIMUMRANGE

const uint16_t openjaus::environment::RangeSensorCapabilitiesRecord::PV_MINIMUMRANGE = 0x80

static

PV_MINIMUMVERTICALFIELDOFVIEWSTARTANGLE

const uint16_t openjaus::environment::RangeSensorCapabilitiesRecord::PV_MINIMUMVERTICALFIELDOFVIEWSTARTANGLE = 0x8

static

PV_MINIUMUMUPDATERATE

const uint16_t openjaus::environment::RangeSensorCapabilitiesRecord::PV_MINIUMUMUPDATERATE = 0x20

static

PV_NO_FIELDS

const uint16_t openjaus::environment::RangeSensorCapabilitiesRecord::PV_NO_FIELDS = 0x0

static

PV_SUPPORTEDCOMPRESSION

const uint16_t openjaus::environment::RangeSensorCapabilitiesRecord::PV_SUPPORTEDCOMPRESSION = 0x200

static

PV_SUPPORTEDSTATES

const uint16_t openjaus::environment::RangeSensorCapabilitiesRecord::PV_SUPPORTEDSTATES = 0x1

static

sensorID

model::fields::UnsignedShort openjaus::environment::RangeSensorCapabilitiesRecord::sensorID

protected

sensorName

model::fields::VariableLengthString openjaus::environment::RangeSensorCapabilitiesRecord::sensorName

protected

supportedCompression

SupportedCompressionBitField openjaus::environment::RangeSensorCapabilitiesRecord::supportedCompression

protected

supportedStates

SupportedStatesBitField openjaus::environment::RangeSensorCapabilitiesRecord::supportedStates

protected

---

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

• include/openjaus/environment/Triggers/Fields/RangeSensorCapabilitiesRecord.h
• src/openjaus/environment/Triggers/Fields/RangeSensorCapabilitiesRecord.cpp