openjaus::model::fields::Enumeration Class Reference

This is a brief description. More...

#include <Enumeration.h>

Inherits openjaus::model::fields::ComplexField, openjaus::model::fields::Field, and openjaus::system::Transportable.

Inherited by openjaus::core::CommandResultEnumeration, openjaus::core::ConfirmResponseCodeEnumeration, openjaus::core::EmergencyCodeEnumeration, openjaus::core::EventTypeEnumeration, openjaus::core::PreferenceTCPEnumeration, openjaus::core::RejectResponseCodeEnumeration, openjaus::core::ResponseCodeEnumeration, openjaus::core::StatusEnumeration, openjaus::core::SystemLevelEnumeration, openjaus::environment::AnalogFormatEnumeration, openjaus::environment::AnalogVideoErrorCodeEnumeration, openjaus::environment::BearingValidityEnumeration, openjaus::environment::CoordinateTransformationSupportedEnumeration, openjaus::environment::DataCompressionRefEnumeration, openjaus::environment::DataErrorCodeEnumeration, openjaus::environment::DigitalFormatEnumeration, openjaus::environment::DigitalVideoErrorCodeEnumeration, openjaus::environment::ExposureModeEnumeration, openjaus::environment::FocusModeEnumeration, openjaus::environment::FrameSizeRefEnumeration, openjaus::environment::ImageStabilizationEnumeration, openjaus::environment::ImageStablizationEnumeration, openjaus::environment::ImagingModeEnumeration, openjaus::environment::InclinationValidityEnumeration, openjaus::environment::LightSensitivityEnumeration, openjaus::environment::MeteringModeEnumeration, openjaus::environment::RangeSensorErrorCodeEnumeration, openjaus::environment::RangeValidityEnumeration, openjaus::environment::ReportCoordinateSystemRefEnumeration, openjaus::environment::SensorStateEnumeration, openjaus::environment::StillImageErrorCodeEnumeration, openjaus::environment::StillImageFormatEnumeration, openjaus::environment::StreamStateEnumeration, openjaus::environment::VisualSensorErrorCodeEnumeration, openjaus::environment::WhiteBalanceEnumeration, openjaus::environment::ZoomModeEnumeration, openjaus::hmi::AlignmentEnumeration, openjaus::hmi::ButtonEnumeration, openjaus::hmi::DCMStateCodeEnumeration, openjaus::hmi::DigitalControlRecEnumeration, openjaus::hmi::GroupEnumeration, openjaus::hmi::ImageTypeEnumeration, openjaus::hmi::KeyStateEnumeration, openjaus::hmi::PrimitiveDataDefinitionEnumeration, openjaus::hmi::StateEnumeration, openjaus::hmi::ValidEnumeration, openjaus::mobility::AccelerationCommandTypeEnumeration, openjaus::mobility::RejectElementResponseCodeEnumeration, openjaus::mobility::VelocityCommandTypeEnumeration, openjaus::ugv::OdometryTypeEnumeration, openjaus::ugv::PlugStateEnumeration, openjaus::ugv::PowerStateEnumeration, openjaus::ugv::TransferCaseStatesEnumeration, openjaus::ugv::TransmissionStatesEnumeration, and openjaus::ugv::TripTypeEnumeration.

Public Member Functions
	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...
virtual int	to (system::Buffer *dst)
	Operation to. More...
virtual int	from (system::Buffer *src)
	Operation from. More...
virtual int	length ()
	Serializes object to internal transport buffer. 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 ()

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

Friends
OPENJAUS_EXPORT friend std::ostream &	operator<< (std::ostream &output, const Enumeration &object)
OPENJAUS_EXPORT friend std::ostream &	operator<< (std::ostream &output, const Enumeration *object)

Detailed Description

Detailed description.

Author

Name (name@.nosp@m.emai.nosp@m.l.com)

Constructor & Destructor Documentation

Enumeration()

openjaus::model::fields::Enumeration::Enumeration

(

)

~Enumeration()

openjaus::model::fields::Enumeration::~Enumeration ( )

virtual

Member Function Documentation

from()

int openjaus::model::fields::Enumeration::from ( system::Buffer *  src )

virtual

Parameters

src

Implements openjaus::system::Transportable.

Reimplemented in openjaus::core::CommandResultEnumeration, openjaus::core::ConfirmResponseCodeEnumeration, openjaus::core::EmergencyCodeEnumeration, openjaus::core::EventTypeEnumeration, openjaus::core::PreferenceTCPEnumeration, openjaus::core::RejectResponseCodeEnumeration, openjaus::core::ResponseCodeEnumeration, openjaus::core::StatusEnumeration, openjaus::core::SystemLevelEnumeration, openjaus::environment::AnalogFormatEnumeration, openjaus::environment::AnalogVideoErrorCodeEnumeration, openjaus::environment::BearingValidityEnumeration, openjaus::environment::CoordinateTransformationSupportedEnumeration, openjaus::environment::DataCompressionRefEnumeration, openjaus::environment::DataErrorCodeEnumeration, openjaus::environment::DigitalFormatEnumeration, openjaus::environment::DigitalVideoErrorCodeEnumeration, openjaus::environment::ExposureModeEnumeration, openjaus::environment::FocusModeEnumeration, openjaus::environment::FrameSizeRefEnumeration, openjaus::environment::ImageStabilizationEnumeration, openjaus::environment::ImageStablizationEnumeration, openjaus::environment::ImagingModeEnumeration, openjaus::environment::InclinationValidityEnumeration, openjaus::environment::LightSensitivityEnumeration, openjaus::environment::MeteringModeEnumeration, openjaus::environment::RangeSensorErrorCodeEnumeration, openjaus::environment::RangeValidityEnumeration, openjaus::environment::ReportCoordinateSystemRefEnumeration, openjaus::environment::SensorStateEnumeration, openjaus::environment::StillImageErrorCodeEnumeration, openjaus::environment::StillImageFormatEnumeration, openjaus::environment::StreamStateEnumeration, openjaus::environment::VisualSensorErrorCodeEnumeration, openjaus::environment::WhiteBalanceEnumeration, openjaus::environment::ZoomModeEnumeration, openjaus::hmi::AlignmentEnumeration, openjaus::hmi::ButtonEnumeration, openjaus::hmi::DCMStateCodeEnumeration, openjaus::hmi::DigitalControlRecEnumeration, openjaus::hmi::GroupEnumeration, openjaus::hmi::ImageTypeEnumeration, openjaus::hmi::KeyStateEnumeration, openjaus::hmi::PrimitiveDataDefinitionEnumeration, openjaus::hmi::StateEnumeration, openjaus::hmi::ValidEnumeration, openjaus::mobility::AccelerationCommandTypeEnumeration, openjaus::mobility::RejectElementResponseCodeEnumeration, openjaus::mobility::VelocityCommandTypeEnumeration, openjaus::ugv::OdometryTypeEnumeration, openjaus::ugv::PlugStateEnumeration, openjaus::ugv::PowerStateEnumeration, openjaus::ugv::TransferCaseStatesEnumeration, openjaus::ugv::TransmissionStatesEnumeration, and openjaus::ugv::TripTypeEnumeration.

getValue()

long openjaus::model::fields::Enumeration::getValue

(

void

)

const

length()

int openjaus::model::fields::Enumeration::length ( )

virtual

Implements openjaus::system::Transportable.

Reimplemented in openjaus::core::CommandResultEnumeration, openjaus::core::ConfirmResponseCodeEnumeration, openjaus::core::EmergencyCodeEnumeration, openjaus::core::EventTypeEnumeration, openjaus::core::PreferenceTCPEnumeration, openjaus::core::RejectResponseCodeEnumeration, openjaus::core::ResponseCodeEnumeration, openjaus::core::StatusEnumeration, openjaus::core::SystemLevelEnumeration, openjaus::environment::AnalogFormatEnumeration, openjaus::environment::AnalogVideoErrorCodeEnumeration, openjaus::environment::BearingValidityEnumeration, openjaus::environment::CoordinateTransformationSupportedEnumeration, openjaus::environment::DataCompressionRefEnumeration, openjaus::environment::DataErrorCodeEnumeration, openjaus::environment::DigitalFormatEnumeration, openjaus::environment::DigitalVideoErrorCodeEnumeration, openjaus::environment::ExposureModeEnumeration, openjaus::environment::FocusModeEnumeration, openjaus::environment::FrameSizeRefEnumeration, openjaus::environment::ImageStabilizationEnumeration, openjaus::environment::ImageStablizationEnumeration, openjaus::environment::ImagingModeEnumeration, openjaus::environment::InclinationValidityEnumeration, openjaus::environment::LightSensitivityEnumeration, openjaus::environment::MeteringModeEnumeration, openjaus::environment::RangeSensorErrorCodeEnumeration, openjaus::environment::RangeValidityEnumeration, openjaus::environment::ReportCoordinateSystemRefEnumeration, openjaus::environment::SensorStateEnumeration, openjaus::environment::StillImageErrorCodeEnumeration, openjaus::environment::StillImageFormatEnumeration, openjaus::environment::StreamStateEnumeration, openjaus::environment::VisualSensorErrorCodeEnumeration, openjaus::environment::WhiteBalanceEnumeration, openjaus::environment::ZoomModeEnumeration, openjaus::hmi::AlignmentEnumeration, openjaus::hmi::ButtonEnumeration, openjaus::hmi::DCMStateCodeEnumeration, openjaus::hmi::DigitalControlRecEnumeration, openjaus::hmi::GroupEnumeration, openjaus::hmi::ImageTypeEnumeration, openjaus::hmi::KeyStateEnumeration, openjaus::hmi::PrimitiveDataDefinitionEnumeration, openjaus::hmi::StateEnumeration, openjaus::hmi::ValidEnumeration, openjaus::mobility::AccelerationCommandTypeEnumeration, openjaus::mobility::RejectElementResponseCodeEnumeration, openjaus::mobility::VelocityCommandTypeEnumeration, openjaus::ugv::OdometryTypeEnumeration, openjaus::ugv::PlugStateEnumeration, openjaus::ugv::PowerStateEnumeration, openjaus::ugv::TransferCaseStatesEnumeration, openjaus::ugv::TransmissionStatesEnumeration, and openjaus::ugv::TripTypeEnumeration.

setValue()

bool openjaus::model::fields::Enumeration::setValue

(

long

value

)

Parameters

value

The value of the new value.

to()

int openjaus::model::fields::Enumeration::to ( system::Buffer *  dst )

virtual

Parameters

dst

Implements openjaus::system::Transportable.

Reimplemented in openjaus::core::CommandResultEnumeration, openjaus::core::ConfirmResponseCodeEnumeration, openjaus::core::EmergencyCodeEnumeration, openjaus::core::EventTypeEnumeration, openjaus::core::PreferenceTCPEnumeration, openjaus::core::RejectResponseCodeEnumeration, openjaus::core::ResponseCodeEnumeration, openjaus::core::StatusEnumeration, openjaus::core::SystemLevelEnumeration, openjaus::environment::AnalogFormatEnumeration, openjaus::environment::AnalogVideoErrorCodeEnumeration, openjaus::environment::BearingValidityEnumeration, openjaus::environment::CoordinateTransformationSupportedEnumeration, openjaus::environment::DataCompressionRefEnumeration, openjaus::environment::DataErrorCodeEnumeration, openjaus::environment::DigitalFormatEnumeration, openjaus::environment::DigitalVideoErrorCodeEnumeration, openjaus::environment::ExposureModeEnumeration, openjaus::environment::FocusModeEnumeration, openjaus::environment::FrameSizeRefEnumeration, openjaus::environment::ImageStabilizationEnumeration, openjaus::environment::ImageStablizationEnumeration, openjaus::environment::ImagingModeEnumeration, openjaus::environment::InclinationValidityEnumeration, openjaus::environment::LightSensitivityEnumeration, openjaus::environment::MeteringModeEnumeration, openjaus::environment::RangeSensorErrorCodeEnumeration, openjaus::environment::RangeValidityEnumeration, openjaus::environment::ReportCoordinateSystemRefEnumeration, openjaus::environment::SensorStateEnumeration, openjaus::environment::StillImageErrorCodeEnumeration, openjaus::environment::StillImageFormatEnumeration, openjaus::environment::StreamStateEnumeration, openjaus::environment::VisualSensorErrorCodeEnumeration, openjaus::environment::WhiteBalanceEnumeration, openjaus::environment::ZoomModeEnumeration, openjaus::hmi::AlignmentEnumeration, openjaus::hmi::ButtonEnumeration, openjaus::hmi::DCMStateCodeEnumeration, openjaus::hmi::DigitalControlRecEnumeration, openjaus::hmi::GroupEnumeration, openjaus::hmi::ImageTypeEnumeration, openjaus::hmi::KeyStateEnumeration, openjaus::hmi::PrimitiveDataDefinitionEnumeration, openjaus::hmi::StateEnumeration, openjaus::hmi::ValidEnumeration, openjaus::mobility::AccelerationCommandTypeEnumeration, openjaus::mobility::RejectElementResponseCodeEnumeration, openjaus::mobility::VelocityCommandTypeEnumeration, openjaus::ugv::OdometryTypeEnumeration, openjaus::ugv::PlugStateEnumeration, openjaus::ugv::PowerStateEnumeration, openjaus::ugv::TransferCaseStatesEnumeration, openjaus::ugv::TransmissionStatesEnumeration, and openjaus::ugv::TripTypeEnumeration.

toString()

std::string openjaus::model::fields::Enumeration::toString ( ) const

virtual

Reimplemented from openjaus::model::fields::Field.

Reimplemented in openjaus::core::CommandResultEnumeration, openjaus::core::ConfirmResponseCodeEnumeration, openjaus::core::EmergencyCodeEnumeration, openjaus::core::EventTypeEnumeration, openjaus::core::PreferenceTCPEnumeration, openjaus::core::RejectResponseCodeEnumeration, openjaus::core::ResponseCodeEnumeration, openjaus::core::StatusEnumeration, openjaus::core::SystemLevelEnumeration, openjaus::environment::AnalogFormatEnumeration, openjaus::environment::AnalogVideoErrorCodeEnumeration, openjaus::environment::BearingValidityEnumeration, openjaus::environment::CoordinateTransformationSupportedEnumeration, openjaus::environment::DataCompressionRefEnumeration, openjaus::environment::DataErrorCodeEnumeration, openjaus::environment::DigitalFormatEnumeration, openjaus::environment::DigitalVideoErrorCodeEnumeration, openjaus::environment::ExposureModeEnumeration, openjaus::environment::FocusModeEnumeration, openjaus::environment::FrameSizeRefEnumeration, openjaus::environment::ImageStabilizationEnumeration, openjaus::environment::ImageStablizationEnumeration, openjaus::environment::ImagingModeEnumeration, openjaus::environment::InclinationValidityEnumeration, openjaus::environment::LightSensitivityEnumeration, openjaus::environment::MeteringModeEnumeration, openjaus::environment::RangeSensorErrorCodeEnumeration, openjaus::environment::RangeValidityEnumeration, openjaus::environment::ReportCoordinateSystemRefEnumeration, openjaus::environment::SensorStateEnumeration, openjaus::environment::StillImageErrorCodeEnumeration, openjaus::environment::StillImageFormatEnumeration, openjaus::environment::StreamStateEnumeration, openjaus::environment::VisualSensorErrorCodeEnumeration, openjaus::environment::WhiteBalanceEnumeration, openjaus::environment::ZoomModeEnumeration, openjaus::hmi::AlignmentEnumeration, openjaus::hmi::ButtonEnumeration, openjaus::hmi::DCMStateCodeEnumeration, openjaus::hmi::DigitalControlRecEnumeration, openjaus::hmi::GroupEnumeration, openjaus::hmi::ImageTypeEnumeration, openjaus::hmi::KeyStateEnumeration, openjaus::hmi::PrimitiveDataDefinitionEnumeration, openjaus::hmi::StateEnumeration, openjaus::hmi::ValidEnumeration, openjaus::mobility::AccelerationCommandTypeEnumeration, openjaus::mobility::RejectElementResponseCodeEnumeration, openjaus::mobility::VelocityCommandTypeEnumeration, openjaus::ugv::OdometryTypeEnumeration, openjaus::ugv::PlugStateEnumeration, openjaus::ugv::PowerStateEnumeration, openjaus::ugv::TransferCaseStatesEnumeration, openjaus::ugv::TransmissionStatesEnumeration, and openjaus::ugv::TripTypeEnumeration.

Friends And Related Function Documentation

operator<< [1/2]

OPENJAUS_EXPORT friend std::ostream& operator<< ( std::ostream &  output, const Enumeration &  object  )

friend

operator<< [2/2]

OPENJAUS_EXPORT friend std::ostream& operator<< ( std::ostream &  output, const Enumeration *  object  )

friend

Member Data Documentation

value

long openjaus::model::fields::Enumeration::value

protected

---

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

• include/openjaus/model/fields/Enumeration.h
• src/openjaus/model/fields/Enumeration.cpp