OpenJAUS SAE SDK  6.0.0
Public Member Functions | Protected Attributes | Static Protected Attributes | List of all members
openjaus::environment_v1_0::WhiteBalanceBitField Class Reference

#include <WhiteBalanceBitField.h>

Inherits openjaus::model::fields::BitField.

Public Member Functions

 WhiteBalanceBitField ()
 
 ~WhiteBalanceBitField ()
 
bool setAutoWhiteBalance (bool value)
 
bool getAutoWhiteBalance (void) const
 
bool setDaylight (bool value)
 
bool getDaylight (void) const
 
bool setCloudy (bool value)
 
bool getCloudy (void) const
 
bool setShade (bool value)
 
bool getShade (void) const
 
bool setTungsten (bool value)
 
bool getTungsten (void) const
 
bool setFlurescent (bool value)
 
bool getFlurescent (void) const
 
bool setFlash (bool value)
 
bool getFlash (void) const
 
uint8_t getIntegerValue (void) const
 
void setIntegerValue (uint8_t value)
 
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...
 
void copy (WhiteBalanceBitField &source)
 
std::string toXml (unsigned char ojIndentLevel=0) const
 
- Public Member Functions inherited from openjaus::model::fields::BitField
 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 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

bool autoWhiteBalance
 
bool daylight
 
bool cloudy
 
bool shade
 
bool tungsten
 
bool flurescent
 
bool flash
 
- Protected Attributes inherited from openjaus::model::fields::BitField
long defaultValue
 
uint64_t value
 
TypesUnsigned size
 
std::vector< BitFieldItem *> items
 
- Protected Attributes inherited from openjaus::model::fields::Field
std::string name
 

Static Protected Attributes

static const long AUTOWHITEBALANCE_START_BIT = 0
 
static const long AUTOWHITEBALANCE_BIT_MASK = 0x1
 
static const long DAYLIGHT_START_BIT = 1
 
static const long DAYLIGHT_BIT_MASK = 0x1
 
static const long CLOUDY_START_BIT = 2
 
static const long CLOUDY_BIT_MASK = 0x1
 
static const long SHADE_START_BIT = 3
 
static const long SHADE_BIT_MASK = 0x1
 
static const long TUNGSTEN_START_BIT = 4
 
static const long TUNGSTEN_BIT_MASK = 0x1
 
static const long FLURESCENT_START_BIT = 5
 
static const long FLURESCENT_BIT_MASK = 0x1
 
static const long FLASH_START_BIT = 6
 
static const long FLASH_BIT_MASK = 0x1
 

Constructor & Destructor Documentation

◆ WhiteBalanceBitField()

openjaus::environment_v1_0::WhiteBalanceBitField::WhiteBalanceBitField ( )

◆ ~WhiteBalanceBitField()

openjaus::environment_v1_0::WhiteBalanceBitField::~WhiteBalanceBitField ( )

Member Function Documentation

◆ copy()

void openjaus::environment_v1_0::WhiteBalanceBitField::copy ( WhiteBalanceBitField &  source)

◆ from()

uint64 openjaus::environment_v1_0::WhiteBalanceBitField::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::BitField.

◆ getAutoWhiteBalance()

bool openjaus::environment_v1_0::WhiteBalanceBitField::getAutoWhiteBalance ( void  ) const

◆ getCloudy()

bool openjaus::environment_v1_0::WhiteBalanceBitField::getCloudy ( void  ) const

◆ getDaylight()

bool openjaus::environment_v1_0::WhiteBalanceBitField::getDaylight ( void  ) const

◆ getFlash()

bool openjaus::environment_v1_0::WhiteBalanceBitField::getFlash ( void  ) const

◆ getFlurescent()

bool openjaus::environment_v1_0::WhiteBalanceBitField::getFlurescent ( void  ) const

◆ getIntegerValue()

uint8_t openjaus::environment_v1_0::WhiteBalanceBitField::getIntegerValue ( void  ) const

◆ getShade()

bool openjaus::environment_v1_0::WhiteBalanceBitField::getShade ( void  ) const

◆ getTungsten()

bool openjaus::environment_v1_0::WhiteBalanceBitField::getTungsten ( void  ) const

◆ length()

uint64 openjaus::environment_v1_0::WhiteBalanceBitField::length ( ) const
virtual

Reimplemented from openjaus::model::fields::BitField.

◆ setAutoWhiteBalance()

bool openjaus::environment_v1_0::WhiteBalanceBitField::setAutoWhiteBalance ( bool  value)

◆ setCloudy()

bool openjaus::environment_v1_0::WhiteBalanceBitField::setCloudy ( bool  value)

◆ setDaylight()

bool openjaus::environment_v1_0::WhiteBalanceBitField::setDaylight ( bool  value)

◆ setFlash()

bool openjaus::environment_v1_0::WhiteBalanceBitField::setFlash ( bool  value)

◆ setFlurescent()

bool openjaus::environment_v1_0::WhiteBalanceBitField::setFlurescent ( bool  value)

◆ setIntegerValue()

void openjaus::environment_v1_0::WhiteBalanceBitField::setIntegerValue ( uint8_t  value)

◆ setShade()

bool openjaus::environment_v1_0::WhiteBalanceBitField::setShade ( bool  value)

◆ setTungsten()

bool openjaus::environment_v1_0::WhiteBalanceBitField::setTungsten ( bool  value)

◆ to()

uint64 openjaus::environment_v1_0::WhiteBalanceBitField::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::BitField.

◆ toXml()

std::string openjaus::environment_v1_0::WhiteBalanceBitField::toXml ( unsigned char  ojIndentLevel = 0) const

Member Data Documentation

◆ autoWhiteBalance

bool openjaus::environment_v1_0::WhiteBalanceBitField::autoWhiteBalance
protected

◆ AUTOWHITEBALANCE_BIT_MASK

const long openjaus::environment_v1_0::WhiteBalanceBitField::AUTOWHITEBALANCE_BIT_MASK = 0x1
staticprotected

◆ AUTOWHITEBALANCE_START_BIT

const long openjaus::environment_v1_0::WhiteBalanceBitField::AUTOWHITEBALANCE_START_BIT = 0
staticprotected

◆ cloudy

bool openjaus::environment_v1_0::WhiteBalanceBitField::cloudy
protected

◆ CLOUDY_BIT_MASK

const long openjaus::environment_v1_0::WhiteBalanceBitField::CLOUDY_BIT_MASK = 0x1
staticprotected

◆ CLOUDY_START_BIT

const long openjaus::environment_v1_0::WhiteBalanceBitField::CLOUDY_START_BIT = 2
staticprotected

◆ daylight

bool openjaus::environment_v1_0::WhiteBalanceBitField::daylight
protected

◆ DAYLIGHT_BIT_MASK

const long openjaus::environment_v1_0::WhiteBalanceBitField::DAYLIGHT_BIT_MASK = 0x1
staticprotected

◆ DAYLIGHT_START_BIT

const long openjaus::environment_v1_0::WhiteBalanceBitField::DAYLIGHT_START_BIT = 1
staticprotected

◆ flash

bool openjaus::environment_v1_0::WhiteBalanceBitField::flash
protected

◆ FLASH_BIT_MASK

const long openjaus::environment_v1_0::WhiteBalanceBitField::FLASH_BIT_MASK = 0x1
staticprotected

◆ FLASH_START_BIT

const long openjaus::environment_v1_0::WhiteBalanceBitField::FLASH_START_BIT = 6
staticprotected

◆ flurescent

bool openjaus::environment_v1_0::WhiteBalanceBitField::flurescent
protected

◆ FLURESCENT_BIT_MASK

const long openjaus::environment_v1_0::WhiteBalanceBitField::FLURESCENT_BIT_MASK = 0x1
staticprotected

◆ FLURESCENT_START_BIT

const long openjaus::environment_v1_0::WhiteBalanceBitField::FLURESCENT_START_BIT = 5
staticprotected

◆ shade

bool openjaus::environment_v1_0::WhiteBalanceBitField::shade
protected

◆ SHADE_BIT_MASK

const long openjaus::environment_v1_0::WhiteBalanceBitField::SHADE_BIT_MASK = 0x1
staticprotected

◆ SHADE_START_BIT

const long openjaus::environment_v1_0::WhiteBalanceBitField::SHADE_START_BIT = 3
staticprotected

◆ tungsten

bool openjaus::environment_v1_0::WhiteBalanceBitField::tungsten
protected

◆ TUNGSTEN_BIT_MASK

const long openjaus::environment_v1_0::WhiteBalanceBitField::TUNGSTEN_BIT_MASK = 0x1
staticprotected

◆ TUNGSTEN_START_BIT

const long openjaus::environment_v1_0::WhiteBalanceBitField::TUNGSTEN_START_BIT = 4
staticprotected
The documentation for this class was generated from the following files: