openjaus::transport::Address Class Reference

This is a brief description. More...

#include <Address.h>

Inherits openjaus::system::Transportable.

List of all members.

Public Member Functions
	Address ()
virtual	~Address ()
	Address (uint16_t subsystem, unsigned char node, unsigned char component)
uint16_t	getSubsystem () const
	Accessor to get the value of subsystem.
bool	setSubsystem (uint16_t subsystem)
	Accessor to set value of subsystem.
unsigned char	getNode () const
	Accessor to get the value of node.
bool	setNode (unsigned char node)
	Accessor to set value of node.
unsigned char	getComponent () const
	Accessor to get the value of component.
bool	setComponent (unsigned char component)
	Accessor to set value of component.
int	getHash () const
	Accessor to get the value of hash.
bool	isValid ()
	Operation isValid.
virtual int	to (system::Buffer *dst)
	Operation to.
virtual int	from (system::Buffer *src)
	Operation from.
virtual int	length ()
	Serializes object to internal transport buffer.
std::string	toString () const
Json::Value	toJson () const
std::string	toXml (unsigned char level=0) const
bool	operator== (const Address &other) const
bool	operator!= (const Address &other) const
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
std::ostream &	operator<< (std::ostream &output, const Address &object)

---

Detailed Description

Detailed description.

Author:

Name (name@email.com)

---

Constructor & Destructor Documentation

openjaus::transport::Address::Address

(

)

openjaus::transport::Address::~Address

(

)

[virtual]

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

---

Member Function Documentation

int openjaus::transport::Address::from

(

system::Buffer *

src

)

[virtual]

Parameters:

src

Implements openjaus::system::Transportable.

unsigned char openjaus::transport::Address::getComponent

(

)

const

int openjaus::transport::Address::getHash

(

)

const

unsigned char openjaus::transport::Address::getNode

(

)

const

uint16_t openjaus::transport::Address::getSubsystem

(

)

const

bool openjaus::transport::Address::isValid

(

)

int openjaus::transport::Address::length

(

)

[virtual]

Implements openjaus::system::Transportable.

bool openjaus::transport::Address::operator!=

(

const Address &

other

)

const

bool openjaus::transport::Address::operator==

(

const Address &

other

)

const

bool openjaus::transport::Address::setComponent

(

unsigned char

component

)

Parameters:

component

The value of the new component.

bool openjaus::transport::Address::setNode

(

unsigned char

node

)

Parameters:

node

The value of the new node.

bool openjaus::transport::Address::setSubsystem

(

uint16_t

subsystem

)

Parameters:

subsystem

The value of the new subsystem.

int openjaus::transport::Address::to

(

system::Buffer *

dst

)

[virtual]

Parameters:

dst

Implements openjaus::system::Transportable.

Json::Value openjaus::transport::Address::toJson

(

)

const

std::string openjaus::transport::Address::toString

(

)

const

Reimplemented from openjaus::system::Transportable.

std::string openjaus::transport::Address::toXml

(

unsigned char

level = 0

)

const

---

Friends And Related Function Documentation

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

---

Member Data Documentation

const unsigned char openjaus::transport::Address::ANY_COMPONENT = 255 [static]

const unsigned char openjaus::transport::Address::ANY_NODE = 255 [static]

const unsigned short openjaus::transport::Address::ANY_SUBSYSTEM = 65535 [static]

unsigned char openjaus::transport::Address::component [protected]

unsigned char openjaus::transport::Address::node [protected]

uint16_t openjaus::transport::Address::subsystem [protected]

const unsigned char openjaus::transport::Address::THIS_COMPONENT = 0 [static]

const unsigned char openjaus::transport::Address::THIS_NODE = 0 [static]

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