openjaus::environment::RangeSensorConfigurationRecord Class Reference

#include <RangeSensorConfigurationRecord.h>

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

Public Member Functions
	RangeSensorConfigurationRecord ()
	RangeSensorConfigurationRecord (const RangeSensorConfigurationRecord &source)
	~RangeSensorConfigurationRecord ()
void	copy (RangeSensorConfigurationRecord &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	isHorizontalFieldOfViewStartAngleEnabled (void) const
void	enableHorizontalFieldOfViewStartAngle (void)
void	disableHorizontalFieldOfViewStartAngle (void)
bool	isHorizontalFieldOfViewStopAngleEnabled (void) const
void	enableHorizontalFieldOfViewStopAngle (void)
void	disableHorizontalFieldOfViewStopAngle (void)
bool	isVerticalFieldOfViewStartAngleEnabled (void) const
void	enableVerticalFieldOfViewStartAngle (void)
void	disableVerticalFieldOfViewStartAngle (void)
bool	isVerticalFieldOfViewStopAngleEnabled (void) const
void	enableVerticalFieldOfViewStopAngle (void)
void	disableVerticalFieldOfViewStopAngle (void)
bool	isUpdateRateEnabled (void) const
void	enableUpdateRate (void)
void	disableUpdateRate (void)
bool	isMinimumRangeEnabled (void) const
void	enableMinimumRange (void)
void	disableMinimumRange (void)
bool	isMaximumRangeEnabled (void) const
void	enableMaximumRange (void)
void	disableMaximumRange (void)
bool	isSensorStateEnabled (void) const
void	enableSensorState (void)
void	disableSensorState (void)
uint16_t	getSensorID (void)
bool	setSensorID (uint16_t value)
double	getHorizontalFieldOfViewStartAngle_rad (void)
bool	setHorizontalFieldOfViewStartAngle_rad (double value)
double	getHorizontalFieldOfViewStopAngle_rad (void)
bool	setHorizontalFieldOfViewStopAngle_rad (double value)
double	getVerticalFieldOfViewStartAngle_rad (void)
bool	setVerticalFieldOfViewStartAngle_rad (double value)
double	getVerticalFieldOfViewStopAngle_rad (void)
bool	setVerticalFieldOfViewStopAngle_rad (double value)
double	getUpdateRate_Hz (void)
bool	setUpdateRate_Hz (double value)
double	getMinimumRange_m (void)
bool	setMinimumRange_m (double value)
double	getMaximumRange_m (void)
bool	setMaximumRange_m (double value)
SensorStateEnumeration::SensorStateEnum	getSensorState (void)
bool	setSensorState (SensorStateEnumeration::SensorStateEnum value)
std::string	getSensorStateToString (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_HORIZONTALFIELDOFVIEWSTARTANGLE = 0x1
static const uint16_t	PV_HORIZONTALFIELDOFVIEWSTOPANGLE = 0x2
static const uint16_t	PV_VERTICALFIELDOFVIEWSTARTANGLE = 0x4
static const uint16_t	PV_VERTICALFIELDOFVIEWSTOPANGLE = 0x8
static const uint16_t	PV_UPDATERATE = 0x10
static const uint16_t	PV_MINIMUMRANGE = 0x20
static const uint16_t	PV_MAXIMUMRANGE = 0x40
static const uint16_t	PV_SENSORSTATE = 0x80

Protected Attributes
model::fields::UnsignedShort	sensorID
HorizontalFieldOfViewStartAngleScaledInteger	horizontalFieldOfViewStartAngle_rad
HorizontalFieldOfViewStopAngleScaledInteger	horizontalFieldOfViewStopAngle_rad
VerticalFieldOfViewStartAngleScaledInteger	verticalFieldOfViewStartAngle_rad
VerticalFieldOfViewStopAngleScaledInteger	verticalFieldOfViewStopAngle_rad
UpdateRateScaledInteger	updateRate_Hz
MinimumRangeScaledInteger	minimumRange_m
MaximumRangeScaledInteger	maximumRange_m
SensorStateEnumeration	sensorState
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

RangeSensorConfigurationRecord() [1/2]

openjaus::environment::RangeSensorConfigurationRecord::RangeSensorConfigurationRecord

(

)

RangeSensorConfigurationRecord() [2/2]

openjaus::environment::RangeSensorConfigurationRecord::RangeSensorConfigurationRecord

(

const RangeSensorConfigurationRecord &

source

)

~RangeSensorConfigurationRecord()

openjaus::environment::RangeSensorConfigurationRecord::~RangeSensorConfigurationRecord

(

)

Member Function Documentation

copy()

void openjaus::environment::RangeSensorConfigurationRecord::copy

(

RangeSensorConfigurationRecord &

source

)

disableHorizontalFieldOfViewStartAngle()

void openjaus::environment::RangeSensorConfigurationRecord::disableHorizontalFieldOfViewStartAngle

(

void

)

disableHorizontalFieldOfViewStopAngle()

void openjaus::environment::RangeSensorConfigurationRecord::disableHorizontalFieldOfViewStopAngle

(

void

)

disableMaximumRange()

void openjaus::environment::RangeSensorConfigurationRecord::disableMaximumRange

(

void

)

disableMinimumRange()

void openjaus::environment::RangeSensorConfigurationRecord::disableMinimumRange

(

void

)

disableSensorState()

void openjaus::environment::RangeSensorConfigurationRecord::disableSensorState

(

void

)

disableUpdateRate()

void openjaus::environment::RangeSensorConfigurationRecord::disableUpdateRate

(

void

)

disableVerticalFieldOfViewStartAngle()

void openjaus::environment::RangeSensorConfigurationRecord::disableVerticalFieldOfViewStartAngle

(

void

)

disableVerticalFieldOfViewStopAngle()

void openjaus::environment::RangeSensorConfigurationRecord::disableVerticalFieldOfViewStopAngle

(

void

)

enableHorizontalFieldOfViewStartAngle()

void openjaus::environment::RangeSensorConfigurationRecord::enableHorizontalFieldOfViewStartAngle

(

void

)

enableHorizontalFieldOfViewStopAngle()

void openjaus::environment::RangeSensorConfigurationRecord::enableHorizontalFieldOfViewStopAngle

(

void

)

enableMaximumRange()

void openjaus::environment::RangeSensorConfigurationRecord::enableMaximumRange

(

void

)

enableMinimumRange()

void openjaus::environment::RangeSensorConfigurationRecord::enableMinimumRange

(

void

)

enableSensorState()

void openjaus::environment::RangeSensorConfigurationRecord::enableSensorState

(

void

)

enableUpdateRate()

void openjaus::environment::RangeSensorConfigurationRecord::enableUpdateRate

(

void

)

enableVerticalFieldOfViewStartAngle()

void openjaus::environment::RangeSensorConfigurationRecord::enableVerticalFieldOfViewStartAngle

(

void

)

enableVerticalFieldOfViewStopAngle()

void openjaus::environment::RangeSensorConfigurationRecord::enableVerticalFieldOfViewStopAngle

(

void

)

from()

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

virtual

Parameters

src

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

getHorizontalFieldOfViewStartAngle_rad()

double openjaus::environment::RangeSensorConfigurationRecord::getHorizontalFieldOfViewStartAngle_rad

(

void

)

getHorizontalFieldOfViewStopAngle_rad()

double openjaus::environment::RangeSensorConfigurationRecord::getHorizontalFieldOfViewStopAngle_rad

(

void

)

getMaximumRange_m()

double openjaus::environment::RangeSensorConfigurationRecord::getMaximumRange_m

(

void

)

getMinimumRange_m()

double openjaus::environment::RangeSensorConfigurationRecord::getMinimumRange_m

(

void

)

getPresenceVector()

uint16_t openjaus::environment::RangeSensorConfigurationRecord::getPresenceVector

(

void

)

const

getSensorID()

uint16_t openjaus::environment::RangeSensorConfigurationRecord::getSensorID

(

void

)

getSensorState()

SensorStateEnumeration::SensorStateEnum openjaus::environment::RangeSensorConfigurationRecord::getSensorState

(

void

)

getSensorStateToString()

std::string openjaus::environment::RangeSensorConfigurationRecord::getSensorStateToString

(

void

)

getUpdateRate_Hz()

double openjaus::environment::RangeSensorConfigurationRecord::getUpdateRate_Hz

(

void

)

getVerticalFieldOfViewStartAngle_rad()

double openjaus::environment::RangeSensorConfigurationRecord::getVerticalFieldOfViewStartAngle_rad

(

void

)

getVerticalFieldOfViewStopAngle_rad()

double openjaus::environment::RangeSensorConfigurationRecord::getVerticalFieldOfViewStopAngle_rad

(

void

)

isHorizontalFieldOfViewStartAngleEnabled()

bool openjaus::environment::RangeSensorConfigurationRecord::isHorizontalFieldOfViewStartAngleEnabled

(

void

)

const

isHorizontalFieldOfViewStopAngleEnabled()

bool openjaus::environment::RangeSensorConfigurationRecord::isHorizontalFieldOfViewStopAngleEnabled

(

void

)

const

isMaximumRangeEnabled()

bool openjaus::environment::RangeSensorConfigurationRecord::isMaximumRangeEnabled

(

void

)

const

isMinimumRangeEnabled()

bool openjaus::environment::RangeSensorConfigurationRecord::isMinimumRangeEnabled

(

void

)

const

isSensorStateEnabled()

bool openjaus::environment::RangeSensorConfigurationRecord::isSensorStateEnabled

(

void

)

const

isUpdateRateEnabled()

bool openjaus::environment::RangeSensorConfigurationRecord::isUpdateRateEnabled

(

void

)

const

isVerticalFieldOfViewStartAngleEnabled()

bool openjaus::environment::RangeSensorConfigurationRecord::isVerticalFieldOfViewStartAngleEnabled

(

void

)

const

isVerticalFieldOfViewStopAngleEnabled()

bool openjaus::environment::RangeSensorConfigurationRecord::isVerticalFieldOfViewStopAngleEnabled

(

void

)

const

length()

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

virtual

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

setHorizontalFieldOfViewStartAngle_rad()

bool openjaus::environment::RangeSensorConfigurationRecord::setHorizontalFieldOfViewStartAngle_rad

(

double

value

)

setHorizontalFieldOfViewStopAngle_rad()

bool openjaus::environment::RangeSensorConfigurationRecord::setHorizontalFieldOfViewStopAngle_rad

(

double

value

)

setMaximumRange_m()

bool openjaus::environment::RangeSensorConfigurationRecord::setMaximumRange_m

(

double

value

)

setMinimumRange_m()

bool openjaus::environment::RangeSensorConfigurationRecord::setMinimumRange_m

(

double

value

)

setPresenceVector()

void openjaus::environment::RangeSensorConfigurationRecord::setPresenceVector

(

uint16_t

value

)

setSensorID()

bool openjaus::environment::RangeSensorConfigurationRecord::setSensorID

(

uint16_t

value

)

setSensorState()

bool openjaus::environment::RangeSensorConfigurationRecord::setSensorState

(

SensorStateEnumeration::SensorStateEnum

value

)

setUpdateRate_Hz()

bool openjaus::environment::RangeSensorConfigurationRecord::setUpdateRate_Hz

(

double

value

)

setVerticalFieldOfViewStartAngle_rad()

bool openjaus::environment::RangeSensorConfigurationRecord::setVerticalFieldOfViewStartAngle_rad

(

double

value

)

setVerticalFieldOfViewStopAngle_rad()

bool openjaus::environment::RangeSensorConfigurationRecord::setVerticalFieldOfViewStopAngle_rad

(

double

value

)

to()

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

virtual

Parameters

dst

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

toXml()

std::string openjaus::environment::RangeSensorConfigurationRecord::toXml

(

unsigned char

ojIndentLevel = 0

)

const

Member Data Documentation

horizontalFieldOfViewStartAngle_rad

HorizontalFieldOfViewStartAngleScaledInteger openjaus::environment::RangeSensorConfigurationRecord::horizontalFieldOfViewStartAngle_rad

protected

horizontalFieldOfViewStopAngle_rad

HorizontalFieldOfViewStopAngleScaledInteger openjaus::environment::RangeSensorConfigurationRecord::horizontalFieldOfViewStopAngle_rad

protected

maximumRange_m

MaximumRangeScaledInteger openjaus::environment::RangeSensorConfigurationRecord::maximumRange_m

protected

minimumRange_m

MinimumRangeScaledInteger openjaus::environment::RangeSensorConfigurationRecord::minimumRange_m

protected

presenceVector

uint16_t openjaus::environment::RangeSensorConfigurationRecord::presenceVector

protected

PV_ALL_FIELDS

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

static

PV_HORIZONTALFIELDOFVIEWSTARTANGLE

const uint16_t openjaus::environment::RangeSensorConfigurationRecord::PV_HORIZONTALFIELDOFVIEWSTARTANGLE = 0x1

static

PV_HORIZONTALFIELDOFVIEWSTOPANGLE

const uint16_t openjaus::environment::RangeSensorConfigurationRecord::PV_HORIZONTALFIELDOFVIEWSTOPANGLE = 0x2

static

PV_MAXIMUMRANGE

const uint16_t openjaus::environment::RangeSensorConfigurationRecord::PV_MAXIMUMRANGE = 0x40

static

PV_MINIMUMRANGE

const uint16_t openjaus::environment::RangeSensorConfigurationRecord::PV_MINIMUMRANGE = 0x20

static

PV_NO_FIELDS

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

static

PV_SENSORSTATE

const uint16_t openjaus::environment::RangeSensorConfigurationRecord::PV_SENSORSTATE = 0x80

static

PV_UPDATERATE

const uint16_t openjaus::environment::RangeSensorConfigurationRecord::PV_UPDATERATE = 0x10

static

PV_VERTICALFIELDOFVIEWSTARTANGLE

const uint16_t openjaus::environment::RangeSensorConfigurationRecord::PV_VERTICALFIELDOFVIEWSTARTANGLE = 0x4

static

PV_VERTICALFIELDOFVIEWSTOPANGLE

const uint16_t openjaus::environment::RangeSensorConfigurationRecord::PV_VERTICALFIELDOFVIEWSTOPANGLE = 0x8

static

sensorID

model::fields::UnsignedShort openjaus::environment::RangeSensorConfigurationRecord::sensorID

protected

sensorState

SensorStateEnumeration openjaus::environment::RangeSensorConfigurationRecord::sensorState

protected

updateRate_Hz

UpdateRateScaledInteger openjaus::environment::RangeSensorConfigurationRecord::updateRate_Hz

protected

verticalFieldOfViewStartAngle_rad

VerticalFieldOfViewStartAngleScaledInteger openjaus::environment::RangeSensorConfigurationRecord::verticalFieldOfViewStartAngle_rad

protected

verticalFieldOfViewStopAngle_rad

VerticalFieldOfViewStopAngleScaledInteger openjaus::environment::RangeSensorConfigurationRecord::verticalFieldOfViewStopAngle_rad

protected

---

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

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