OpenJAUS SAE SDK  6.0.0
Public Member Functions | Static Public Attributes | Private Attributes | Friends | List of all members
openjaus::model::ComponentInfo Class Reference

This is a brief description. More...

#include <ComponentInfo.h>

Public Member Functions

 ComponentInfo ()
 
virtual ~ComponentInfo ()
 
 ComponentInfo (const ComponentInfo &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< std::string, Service *> & getServices () const
 Accessor to get the value of services. More...
 
const transport::AddressgetAddress () const
 Accessor to get the value of address. More...
 
bool setAddress (const transport::Address &address)
 Accessor to set value of address. More...
 
NodeInfogetNode () const
 Accessor to get the value of node. More...
 
bool setNode (NodeInfo *node)
 Accessor to set value of node. More...
 
bool addService (Service *service)
 Operation addService. More...
 
virtual std::string toString () const
 
void clearServices ()
 
std::string toXml (unsigned char level=0) const
 
bool containsService (std::string uri, int versionMajor=Service::ANY_VERSION, int versionMinor=Service::ANY_VERSION)
 

Static Public Attributes

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

Private Attributes

std::string name
 
int id
 
std::map< std::string, Service *> services
 
transport::Address address
 
NodeInfonode
 

Friends

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

Detailed Description

Detailed description.

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

Constructor & Destructor Documentation

◆ ComponentInfo() [1/2]

openjaus::model::ComponentInfo::ComponentInfo ( )

◆ ~ComponentInfo()

openjaus::model::ComponentInfo::~ComponentInfo ( )
virtual

◆ ComponentInfo() [2/2]

openjaus::model::ComponentInfo::ComponentInfo ( const ComponentInfo copy)

Member Function Documentation

◆ addService()

bool openjaus::model::ComponentInfo::addService ( Service service)
Parameters
service

◆ clearServices()

void openjaus::model::ComponentInfo::clearServices ( )

◆ containsService()

bool openjaus::model::ComponentInfo::containsService ( std::string  uri,
int  versionMajor = Service::ANY_VERSION,
int  versionMinor = Service::ANY_VERSION 
)

◆ getAddress()

const transport::Address & openjaus::model::ComponentInfo::getAddress ( ) const

◆ getId()

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

◆ getName()

std::string openjaus::model::ComponentInfo::getName ( ) const

◆ getNode()

NodeInfo * openjaus::model::ComponentInfo::getNode ( ) const

◆ getServices()

const std::map< std::string, Service *> & openjaus::model::ComponentInfo::getServices ( ) const

◆ setAddress()

bool openjaus::model::ComponentInfo::setAddress ( const transport::Address address)
Parameters
addressThe value of the new address.

◆ setId()

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

◆ setName()

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

◆ setNode()

bool openjaus::model::ComponentInfo::setNode ( NodeInfo node)
Parameters
nodeThe value of the new node.

◆ toString()

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

◆ toXml()

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

Friends And Related Function Documentation

◆ operator<< [1/2]

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

◆ operator<< [2/2]

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

Member Data Documentation

◆ address

transport::Address openjaus::model::ComponentInfo::address
private

◆ id

int openjaus::model::ComponentInfo::id
private

◆ MAXIMUM_ID

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

◆ MINIMUM_ID

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

◆ name

std::string openjaus::model::ComponentInfo::name
private

◆ node

NodeInfo* openjaus::model::ComponentInfo::node
private

◆ services

std::map< std::string, Service * > openjaus::model::ComponentInfo::services
private

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