openjaus::manipulator::ParentIDBitField Class Reference

#include <ParentIDBitField.h>

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

Public Member Functions
	ParentIDBitField ()
	~ParentIDBitField ()
bool	setComponentID (long value)
long	getComponentID (void) const
bool	setNodeID (long value)
long	getNodeID (void) const
bool	setSubsystemID (long value)
long	getSubsystemID (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 (ParentIDBitField &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	componentID
long	nodeID
long	subsystemID
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	COMPONENTID_START_BIT = 0
static const long	COMPONENTID_BIT_MASK = 0xFF
static const long	NODEID_START_BIT = 8
static const long	NODEID_BIT_MASK = 0xFF
static const long	SUBSYSTEMID_START_BIT = 16
static const long	SUBSYSTEMID_BIT_MASK = 0xFFFF
static const long	COMPONENTID_MIN_VALUE = 1
static const long	COMPONENTID_MAX_VALUE = 255
static const long	NODEID_MIN_VALUE = 1
static const long	NODEID_MAX_VALUE = 255
static const long	SUBSYSTEMID_MIN_VALUE = 1
static const long	SUBSYSTEMID_MAX_VALUE = 65535

Constructor & Destructor Documentation

ParentIDBitField()

openjaus::manipulator::ParentIDBitField::ParentIDBitField

(

)

~ParentIDBitField()

openjaus::manipulator::ParentIDBitField::~ParentIDBitField

(

)

Member Function Documentation

copy()

void openjaus::manipulator::ParentIDBitField::copy

(

ParentIDBitField &

source

)

from()

int openjaus::manipulator::ParentIDBitField::from ( system::Buffer *  src )

virtual

Parameters

src

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

getComponentID()

long openjaus::manipulator::ParentIDBitField::getComponentID

(

void

)

const

getIntegerValue()

uint32_t openjaus::manipulator::ParentIDBitField::getIntegerValue

(

void

)

const

getNodeID()

long openjaus::manipulator::ParentIDBitField::getNodeID

(

void

)

const

getSubsystemID()

long openjaus::manipulator::ParentIDBitField::getSubsystemID

(

void

)

const

length()

int openjaus::manipulator::ParentIDBitField::length ( )

virtual

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

setComponentID()

bool openjaus::manipulator::ParentIDBitField::setComponentID

(

long

value

)

setIntegerValue()

void openjaus::manipulator::ParentIDBitField::setIntegerValue

(

uint32_t

value

)

setNodeID()

bool openjaus::manipulator::ParentIDBitField::setNodeID

(

long

value

)

setSubsystemID()

bool openjaus::manipulator::ParentIDBitField::setSubsystemID

(

long

value

)

to()

int openjaus::manipulator::ParentIDBitField::to ( system::Buffer *  dst )

virtual

Parameters

dst

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

toXml()

std::string openjaus::manipulator::ParentIDBitField::toXml

(

unsigned char

ojIndentLevel = 0

)

const

Member Data Documentation

componentID

long openjaus::manipulator::ParentIDBitField::componentID

protected

COMPONENTID_BIT_MASK

const long openjaus::manipulator::ParentIDBitField::COMPONENTID_BIT_MASK = 0xFF

staticprotected

COMPONENTID_MAX_VALUE

const long openjaus::manipulator::ParentIDBitField::COMPONENTID_MAX_VALUE = 255

staticprotected

COMPONENTID_MIN_VALUE

const long openjaus::manipulator::ParentIDBitField::COMPONENTID_MIN_VALUE = 1

staticprotected

COMPONENTID_START_BIT

const long openjaus::manipulator::ParentIDBitField::COMPONENTID_START_BIT = 0

staticprotected

nodeID

long openjaus::manipulator::ParentIDBitField::nodeID

protected

NODEID_BIT_MASK

const long openjaus::manipulator::ParentIDBitField::NODEID_BIT_MASK = 0xFF

staticprotected

NODEID_MAX_VALUE

const long openjaus::manipulator::ParentIDBitField::NODEID_MAX_VALUE = 255

staticprotected

NODEID_MIN_VALUE

const long openjaus::manipulator::ParentIDBitField::NODEID_MIN_VALUE = 1

staticprotected

NODEID_START_BIT

const long openjaus::manipulator::ParentIDBitField::NODEID_START_BIT = 8

staticprotected

subsystemID

long openjaus::manipulator::ParentIDBitField::subsystemID

protected

SUBSYSTEMID_BIT_MASK

const long openjaus::manipulator::ParentIDBitField::SUBSYSTEMID_BIT_MASK = 0xFFFF

staticprotected

SUBSYSTEMID_MAX_VALUE

const long openjaus::manipulator::ParentIDBitField::SUBSYSTEMID_MAX_VALUE = 65535

staticprotected

SUBSYSTEMID_MIN_VALUE

const long openjaus::manipulator::ParentIDBitField::SUBSYSTEMID_MIN_VALUE = 1

staticprotected

SUBSYSTEMID_START_BIT

const long openjaus::manipulator::ParentIDBitField::SUBSYSTEMID_START_BIT = 16

staticprotected

---

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

• include/openjaus/manipulator/Triggers/Fields/ParentIDBitField.h
• src/openjaus/manipulator/Triggers/Fields/ParentIDBitField.cpp