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

This is a brief description. More...

#include <NodeInfo.h>

Public Member Functions

 NodeInfo ()
 
virtual ~NodeInfo ()
 
 NodeInfo (const NodeInfo &copy)
 
std::string getName () const
 Accessor to get the value of name. More...
 
bool setName (std::string name)
 Accessor to set value of name. More...
 
int getId () const
 Accessor to get the value of id. More...
 
bool setId (int id)
 Accessor to set value of id. More...
 
const std::map< unsigned char, ComponentInfo *> & getComponents () const
 Accessor to get the value of components. More...
 
SubsystemInfogetSubsystem () const
 Accessor to get the value of subsystem. More...
 
bool setSubsystem (SubsystemInfo *subsystem)
 Accessor to set value of subsystem. More...
 
bool addComponent (ComponentInfo *component)
 Operation addComponent. More...
 
virtual std::string toString () const
 
std::string toXml (unsigned char level=0) const
 
std::vector< transport::AddresslookupService (std::string uri, int versionMajor, int versionMinor, transport::Address &addressHint)
 
std::vector< transport::AddresslookupComponent (std::string name, transport::Address &addressHint)
 

Static Public Attributes

static const unsigned char MINIMUM_ID = 1
 
static const unsigned char MAXIMUM_ID = 254
 

Protected Attributes

std::string name
 
int id
 
std::map< unsigned char, ComponentInfo *> components
 
SubsystemInfosubsystem
 

Friends

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

Detailed Description

Detailed description.

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

Constructor & Destructor Documentation

§ NodeInfo() [1/2]

openjaus::model::NodeInfo::NodeInfo ( )

§ ~NodeInfo()

openjaus::model::NodeInfo::~NodeInfo ( )
virtual

§ NodeInfo() [2/2]

openjaus::model::NodeInfo::NodeInfo ( const NodeInfo copy)

Member Function Documentation

§ addComponent()

bool openjaus::model::NodeInfo::addComponent ( ComponentInfo component)
Parameters
component

§ getComponents()

const std::map< unsigned char, ComponentInfo *> & openjaus::model::NodeInfo::getComponents ( ) const

§ getId()

int openjaus::model::NodeInfo::getId ( ) const

§ getName()

std::string openjaus::model::NodeInfo::getName ( void  ) const

§ getSubsystem()

SubsystemInfo * openjaus::model::NodeInfo::getSubsystem ( ) const

§ lookupComponent()

std::vector< transport::Address > openjaus::model::NodeInfo::lookupComponent ( std::string  name,
transport::Address addressHint 
)

§ lookupService()

std::vector< transport::Address > openjaus::model::NodeInfo::lookupService ( std::string  uri,
int  versionMajor,
int  versionMinor,
transport::Address addressHint 
)

§ setId()

bool openjaus::model::NodeInfo::setId ( int  id)
Parameters
idThe value of the new id.

§ setName()

bool openjaus::model::NodeInfo::setName ( std::string  name)
Parameters
nameThe value of the new name.

§ setSubsystem()

bool openjaus::model::NodeInfo::setSubsystem ( SubsystemInfo subsystem)
Parameters
subsystemThe value of the new subsystem.

§ toString()

std::string openjaus::model::NodeInfo::toString ( ) const
virtual

§ toXml()

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

Friends And Related Function Documentation

§ operator<< [1/2]

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

§ operator<< [2/2]

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

Member Data Documentation

§ components

std::map< unsigned char, ComponentInfo * > openjaus::model::NodeInfo::components
protected

§ id

int openjaus::model::NodeInfo::id
protected

§ MAXIMUM_ID

const unsigned char openjaus::model::NodeInfo::MAXIMUM_ID = 254
static

§ MINIMUM_ID

const unsigned char openjaus::model::NodeInfo::MINIMUM_ID = 1
static

§ name

std::string openjaus::model::NodeInfo::name
protected

§ subsystem

SubsystemInfo* openjaus::model::NodeInfo::subsystem
protected

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