#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 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 (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
	Transportable ()

virtual	~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_v1_1::AddressBitField::AddressBitField ( )

◆ ~AddressBitField()

openjaus::core_v1_1::AddressBitField::~AddressBitField ( )

Member Function Documentation

◆ copy()

void openjaus::core_v1_1::AddressBitField::copy ( AddressBitField & source )

◆ from()

uint64 openjaus::core_v1_1::AddressBitField::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.

◆ getComponent()

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

◆ getIntegerValue()

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

◆ getNode()

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

◆ getSubsystem()

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

◆ length()

uint64 openjaus::core_v1_1::AddressBitField::length ( ) const

virtual

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

◆ setComponent()

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

◆ setIntegerValue()

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

◆ setNode()

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

◆ setSubsystem()

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

◆ to()

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

Member Data Documentation

◆ component

long openjaus::core_v1_1::AddressBitField::component

protected

◆ COMPONENT_BIT_MASK

const long openjaus::core_v1_1::AddressBitField::COMPONENT_BIT_MASK = 0xFF

staticprotected

◆ COMPONENT_MAX_VALUE

const long openjaus::core_v1_1::AddressBitField::COMPONENT_MAX_VALUE = 255

staticprotected

◆ COMPONENT_MIN_VALUE

const long openjaus::core_v1_1::AddressBitField::COMPONENT_MIN_VALUE = 0

staticprotected

◆ COMPONENT_START_BIT

const long openjaus::core_v1_1::AddressBitField::COMPONENT_START_BIT = 0

staticprotected

◆ node

long openjaus::core_v1_1::AddressBitField::node

protected

◆ NODE_BIT_MASK

const long openjaus::core_v1_1::AddressBitField::NODE_BIT_MASK = 0xFF

staticprotected

◆ NODE_MAX_VALUE

const long openjaus::core_v1_1::AddressBitField::NODE_MAX_VALUE = 255

staticprotected

◆ NODE_MIN_VALUE

const long openjaus::core_v1_1::AddressBitField::NODE_MIN_VALUE = 0

staticprotected

◆ NODE_START_BIT

const long openjaus::core_v1_1::AddressBitField::NODE_START_BIT = 8

staticprotected

◆ subsystem

long openjaus::core_v1_1::AddressBitField::subsystem

protected

◆ SUBSYSTEM_BIT_MASK

const long openjaus::core_v1_1::AddressBitField::SUBSYSTEM_BIT_MASK = 0xFFFF

staticprotected

◆ SUBSYSTEM_MAX_VALUE

const long openjaus::core_v1_1::AddressBitField::SUBSYSTEM_MAX_VALUE = 65535

staticprotected

◆ SUBSYSTEM_MIN_VALUE

const long openjaus::core_v1_1::AddressBitField::SUBSYSTEM_MIN_VALUE = 0

staticprotected

◆ SUBSYSTEM_START_BIT

const long openjaus::core_v1_1::AddressBitField::SUBSYSTEM_START_BIT = 16

staticprotected

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

include/openjaus/core_v1_1/Triggers/Fields/AddressBitField.h
src/openjaus/core_v1_1/Triggers/Fields/AddressBitField.cpp

Public Member Functions

Protected Attributes

Static Protected Attributes

Constructor & Destructor Documentation

◆ AddressBitField()

◆ ~AddressBitField()

Member Function Documentation

◆ copy()

◆ from()

◆ getComponent()

◆ getIntegerValue()

◆ getNode()

◆ getSubsystem()

◆ length()

◆ setComponent()

◆ setIntegerValue()

◆ setNode()

◆ setSubsystem()

◆ to()

◆ toXml()

Member Data Documentation

◆ component

◆ COMPONENT_BIT_MASK

◆ COMPONENT_MAX_VALUE

◆ COMPONENT_MIN_VALUE

◆ COMPONENT_START_BIT

◆ node

◆ NODE_BIT_MASK

◆ NODE_MAX_VALUE

◆ NODE_MIN_VALUE

◆ NODE_START_BIT

◆ subsystem

◆ SUBSYSTEM_BIT_MASK

◆ SUBSYSTEM_MAX_VALUE

◆ SUBSYSTEM_MIN_VALUE

◆ SUBSYSTEM_START_BIT