This is a brief description. More...

#include <Address.h>

Inherits openjaus::system::Transportable.

Public Member Functions
	Address ()

virtual	~Address ()

	Address (const Address &address)

	Address (uint16_t subsystem, unsigned char node, unsigned char component)

uint16_t	getSubsystem () const
	Accessor to get the value of subsystem. More...

bool	setSubsystem (uint16_t subsystem)
	Accessor to set value of subsystem. More...

unsigned char	getNode () const
	Accessor to get the value of node. More...

bool	setNode (unsigned char node)
	Accessor to set value of node. More...

unsigned char	getComponent () const
	Accessor to get the value of component. More...

bool	setComponent (unsigned char component)
	Accessor to set value of component. More...

int	getHash () const
	Accessor to get the value of hash. More...

bool	isValid ()
	Operation isValid. More...

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...

virtual std::string	toString () const

bool	isBroadcast () const

std::string	toXml (unsigned char level=0) const

bool	operator== (const Address &other) const

bool	operator!= (const Address &other) const

bool	operator< (const Address &other) const

Public Member Functions inherited from openjaus::system::Transportable
	Transportable ()

virtual	~Transportable ()

Static Public Attributes
static const unsigned short	ANY_SUBSYSTEM = 65535

static const unsigned char	ANY_NODE = 255

static const unsigned char	ANY_COMPONENT = 255

static const unsigned short	THIS_SUBSYSTEM = 0

static const unsigned char	THIS_NODE = 0

static const unsigned char	THIS_COMPONENT = 0

Protected Attributes
uint16_t	subsystem

unsigned char	node

unsigned char	component

Friends
OPENJAUS_EXPORT friend std::ostream &	operator<< (std::ostream &output, const Address &object)

OPENJAUS_EXPORT friend std::ostream &	operator<< (std::ostream &output, const Address *object)

Detailed Description

Detailed description.

Author: Name (name@.nosp@m.emai.nosp@m.l.com)

Constructor & Destructor Documentation

◆ Address() [1/3]

openjaus::transport::Address::Address ( )

◆ ~Address()

openjaus::transport::Address::~Address ( )

virtual

◆ Address() [2/3]

openjaus::transport::Address::Address ( const Address & address )

◆ Address() [3/3]

openjaus::transport::Address::Address	(	uint16_t	subsystem,
		unsigned char	node,
		unsigned char	component
	)

Member Function Documentation

◆ from()

uint64 openjaus::transport::Address::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

Implements openjaus::system::Transportable.

◆ getComponent()

unsigned char openjaus::transport::Address::getComponent ( ) const

◆ getHash()

int openjaus::transport::Address::getHash ( ) const

◆ getNode()

unsigned char openjaus::transport::Address::getNode ( ) const

◆ getSubsystem()

uint16_t openjaus::transport::Address::getSubsystem ( ) const

◆ isBroadcast()

bool openjaus::transport::Address::isBroadcast ( ) const

◆ isValid()

bool openjaus::transport::Address::isValid ( )

◆ length()

uint64 openjaus::transport::Address::length ( ) const

virtual

Implements openjaus::system::Transportable.

◆ operator!=()

bool openjaus::transport::Address::operator!= ( const Address & other ) const

◆ operator<()

bool openjaus::transport::Address::operator< ( const Address & other ) const

◆ operator==()

bool openjaus::transport::Address::operator== ( const Address & other ) const

◆ setComponent()

bool openjaus::transport::Address::setComponent ( unsigned char component )

Parameters

component The value of the new component.

◆ setNode()

bool openjaus::transport::Address::setNode ( unsigned char node )

Parameters

node	The value of the new node.

◆ setSubsystem()

bool openjaus::transport::Address::setSubsystem ( uint16_t subsystem )

Parameters

subsystem The value of the new subsystem.

◆ to()

uint64 openjaus::transport::Address::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

Implements openjaus::system::Transportable.

◆ toString()

std::string openjaus::transport::Address::toString ( ) const

virtual

◆ toXml()

std::string openjaus::transport::Address::toXml ( unsigned char level = 0 ) const

Friends And Related Function Documentation

◆ operator<< [1/2]

OPENJAUS_EXPORT friend std::ostream& operator<<	(	std::ostream &	output,
		const Address &	object
	)

friend

◆ operator<< [2/2]

OPENJAUS_EXPORT friend std::ostream& operator<<	(	std::ostream &	output,
		const Address *	object
	)

friend

Member Data Documentation

◆ ANY_COMPONENT

const unsigned char openjaus::transport::Address::ANY_COMPONENT = 255

static

◆ ANY_NODE

const unsigned char openjaus::transport::Address::ANY_NODE = 255

static

◆ ANY_SUBSYSTEM

const unsigned short openjaus::transport::Address::ANY_SUBSYSTEM = 65535

static

◆ component

unsigned char openjaus::transport::Address::component

protected

◆ node

unsigned char openjaus::transport::Address::node

protected

◆ subsystem

uint16_t openjaus::transport::Address::subsystem

protected

◆ THIS_COMPONENT

const unsigned char openjaus::transport::Address::THIS_COMPONENT = 0

static

◆ THIS_NODE

const unsigned char openjaus::transport::Address::THIS_NODE = 0

static

◆ THIS_SUBSYSTEM

const unsigned short openjaus::transport::Address::THIS_SUBSYSTEM = 0

static

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

include/openjaus/transport/Address.h
src/openjaus/transport/Address.cpp

Public Member Functions

Static Public Attributes

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Address() [1/3]

◆ ~Address()

◆ Address() [2/3]

◆ Address() [3/3]

Member Function Documentation

◆ from()

◆ getComponent()

◆ getHash()

◆ getNode()

◆ getSubsystem()

◆ isBroadcast()

◆ isValid()

◆ length()

◆ operator!=()

◆ operator<()

◆ operator==()

◆ setComponent()

◆ setNode()

◆ setSubsystem()

◆ to()

◆ toString()

◆ toXml()

Friends And Related Function Documentation

◆ operator<< [1/2]

◆ operator<< [2/2]

Member Data Documentation

◆ ANY_COMPONENT

◆ ANY_NODE

◆ ANY_SUBSYSTEM

◆ component

◆ node

◆ subsystem

◆ THIS_COMPONENT

◆ THIS_NODE

◆ THIS_SUBSYSTEM