OpenJAUS Software Development Kit  4.3.1
Public Member Functions | Protected Attributes | Static Protected Attributes | List of all members
openjaus::core::AddressBitField Class Reference

#include <AddressBitField.h>

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

Public Member Functions

 AddressBitField ()
 
 ~AddressBitField ()
 
bool setSubsystem (long value)
 
long getSubsystem (void) const
 
bool setNode (long value)
 
long getNode (void) const
 
bool setComponent (long value)
 
long getComponent (void) const
 
uint32_t getIntegerValue (void) const
 
void setIntegerValue (uint32_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 (AddressBitField &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

long subsystem
 
long node
 
long component
 
- 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 SUBSYSTEM_START_BIT = 16
 
static const long SUBSYSTEM_BIT_MASK = 0xFFFF
 
static const long NODE_START_BIT = 8
 
static const long NODE_BIT_MASK = 0xFF
 
static const long COMPONENT_START_BIT = 0
 
static const long COMPONENT_BIT_MASK = 0xFF
 
static const long SUBSYSTEM_MIN_VALUE = 0
 
static const long SUBSYSTEM_MAX_VALUE = 65535
 
static const long NODE_MIN_VALUE = 0
 
static const long NODE_MAX_VALUE = 255
 
static const long COMPONENT_MIN_VALUE = 0
 
static const long COMPONENT_MAX_VALUE = 255
 

Constructor & Destructor Documentation

§ AddressBitField()

openjaus::core::AddressBitField::AddressBitField ( )

§ ~AddressBitField()

openjaus::core::AddressBitField::~AddressBitField ( )

Member Function Documentation

§ copy()

void openjaus::core::AddressBitField::copy ( AddressBitField source)

§ from()

int openjaus::core::AddressBitField::from ( system::Buffer src)
virtual
Parameters
src

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

§ getComponent()

long openjaus::core::AddressBitField::getComponent ( void  ) const

§ getIntegerValue()

uint32_t openjaus::core::AddressBitField::getIntegerValue ( void  ) const

§ getNode()

long openjaus::core::AddressBitField::getNode ( void  ) const

§ getSubsystem()

long openjaus::core::AddressBitField::getSubsystem ( void  ) const

§ length()

int openjaus::core::AddressBitField::length ( )
virtual

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

§ setComponent()

bool openjaus::core::AddressBitField::setComponent ( long  value)

§ setIntegerValue()

void openjaus::core::AddressBitField::setIntegerValue ( uint32_t  value)

§ setNode()

bool openjaus::core::AddressBitField::setNode ( long  value)

§ setSubsystem()

bool openjaus::core::AddressBitField::setSubsystem ( long  value)

§ to()

int openjaus::core::AddressBitField::to ( system::Buffer dst)
virtual
Parameters
dst

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

§ toXml()

std::string openjaus::core::AddressBitField::toXml ( unsigned char  ojIndentLevel = 0) const

Member Data Documentation

§ component

long openjaus::core::AddressBitField::component
protected

§ COMPONENT_BIT_MASK

const long openjaus::core::AddressBitField::COMPONENT_BIT_MASK = 0xFF
staticprotected

§ COMPONENT_MAX_VALUE

const long openjaus::core::AddressBitField::COMPONENT_MAX_VALUE = 255
staticprotected

§ COMPONENT_MIN_VALUE

const long openjaus::core::AddressBitField::COMPONENT_MIN_VALUE = 0
staticprotected

§ COMPONENT_START_BIT

const long openjaus::core::AddressBitField::COMPONENT_START_BIT = 0
staticprotected

§ node

long openjaus::core::AddressBitField::node
protected

§ NODE_BIT_MASK

const long openjaus::core::AddressBitField::NODE_BIT_MASK = 0xFF
staticprotected

§ NODE_MAX_VALUE

const long openjaus::core::AddressBitField::NODE_MAX_VALUE = 255
staticprotected

§ NODE_MIN_VALUE

const long openjaus::core::AddressBitField::NODE_MIN_VALUE = 0
staticprotected

§ NODE_START_BIT

const long openjaus::core::AddressBitField::NODE_START_BIT = 8
staticprotected

§ subsystem

long openjaus::core::AddressBitField::subsystem
protected

§ SUBSYSTEM_BIT_MASK

const long openjaus::core::AddressBitField::SUBSYSTEM_BIT_MASK = 0xFFFF
staticprotected

§ SUBSYSTEM_MAX_VALUE

const long openjaus::core::AddressBitField::SUBSYSTEM_MAX_VALUE = 65535
staticprotected

§ SUBSYSTEM_MIN_VALUE

const long openjaus::core::AddressBitField::SUBSYSTEM_MIN_VALUE = 0
staticprotected

§ SUBSYSTEM_START_BIT

const long openjaus::core::AddressBitField::SUBSYSTEM_START_BIT = 16
staticprotected

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