OpenJAUS Software Development Kit  4.3.1
Public Member Functions | Protected Attributes | Static Protected Attributes | List of all members
openjaus::environment::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 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...
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
virtual ~Transportable ()
 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::SupportedStatesBitField::SupportedStatesBitField ( )

§ ~SupportedStatesBitField()

openjaus::environment::SupportedStatesBitField::~SupportedStatesBitField ( )

Member Function Documentation

§ copy()

void openjaus::environment::SupportedStatesBitField::copy ( SupportedStatesBitField source)

§ from()

int openjaus::environment::SupportedStatesBitField::from ( system::Buffer src)

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

§ getActive()

bool openjaus::environment::SupportedStatesBitField::getActive ( void  ) const

§ getIntegerValue()

uint8_t openjaus::environment::SupportedStatesBitField::getIntegerValue ( void  ) const

§ getOff()

bool openjaus::environment::SupportedStatesBitField::getOff ( void  ) const

§ getStandby()

bool openjaus::environment::SupportedStatesBitField::getStandby ( void  ) const

§ length()

int openjaus::environment::SupportedStatesBitField::length ( )

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

§ setActive()

bool openjaus::environment::SupportedStatesBitField::setActive ( bool  value)

§ setIntegerValue()

void openjaus::environment::SupportedStatesBitField::setIntegerValue ( uint8_t  value)

§ setOff()

bool openjaus::environment::SupportedStatesBitField::setOff ( bool  value)

§ setStandby()

bool openjaus::environment::SupportedStatesBitField::setStandby ( bool  value)

§ to()

int openjaus::environment::SupportedStatesBitField::to ( system::Buffer dst)

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

§ toXml()

std::string openjaus::environment::SupportedStatesBitField::toXml ( unsigned char  ojIndentLevel = 0) const

Member Data Documentation

§ active

bool openjaus::environment::SupportedStatesBitField::active


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


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

§ off

bool openjaus::environment::SupportedStatesBitField::off


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


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

§ standby

bool openjaus::environment::SupportedStatesBitField::standby


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


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

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