#include <ImagingModesBitField.h>

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

Public Member Functions
	ImagingModesBitField ()

	~ImagingModesBitField ()

bool	setColor (bool value)

bool	getColor (void) const

bool	setGreyscale (bool value)

bool	getGreyscale (void) const

bool	setInfrared (bool value)

bool	getInfrared (void) const

bool	setLowlight (bool value)

bool	getLowlight (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 (ImagingModesBitField &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	color

bool	greyscale

bool	infrared

bool	lowlight

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	COLOR_START_BIT = 0

static const long	COLOR_BIT_MASK = 0x1

static const long	GREYSCALE_START_BIT = 1

static const long	GREYSCALE_BIT_MASK = 0x1

static const long	INFRARED_START_BIT = 2

static const long	INFRARED_BIT_MASK = 0x1

static const long	LOWLIGHT_START_BIT = 3

static const long	LOWLIGHT_BIT_MASK = 0x1

Constructor & Destructor Documentation

◆ ImagingModesBitField()

openjaus::environment_v1_0::ImagingModesBitField::ImagingModesBitField ( )

◆ ~ImagingModesBitField()

openjaus::environment_v1_0::ImagingModesBitField::~ImagingModesBitField ( )

Member Function Documentation

◆ copy()

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

◆ from()

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

◆ getColor()

bool openjaus::environment_v1_0::ImagingModesBitField::getColor ( void ) const

◆ getGreyscale()

bool openjaus::environment_v1_0::ImagingModesBitField::getGreyscale ( void ) const

◆ getInfrared()

bool openjaus::environment_v1_0::ImagingModesBitField::getInfrared ( void ) const

◆ getIntegerValue()

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

◆ getLowlight()

bool openjaus::environment_v1_0::ImagingModesBitField::getLowlight ( void ) const

◆ length()

uint64 openjaus::environment_v1_0::ImagingModesBitField::length ( ) const

virtual

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

◆ setColor()

bool openjaus::environment_v1_0::ImagingModesBitField::setColor ( bool value )

◆ setGreyscale()

bool openjaus::environment_v1_0::ImagingModesBitField::setGreyscale ( bool value )

◆ setInfrared()

bool openjaus::environment_v1_0::ImagingModesBitField::setInfrared ( bool value )

◆ setIntegerValue()

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

◆ setLowlight()

bool openjaus::environment_v1_0::ImagingModesBitField::setLowlight ( bool value )

◆ to()

uint64 openjaus::environment_v1_0::ImagingModesBitField::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::ImagingModesBitField::toXml ( unsigned char ojIndentLevel = 0 ) const

Member Data Documentation

◆ color

bool openjaus::environment_v1_0::ImagingModesBitField::color

protected

◆ COLOR_BIT_MASK

const long openjaus::environment_v1_0::ImagingModesBitField::COLOR_BIT_MASK = 0x1

staticprotected

◆ COLOR_START_BIT

const long openjaus::environment_v1_0::ImagingModesBitField::COLOR_START_BIT = 0

staticprotected

◆ greyscale

bool openjaus::environment_v1_0::ImagingModesBitField::greyscale

protected

◆ GREYSCALE_BIT_MASK

const long openjaus::environment_v1_0::ImagingModesBitField::GREYSCALE_BIT_MASK = 0x1

staticprotected

◆ GREYSCALE_START_BIT

const long openjaus::environment_v1_0::ImagingModesBitField::GREYSCALE_START_BIT = 1

staticprotected

◆ infrared

bool openjaus::environment_v1_0::ImagingModesBitField::infrared

protected

◆ INFRARED_BIT_MASK

const long openjaus::environment_v1_0::ImagingModesBitField::INFRARED_BIT_MASK = 0x1

staticprotected

◆ INFRARED_START_BIT

const long openjaus::environment_v1_0::ImagingModesBitField::INFRARED_START_BIT = 2

staticprotected

◆ lowlight

bool openjaus::environment_v1_0::ImagingModesBitField::lowlight

protected

◆ LOWLIGHT_BIT_MASK

const long openjaus::environment_v1_0::ImagingModesBitField::LOWLIGHT_BIT_MASK = 0x1

staticprotected

◆ LOWLIGHT_START_BIT

const long openjaus::environment_v1_0::ImagingModesBitField::LOWLIGHT_START_BIT = 3

staticprotected

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

include/openjaus/environment_v1_0/Triggers/Fields/ImagingModesBitField.h
src/openjaus/environment_v1_0/Triggers/Fields/ImagingModesBitField.cpp

Public Member Functions

Protected Attributes

Static Protected Attributes

Constructor & Destructor Documentation

◆ ImagingModesBitField()

◆ ~ImagingModesBitField()

Member Function Documentation

◆ copy()

◆ from()

◆ getColor()

◆ getGreyscale()

◆ getInfrared()

◆ getIntegerValue()

◆ getLowlight()

◆ length()

◆ setColor()

◆ setGreyscale()

◆ setInfrared()

◆ setIntegerValue()

◆ setLowlight()

◆ to()

◆ toXml()

Member Data Documentation

◆ color

◆ COLOR_BIT_MASK

◆ COLOR_START_BIT

◆ greyscale

◆ GREYSCALE_BIT_MASK

◆ GREYSCALE_START_BIT

◆ infrared

◆ INFRARED_BIT_MASK

◆ INFRARED_START_BIT

◆ lowlight

◆ LOWLIGHT_BIT_MASK

◆ LOWLIGHT_START_BIT