OpenJAUS Software Development Kit  4.3.1
Public Member Functions | Static Public Attributes | Protected Attributes | List of all members
openjaus::environment::RangeSensorDataPointRecord Class Reference

#include <RangeSensorDataPointRecord.h>

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

Public Member Functions

 RangeSensorDataPointRecord ()
 
 RangeSensorDataPointRecord (const RangeSensorDataPointRecord &source)
 
 ~RangeSensorDataPointRecord ()
 
void copy (RangeSensorDataPointRecord &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 isPointIDEnabled (void) const
 
void enablePointID (void)
 
void disablePointID (void)
 
bool isRangeValidityEnabled (void) const
 
void enableRangeValidity (void)
 
void disableRangeValidity (void)
 
bool isRangeErrorRMSEnabled (void) const
 
void enableRangeErrorRMS (void)
 
void disableRangeErrorRMS (void)
 
bool isBearingValidityEnabled (void) const
 
void enableBearingValidity (void)
 
void disableBearingValidity (void)
 
bool isBearingErrorRMSEnabled (void) const
 
void enableBearingErrorRMS (void)
 
void disableBearingErrorRMS (void)
 
bool isInclinationValidityEnabled (void) const
 
void enableInclinationValidity (void)
 
void disableInclinationValidity (void)
 
bool isInclinationErrorRMSEnabled (void) const
 
void enableInclinationErrorRMS (void)
 
void disableInclinationErrorRMS (void)
 
uint32_t getPointID (void)
 
bool setPointID (uint32_t value)
 
double getRange_m (void)
 
bool setRange_m (double value)
 
RangeValidityEnumeration::RangeValidityEnum getRangeValidity (void)
 
bool setRangeValidity (RangeValidityEnumeration::RangeValidityEnum value)
 
std::string getRangeValidityToString (void)
 
double getRangeErrorRMS_m (void)
 
bool setRangeErrorRMS_m (double value)
 
double getBearing_rad (void)
 
bool setBearing_rad (double value)
 
BearingValidityEnumeration::BearingValidityEnum getBearingValidity (void)
 
bool setBearingValidity (BearingValidityEnumeration::BearingValidityEnum value)
 
std::string getBearingValidityToString (void)
 
double getBearingErrorRMS_rad (void)
 
bool setBearingErrorRMS_rad (double value)
 
double getInclination_rad (void)
 
bool setInclination_rad (double value)
 
InclinationValidityEnumeration::InclinationValidityEnum getInclinationValidity (void)
 
bool setInclinationValidity (InclinationValidityEnumeration::InclinationValidityEnum value)
 
std::string getInclinationValidityToString (void)
 
double getInclinationErrorRMS_rad (void)
 
bool setInclinationErrorRMS_rad (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 uint16_t PV_ALL_FIELDS = 0xFFFF
 
static const uint16_t PV_NO_FIELDS = 0x0
 
static const uint16_t PV_POINTID = 0x1
 
static const uint16_t PV_RANGEVALIDITY = 0x2
 
static const uint16_t PV_RANGEERRORRMS = 0x4
 
static const uint16_t PV_BEARINGVALIDITY = 0x8
 
static const uint16_t PV_BEARINGERRORRMS = 0x10
 
static const uint16_t PV_INCLINATIONVALIDITY = 0x20
 
static const uint16_t PV_INCLINATIONERRORRMS = 0x40
 

Protected Attributes

model::fields::UnsignedInteger pointID
 
RangeScaledInteger range_m
 
RangeValidityEnumeration rangeValidity
 
RangeErrorRMSScaledInteger rangeErrorRMS_m
 
BearingScaledInteger bearing_rad
 
BearingValidityEnumeration bearingValidity
 
BearingErrorRMSScaledInteger bearingErrorRMS_rad
 
InclinationScaledInteger inclination_rad
 
InclinationValidityEnumeration inclinationValidity
 
InclinationErrorRMSScaledInteger inclinationErrorRMS_rad
 
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

§ RangeSensorDataPointRecord() [1/2]

openjaus::environment::RangeSensorDataPointRecord::RangeSensorDataPointRecord ( )

§ RangeSensorDataPointRecord() [2/2]

openjaus::environment::RangeSensorDataPointRecord::RangeSensorDataPointRecord ( const RangeSensorDataPointRecord source)

§ ~RangeSensorDataPointRecord()

openjaus::environment::RangeSensorDataPointRecord::~RangeSensorDataPointRecord ( )

Member Function Documentation

§ copy()

void openjaus::environment::RangeSensorDataPointRecord::copy ( RangeSensorDataPointRecord source)

§ disableBearingErrorRMS()

void openjaus::environment::RangeSensorDataPointRecord::disableBearingErrorRMS ( void  )

§ disableBearingValidity()

void openjaus::environment::RangeSensorDataPointRecord::disableBearingValidity ( void  )

§ disableInclinationErrorRMS()

void openjaus::environment::RangeSensorDataPointRecord::disableInclinationErrorRMS ( void  )

§ disableInclinationValidity()

void openjaus::environment::RangeSensorDataPointRecord::disableInclinationValidity ( void  )

§ disablePointID()

void openjaus::environment::RangeSensorDataPointRecord::disablePointID ( void  )

§ disableRangeErrorRMS()

void openjaus::environment::RangeSensorDataPointRecord::disableRangeErrorRMS ( void  )

§ disableRangeValidity()

void openjaus::environment::RangeSensorDataPointRecord::disableRangeValidity ( void  )

§ enableBearingErrorRMS()

void openjaus::environment::RangeSensorDataPointRecord::enableBearingErrorRMS ( void  )

§ enableBearingValidity()

void openjaus::environment::RangeSensorDataPointRecord::enableBearingValidity ( void  )

§ enableInclinationErrorRMS()

void openjaus::environment::RangeSensorDataPointRecord::enableInclinationErrorRMS ( void  )

§ enableInclinationValidity()

void openjaus::environment::RangeSensorDataPointRecord::enableInclinationValidity ( void  )

§ enablePointID()

void openjaus::environment::RangeSensorDataPointRecord::enablePointID ( void  )

§ enableRangeErrorRMS()

void openjaus::environment::RangeSensorDataPointRecord::enableRangeErrorRMS ( void  )

§ enableRangeValidity()

void openjaus::environment::RangeSensorDataPointRecord::enableRangeValidity ( void  )

§ from()

int openjaus::environment::RangeSensorDataPointRecord::from ( system::Buffer src)
virtual
Parameters
src

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

§ getBearing_rad()

double openjaus::environment::RangeSensorDataPointRecord::getBearing_rad ( void  )

§ getBearingErrorRMS_rad()

double openjaus::environment::RangeSensorDataPointRecord::getBearingErrorRMS_rad ( void  )

§ getBearingValidity()

BearingValidityEnumeration::BearingValidityEnum openjaus::environment::RangeSensorDataPointRecord::getBearingValidity ( void  )

§ getBearingValidityToString()

std::string openjaus::environment::RangeSensorDataPointRecord::getBearingValidityToString ( void  )

§ getInclination_rad()

double openjaus::environment::RangeSensorDataPointRecord::getInclination_rad ( void  )

§ getInclinationErrorRMS_rad()

double openjaus::environment::RangeSensorDataPointRecord::getInclinationErrorRMS_rad ( void  )

§ getInclinationValidity()

InclinationValidityEnumeration::InclinationValidityEnum openjaus::environment::RangeSensorDataPointRecord::getInclinationValidity ( void  )

§ getInclinationValidityToString()

std::string openjaus::environment::RangeSensorDataPointRecord::getInclinationValidityToString ( void  )

§ getPointID()

uint32_t openjaus::environment::RangeSensorDataPointRecord::getPointID ( void  )

§ getPresenceVector()

uint16_t openjaus::environment::RangeSensorDataPointRecord::getPresenceVector ( void  ) const

§ getRange_m()

double openjaus::environment::RangeSensorDataPointRecord::getRange_m ( void  )

§ getRangeErrorRMS_m()

double openjaus::environment::RangeSensorDataPointRecord::getRangeErrorRMS_m ( void  )

§ getRangeValidity()

RangeValidityEnumeration::RangeValidityEnum openjaus::environment::RangeSensorDataPointRecord::getRangeValidity ( void  )

§ getRangeValidityToString()

std::string openjaus::environment::RangeSensorDataPointRecord::getRangeValidityToString ( void  )

§ isBearingErrorRMSEnabled()

bool openjaus::environment::RangeSensorDataPointRecord::isBearingErrorRMSEnabled ( void  ) const

§ isBearingValidityEnabled()

bool openjaus::environment::RangeSensorDataPointRecord::isBearingValidityEnabled ( void  ) const

§ isInclinationErrorRMSEnabled()

bool openjaus::environment::RangeSensorDataPointRecord::isInclinationErrorRMSEnabled ( void  ) const

§ isInclinationValidityEnabled()

bool openjaus::environment::RangeSensorDataPointRecord::isInclinationValidityEnabled ( void  ) const

§ isPointIDEnabled()

bool openjaus::environment::RangeSensorDataPointRecord::isPointIDEnabled ( void  ) const

§ isRangeErrorRMSEnabled()

bool openjaus::environment::RangeSensorDataPointRecord::isRangeErrorRMSEnabled ( void  ) const

§ isRangeValidityEnabled()

bool openjaus::environment::RangeSensorDataPointRecord::isRangeValidityEnabled ( void  ) const

§ length()

int openjaus::environment::RangeSensorDataPointRecord::length ( void  )
virtual

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

§ setBearing_rad()

bool openjaus::environment::RangeSensorDataPointRecord::setBearing_rad ( double  value)

§ setBearingErrorRMS_rad()

bool openjaus::environment::RangeSensorDataPointRecord::setBearingErrorRMS_rad ( double  value)

§ setBearingValidity()

bool openjaus::environment::RangeSensorDataPointRecord::setBearingValidity ( BearingValidityEnumeration::BearingValidityEnum  value)

§ setInclination_rad()

bool openjaus::environment::RangeSensorDataPointRecord::setInclination_rad ( double  value)

§ setInclinationErrorRMS_rad()

bool openjaus::environment::RangeSensorDataPointRecord::setInclinationErrorRMS_rad ( double  value)

§ setInclinationValidity()

bool openjaus::environment::RangeSensorDataPointRecord::setInclinationValidity ( InclinationValidityEnumeration::InclinationValidityEnum  value)

§ setPointID()

bool openjaus::environment::RangeSensorDataPointRecord::setPointID ( uint32_t  value)

§ setPresenceVector()

void openjaus::environment::RangeSensorDataPointRecord::setPresenceVector ( uint16_t  value)

§ setRange_m()

bool openjaus::environment::RangeSensorDataPointRecord::setRange_m ( double  value)

§ setRangeErrorRMS_m()

bool openjaus::environment::RangeSensorDataPointRecord::setRangeErrorRMS_m ( double  value)

§ setRangeValidity()

bool openjaus::environment::RangeSensorDataPointRecord::setRangeValidity ( RangeValidityEnumeration::RangeValidityEnum  value)

§ to()

int openjaus::environment::RangeSensorDataPointRecord::to ( system::Buffer dst)
virtual
Parameters
dst

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

§ toXml()

std::string openjaus::environment::RangeSensorDataPointRecord::toXml ( unsigned char  ojIndentLevel = 0) const

Member Data Documentation

§ bearing_rad

BearingScaledInteger openjaus::environment::RangeSensorDataPointRecord::bearing_rad
protected

§ bearingErrorRMS_rad

BearingErrorRMSScaledInteger openjaus::environment::RangeSensorDataPointRecord::bearingErrorRMS_rad
protected

§ bearingValidity

BearingValidityEnumeration openjaus::environment::RangeSensorDataPointRecord::bearingValidity
protected

§ inclination_rad

InclinationScaledInteger openjaus::environment::RangeSensorDataPointRecord::inclination_rad
protected

§ inclinationErrorRMS_rad

InclinationErrorRMSScaledInteger openjaus::environment::RangeSensorDataPointRecord::inclinationErrorRMS_rad
protected

§ inclinationValidity

InclinationValidityEnumeration openjaus::environment::RangeSensorDataPointRecord::inclinationValidity
protected

§ pointID

model::fields::UnsignedInteger openjaus::environment::RangeSensorDataPointRecord::pointID
protected

§ presenceVector

uint16_t openjaus::environment::RangeSensorDataPointRecord::presenceVector
protected

§ PV_ALL_FIELDS

const uint16_t openjaus::environment::RangeSensorDataPointRecord::PV_ALL_FIELDS = 0xFFFF
static

§ PV_BEARINGERRORRMS

const uint16_t openjaus::environment::RangeSensorDataPointRecord::PV_BEARINGERRORRMS = 0x10
static

§ PV_BEARINGVALIDITY

const uint16_t openjaus::environment::RangeSensorDataPointRecord::PV_BEARINGVALIDITY = 0x8
static

§ PV_INCLINATIONERRORRMS

const uint16_t openjaus::environment::RangeSensorDataPointRecord::PV_INCLINATIONERRORRMS = 0x40
static

§ PV_INCLINATIONVALIDITY

const uint16_t openjaus::environment::RangeSensorDataPointRecord::PV_INCLINATIONVALIDITY = 0x20
static

§ PV_NO_FIELDS

const uint16_t openjaus::environment::RangeSensorDataPointRecord::PV_NO_FIELDS = 0x0
static

§ PV_POINTID

const uint16_t openjaus::environment::RangeSensorDataPointRecord::PV_POINTID = 0x1
static

§ PV_RANGEERRORRMS

const uint16_t openjaus::environment::RangeSensorDataPointRecord::PV_RANGEERRORRMS = 0x4
static

§ PV_RANGEVALIDITY

const uint16_t openjaus::environment::RangeSensorDataPointRecord::PV_RANGEVALIDITY = 0x2
static

§ range_m

RangeScaledInteger openjaus::environment::RangeSensorDataPointRecord::range_m
protected

§ rangeErrorRMS_m

RangeErrorRMSScaledInteger openjaus::environment::RangeSensorDataPointRecord::rangeErrorRMS_m
protected

§ rangeValidity

RangeValidityEnumeration openjaus::environment::RangeSensorDataPointRecord::rangeValidity
protected

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