OpenJAUS Software Development Kit  4.3.1
Public Member Functions | Protected Attributes | Friends | List of all members
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::AddressBitField, openjaus::environment::ExposureModesBitField, openjaus::environment::FocusModesBitField, openjaus::environment::ImagingModesBitField, openjaus::environment::LightSensitivityLevelsBitField, openjaus::environment::MeteringModesBitField, openjaus::environment::SupportedAnalogFormatsBitField, openjaus::environment::SupportedCompressionBitField, openjaus::environment::SupportedDigitalFormatsBitField, openjaus::environment::SupportedFrameSizesBitField, openjaus::environment::SupportedImageFormatsBitField, openjaus::environment::SupportedStatesBitField, openjaus::environment::WhiteBalanceBitField, openjaus::environment::ZoomModesBitField, openjaus::hmi::DCMStateCodeBitField, openjaus::manipulator::ParentIDBitField, openjaus::ugv::AnnunciatorTypesBitField, openjaus::ugv::AnnunciatorTypesEnumBitField, openjaus::ugv::IlluminationTypesBitField, openjaus::ugv::IlluminationTypesEnumBitField, openjaus::ugv::TransferCaseBitField, and openjaus::ugv::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 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 defaultValue
uint64_t value
TypesUnsigned size
std::vector< BitFieldItem *> items
- Protected Attributes inherited from openjaus::model::fields::Field
std::string name


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.

Name (

Constructor & Destructor Documentation

§ BitField()

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

§ ~BitField()

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

Member Function Documentation

§ from()

int openjaus::model::fields::BitField::from ( system::Buffer src)

§ 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()

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

§ setDefaultValue()

bool openjaus::model::fields::BitField::setDefaultValue ( long  defaultValue)
defaultValueThe value of the new defaultValue.

§ setItems()

bool openjaus::model::fields::BitField::setItems ( const BitFieldItem items)
itemsThe value of the new items.

§ setSize()

bool openjaus::model::fields::BitField::setSize ( TypesUnsigned  size)
sizeThe value of the new size.

§ setValue()

bool openjaus::model::fields::BitField::setValue ( uint64_t  value)
valueThe value of the new value.

§ to()

int openjaus::model::fields::BitField::to ( system::Buffer dst)

§ toString()

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

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 

§ operator<< [2/2]

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

Member Data Documentation

§ defaultValue

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

§ items

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

§ size

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

§ value

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

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