openjaus::environment_v1_0::SupportedStatesBitField Class Reference

#include <SupportedStatesBitField.h>

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

Public Member Functions
	SupportedStatesBitField ()
	~SupportedStatesBitField ()
bool	setActive (bool value)
bool	getActive (void) const
bool	setStandby (bool value)
bool	getStandby (void) const
bool	setOff (bool value)
bool	getOff (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 (SupportedStatesBitField &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	active
bool	standby
bool	off
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	ACTIVE_START_BIT = 0
static const long	ACTIVE_BIT_MASK = 0x1
static const long	STANDBY_START_BIT = 1
static const long	STANDBY_BIT_MASK = 0x1
static const long	OFF_START_BIT = 2
static const long	OFF_BIT_MASK = 0x1

Constructor & Destructor Documentation

SupportedStatesBitField()

openjaus::environment_v1_0::SupportedStatesBitField::SupportedStatesBitField

(

)

~SupportedStatesBitField()

openjaus::environment_v1_0::SupportedStatesBitField::~SupportedStatesBitField

(

)

Member Function Documentation

copy()

void openjaus::environment_v1_0::SupportedStatesBitField::copy

(

SupportedStatesBitField &

source

)

from()

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

getActive()

bool openjaus::environment_v1_0::SupportedStatesBitField::getActive

(

void

)

const

getIntegerValue()

uint8_t openjaus::environment_v1_0::SupportedStatesBitField::getIntegerValue

(

void

)

const

getOff()

bool openjaus::environment_v1_0::SupportedStatesBitField::getOff

(

void

)

const

getStandby()

bool openjaus::environment_v1_0::SupportedStatesBitField::getStandby

(

void

)

const

length()

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

virtual

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

setActive()

bool openjaus::environment_v1_0::SupportedStatesBitField::setActive

(

bool

value

)

setIntegerValue()

void openjaus::environment_v1_0::SupportedStatesBitField::setIntegerValue

(

uint8_t

value

)

setOff()

bool openjaus::environment_v1_0::SupportedStatesBitField::setOff

(

bool

value

)

setStandby()

bool openjaus::environment_v1_0::SupportedStatesBitField::setStandby

(

bool

value

)

to()

uint64 openjaus::environment_v1_0::SupportedStatesBitField::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::SupportedStatesBitField::toXml

(

unsigned char

ojIndentLevel = 0

)

const

Member Data Documentation

active

bool openjaus::environment_v1_0::SupportedStatesBitField::active

protected

ACTIVE_BIT_MASK

const long openjaus::environment_v1_0::SupportedStatesBitField::ACTIVE_BIT_MASK = 0x1

staticprotected

ACTIVE_START_BIT

const long openjaus::environment_v1_0::SupportedStatesBitField::ACTIVE_START_BIT = 0

staticprotected

off

bool openjaus::environment_v1_0::SupportedStatesBitField::off

protected

OFF_BIT_MASK

const long openjaus::environment_v1_0::SupportedStatesBitField::OFF_BIT_MASK = 0x1

staticprotected

OFF_START_BIT

const long openjaus::environment_v1_0::SupportedStatesBitField::OFF_START_BIT = 2

staticprotected

standby

bool openjaus::environment_v1_0::SupportedStatesBitField::standby

protected

STANDBY_BIT_MASK

const long openjaus::environment_v1_0::SupportedStatesBitField::STANDBY_BIT_MASK = 0x1

staticprotected

STANDBY_START_BIT

const long openjaus::environment_v1_0::SupportedStatesBitField::STANDBY_START_BIT = 1

staticprotected

---

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

• include/openjaus/environment_v1_0/Triggers/Fields/SupportedStatesBitField.h
• src/openjaus/environment_v1_0/Triggers/Fields/SupportedStatesBitField.cpp