openjaus::environment_v1_0::RangeSensorErrorCodeEnumeration Class Reference

#include <RangeSensorErrorCodeEnumeration.h>

Inherits openjaus::model::fields::Enumeration.

Public Types
enum	RangeSensorErrorCodeEnum {   UNKNOWN_SENSOR_ID = 0, INVALID_HORIZONTAL_FIELD_OF_VIEW = 1, INVALID_VERTICAL_FIELD_OF_VIEW = 2, INVALID_UPDATE_RATE = 3,   INVALID_SENSOR_RANGE = 4, INVALID_SENSOR_STATE = 5, MULTIPLE_INVALID_PARAMETERS = 6, UNKNOWN_ERROR_OR_FAULT = 255 }

Public Member Functions
	RangeSensorErrorCodeEnumeration ()
	RangeSensorErrorCodeEnumeration (RangeSensorErrorCodeEnum value)
	~RangeSensorErrorCodeEnumeration ()
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
std::string	toString () const
RangeSensorErrorCodeEnum	getValue (void) const
void	setValue (RangeSensorErrorCodeEnum value)
Public Member Functions inherited from openjaus::model::fields::Enumeration
	Enumeration ()
virtual	~Enumeration ()
long	getValue () const
	Accessor to get the value of value. More...
bool	setValue (long value)
	Accessor to set value of value. More...
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 Member Functions
static std::string	toString (RangeSensorErrorCodeEnum value)

Protected Attributes
RangeSensorErrorCodeEnum	value
Protected Attributes inherited from openjaus::model::fields::Enumeration
long	value
Protected Attributes inherited from openjaus::model::fields::Field
std::string	name

Member Enumeration Documentation

RangeSensorErrorCodeEnum

enum openjaus::environment_v1_0::RangeSensorErrorCodeEnumeration::RangeSensorErrorCodeEnum

Enumerator
UNKNOWN_SENSOR_ID
INVALID_HORIZONTAL_FIELD_OF_VIEW
INVALID_VERTICAL_FIELD_OF_VIEW
INVALID_UPDATE_RATE
INVALID_SENSOR_RANGE
INVALID_SENSOR_STATE
MULTIPLE_INVALID_PARAMETERS
UNKNOWN_ERROR_OR_FAULT

Constructor & Destructor Documentation

RangeSensorErrorCodeEnumeration() [1/2]

openjaus::environment_v1_0::RangeSensorErrorCodeEnumeration::RangeSensorErrorCodeEnumeration

(

)

RangeSensorErrorCodeEnumeration() [2/2]

openjaus::environment_v1_0::RangeSensorErrorCodeEnumeration::RangeSensorErrorCodeEnumeration

(

RangeSensorErrorCodeEnumeration::RangeSensorErrorCodeEnum

value

)

~RangeSensorErrorCodeEnumeration()

openjaus::environment_v1_0::RangeSensorErrorCodeEnumeration::~RangeSensorErrorCodeEnumeration

(

)

Member Function Documentation

from()

uint64 openjaus::environment_v1_0::RangeSensorErrorCodeEnumeration::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::Enumeration.

getValue()

RangeSensorErrorCodeEnumeration::RangeSensorErrorCodeEnum openjaus::environment_v1_0::RangeSensorErrorCodeEnumeration::getValue

(

void

)

const

length()

uint64 openjaus::environment_v1_0::RangeSensorErrorCodeEnumeration::length ( void  ) const

virtual

Reimplemented from openjaus::model::fields::Enumeration.

setValue()

void openjaus::environment_v1_0::RangeSensorErrorCodeEnumeration::setValue

(

RangeSensorErrorCodeEnumeration::RangeSensorErrorCodeEnum

value

)

to()

uint64 openjaus::environment_v1_0::RangeSensorErrorCodeEnumeration::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::Enumeration.

toString() [1/2]

std::string openjaus::environment_v1_0::RangeSensorErrorCodeEnumeration::toString ( ) const

virtual

Reimplemented from openjaus::model::fields::Enumeration.

toString() [2/2]

std::string openjaus::environment_v1_0::RangeSensorErrorCodeEnumeration::toString ( RangeSensorErrorCodeEnumeration::RangeSensorErrorCodeEnum  value )

static

toXml()

std::string openjaus::environment_v1_0::RangeSensorErrorCodeEnumeration::toXml

(

unsigned char

ojIndentLevel = 0

)

const

Member Data Documentation

value

RangeSensorErrorCodeEnum openjaus::environment_v1_0::RangeSensorErrorCodeEnumeration::value

protected

---

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

• include/openjaus/environment_v1_0/Triggers/Fields/RangeSensorErrorCodeEnumeration.h
• src/openjaus/environment_v1_0/Triggers/Fields/RangeSensorErrorCodeEnumeration.cpp