openjaus::model::fields::BitField Class Reference

This is a brief description. More...

#include <BitField.h>

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

Inherited by openjaus::core_v1_1::AddressBitField, openjaus::environment_v1_0::ExposureModesBitField, openjaus::environment_v1_0::FocusModesBitField, openjaus::environment_v1_0::ImagingModesBitField, openjaus::environment_v1_0::LightSensitivityLevelsBitField, openjaus::environment_v1_0::MeteringModesBitField, openjaus::environment_v1_0::SupportedAnalogFormatsBitField, openjaus::environment_v1_0::SupportedCompressionBitField, openjaus::environment_v1_0::SupportedDigitalFormatsBitField, openjaus::environment_v1_0::SupportedFrameSizesBitField, openjaus::environment_v1_0::SupportedImageFormatsBitField, openjaus::environment_v1_0::SupportedStatesBitField, openjaus::environment_v1_0::WhiteBalanceBitField, openjaus::environment_v1_0::ZoomModesBitField, openjaus::manipulator_v1_0::ParentIDBitField, openjaus::ugv_v1_0::AnnunciatorTypesBitField, openjaus::ugv_v1_0::AnnunciatorTypesEnumBitField, openjaus::ugv_v1_0::IlluminationTypesBitField, openjaus::ugv_v1_0::IlluminationTypesEnumBitField, openjaus::ugv_v1_0::TransferCaseBitField, and openjaus::ugv_v1_0::TransmissionBitField.

Public Member Functions
	BitField ()
virtual	~BitField ()
long	getDefaultValue () const
	Accessor to get the value of defaultValue. More...
bool	setDefaultValue (long defaultValue)
	Accessor to set value of defaultValue. More...
uint64_t	getValue () const
	Accessor to get the value of value. More...
bool	setValue (uint64_t value)
	Accessor to set value of value. More...
TypesUnsigned	getSize () const
	Accessor to get the value of size. More...
bool	setSize (TypesUnsigned size)
	Accessor to set value of size. More...
const std::vector< BitFieldItem *> &	getItems () const
	Accessor to get the value of items. More...
bool	setItems (const BitFieldItem &items)
	Accessor to set value of items. More...
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 () const
	Gets the serialized length of this object. 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
	Transportable ()
virtual	~Transportable ()

Protected Attributes
long	defaultValue
uint64_t	value
TypesUnsigned	size
std::vector< BitFieldItem *>	items
Protected Attributes inherited from openjaus::model::fields::Field
std::string	name

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

Detailed Description

Detailed description.

Author

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

Constructor & Destructor Documentation

BitField()

openjaus::model::fields::BitField::BitField

(

)

~BitField()

openjaus::model::fields::BitField::~BitField ( )

virtual

Member Function Documentation

from()

uint64 openjaus::model::fields::BitField::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

Implements openjaus::system::Transportable.

Reimplemented in openjaus::environment_v1_0::SupportedFrameSizesBitField, openjaus::ugv_v1_0::IlluminationTypesBitField, openjaus::ugv_v1_0::IlluminationTypesEnumBitField, openjaus::ugv_v1_0::TransmissionBitField, openjaus::environment_v1_0::SupportedImageFormatsBitField, openjaus::ugv_v1_0::TransferCaseBitField, openjaus::environment_v1_0::LightSensitivityLevelsBitField, openjaus::environment_v1_0::SupportedDigitalFormatsBitField, openjaus::environment_v1_0::WhiteBalanceBitField, openjaus::environment_v1_0::SupportedAnalogFormatsBitField, openjaus::ugv_v1_0::AnnunciatorTypesBitField, openjaus::ugv_v1_0::AnnunciatorTypesEnumBitField, openjaus::environment_v1_0::ExposureModesBitField, openjaus::environment_v1_0::ImagingModesBitField, openjaus::environment_v1_0::SupportedCompressionBitField, openjaus::environment_v1_0::ZoomModesBitField, openjaus::core_v1_1::AddressBitField, openjaus::environment_v1_0::MeteringModesBitField, openjaus::environment_v1_0::SupportedStatesBitField, openjaus::manipulator_v1_0::ParentIDBitField, and openjaus::environment_v1_0::FocusModesBitField.

getDefaultValue()

long openjaus::model::fields::BitField::getDefaultValue

(

)

const

getItems()

const std::vector< BitFieldItem *> & openjaus::model::fields::BitField::getItems

(

)

const

getSize()

TypesUnsigned openjaus::model::fields::BitField::getSize

(

)

const

getValue()

uint64_t openjaus::model::fields::BitField::getValue

(

)

const

length()

uint64 openjaus::model::fields::BitField::length ( ) const

virtual

Implements openjaus::system::Transportable.

Reimplemented in openjaus::environment_v1_0::SupportedFrameSizesBitField, openjaus::ugv_v1_0::IlluminationTypesBitField, openjaus::ugv_v1_0::IlluminationTypesEnumBitField, openjaus::ugv_v1_0::TransmissionBitField, openjaus::environment_v1_0::SupportedImageFormatsBitField, openjaus::ugv_v1_0::TransferCaseBitField, openjaus::environment_v1_0::LightSensitivityLevelsBitField, openjaus::environment_v1_0::SupportedDigitalFormatsBitField, openjaus::environment_v1_0::WhiteBalanceBitField, openjaus::environment_v1_0::SupportedAnalogFormatsBitField, openjaus::ugv_v1_0::AnnunciatorTypesBitField, openjaus::ugv_v1_0::AnnunciatorTypesEnumBitField, openjaus::environment_v1_0::ExposureModesBitField, openjaus::environment_v1_0::ImagingModesBitField, openjaus::environment_v1_0::SupportedCompressionBitField, openjaus::environment_v1_0::ZoomModesBitField, openjaus::core_v1_1::AddressBitField, openjaus::environment_v1_0::MeteringModesBitField, openjaus::environment_v1_0::SupportedStatesBitField, openjaus::manipulator_v1_0::ParentIDBitField, and openjaus::environment_v1_0::FocusModesBitField.

setDefaultValue()

bool openjaus::model::fields::BitField::setDefaultValue

(

long

defaultValue

)

Parameters

defaultValue

The value of the new defaultValue.

setItems()

bool openjaus::model::fields::BitField::setItems

(

const BitFieldItem &

items

)

Parameters

items

The value of the new items.

setSize()

bool openjaus::model::fields::BitField::setSize

(

TypesUnsigned

size

)

Parameters

size	The value of the new size.

setValue()

bool openjaus::model::fields::BitField::setValue

(

uint64_t

value

)

Parameters

value

The value of the new value.

to()

uint64 openjaus::model::fields::BitField::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

Implements openjaus::system::Transportable.

Reimplemented in openjaus::environment_v1_0::SupportedFrameSizesBitField, openjaus::ugv_v1_0::IlluminationTypesBitField, openjaus::ugv_v1_0::IlluminationTypesEnumBitField, openjaus::ugv_v1_0::TransmissionBitField, openjaus::environment_v1_0::SupportedImageFormatsBitField, openjaus::ugv_v1_0::TransferCaseBitField, openjaus::environment_v1_0::LightSensitivityLevelsBitField, openjaus::environment_v1_0::SupportedDigitalFormatsBitField, openjaus::environment_v1_0::WhiteBalanceBitField, openjaus::environment_v1_0::SupportedAnalogFormatsBitField, openjaus::ugv_v1_0::AnnunciatorTypesBitField, openjaus::ugv_v1_0::AnnunciatorTypesEnumBitField, openjaus::environment_v1_0::ExposureModesBitField, openjaus::environment_v1_0::ImagingModesBitField, openjaus::environment_v1_0::SupportedCompressionBitField, openjaus::environment_v1_0::ZoomModesBitField, openjaus::core_v1_1::AddressBitField, openjaus::environment_v1_0::MeteringModesBitField, openjaus::environment_v1_0::SupportedStatesBitField, openjaus::manipulator_v1_0::ParentIDBitField, and openjaus::environment_v1_0::FocusModesBitField.

toString()

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

virtual

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

Friends And Related Function Documentation

operator<< [1/2]

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

friend

operator<< [2/2]

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

friend

Member Data Documentation

defaultValue

long openjaus::model::fields::BitField::defaultValue

protected

items

std::vector< BitFieldItem* > openjaus::model::fields::BitField::items

protected

size

TypesUnsigned openjaus::model::fields::BitField::size

protected

value

uint64_t openjaus::model::fields::BitField::value

protected

---

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

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