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

This is a brief description. More...

#include <Component.h>

Inherited by openjaus::core::Transport.

Public Member Functions

virtual ~Component ()
 
 Component (const std::string &name)
 
 Component (const Component &copy)
 
std::string getName () const
 Accessor to get the value of name. More...
 
uint8_t getAuthority () const
 Accessor to get the value of authority. More...
 
bool setAuthority (uint8_t authority)
 Accessor to set value of authority. More...
 
const std::vector< StateMachineRunner *> & getRunners () const
 Accessor to get the value of runners. More...
 
bool setRunners (const StateMachineRunner &runners)
 Accessor to set value of runners. More...
 
const std::vector< transport::Interface *> & getInterfaces () const
 Accessor to get the value of interfaces. More...
 
bool setInterfaces (const transport::Interface &interfaces)
 Accessor to set value of interfaces. More...
 
SystemTreegetSystemTree () const
 Accessor to get the value of systemTree. More...
 
bool setSystemTree (SystemTree *systemTree)
 Accessor to set value of systemTree. More...
 
std::vector< Service *> * getImplements () const
 Accessor to get the value of implements. More...
 
bool setImplements (Service *implements)
 Accessor to set value of implements. More...
 
ComponentgetInheritsFrom () const
 Accessor to get the value of inheritsFrom. More...
 
bool setInheritsFrom (Component *inheritsFrom)
 Accessor to set value of inheritsFrom. More...
 
const ComponentInfogetInfo () const
 Accessor to get the value of info. More...
 
const transport::AddressgetAddress () const
 Accessor to get the value of address. More...
 
void run ()
 Operation run. More...
 
void stop ()
 Operation stop. More...
 
virtual std::string toString () const
 
OPENJAUS_DEPRECATED Component ()
 
OPENJAUS_DEPRECATED bool setName (std::string name)
 
std::string toXml (unsigned char level=0) const
 

Static Public Attributes

static const uint8_t DEFAULT_AUTHORITY = 127
 

Protected Member Functions

virtual void configureServices ()
 
virtual void startServices ()
 
virtual void stopServices ()
 

Protected Attributes

uint8_t authority
 
std::vector< StateMachineRunner *> runners
 
std::vector< transport::Interface *> interfaces
 
SystemTreesystemTree
 
std::vector< Service *> * implements
 
ComponentinheritsFrom
 

Private Member Functions

void startTransportInterfaces ()
 
void startStateMachineRunners ()
 
void stopTransportInterfaces ()
 
void stopStateMachineRunners ()
 

Private Attributes

bool running
 
std::string name
 
ComponentInfo info
 
transport::Address address
 

Friends

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

Detailed Description

Detailed description.

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

Constructor & Destructor Documentation

§ ~Component()

openjaus::model::Component::~Component ( )
virtual

§ Component() [1/3]

openjaus::model::Component::Component ( const std::string &  name)

§ Component() [2/3]

openjaus::model::Component::Component ( const Component copy)

§ Component() [3/3]

openjaus::model::Component::Component ( )

Member Function Documentation

§ configureServices()

void openjaus::model::Component::configureServices ( )
protectedvirtual

§ getAddress()

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

§ getAuthority()

uint8_t openjaus::model::Component::getAuthority ( ) const

§ getImplements()

std::vector< Service *> * openjaus::model::Component::getImplements ( ) const

§ getInfo()

const ComponentInfo & openjaus::model::Component::getInfo ( ) const

§ getInheritsFrom()

Component * openjaus::model::Component::getInheritsFrom ( ) const

§ getInterfaces()

const std::vector< transport::Interface *> & openjaus::model::Component::getInterfaces ( ) const

§ getName()

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

§ getRunners()

const std::vector< StateMachineRunner *> & openjaus::model::Component::getRunners ( ) const

§ getSystemTree()

SystemTree * openjaus::model::Component::getSystemTree ( ) const

§ run()

void openjaus::model::Component::run ( )

§ setAuthority()

bool openjaus::model::Component::setAuthority ( uint8_t  authority)
Parameters
authorityThe value of the new authority.

§ setImplements()

bool openjaus::model::Component::setImplements ( Service implements)
Parameters
implementsThe value of the new implements.

§ setInheritsFrom()

bool openjaus::model::Component::setInheritsFrom ( Component inheritsFrom)
Parameters
inheritsFromThe value of the new inheritsFrom.

§ setInterfaces()

bool openjaus::model::Component::setInterfaces ( const transport::Interface interfaces)
Parameters
interfacesThe value of the new interfaces.

§ setName()

bool openjaus::model::Component::setName ( std::string  name)

§ setRunners()

bool openjaus::model::Component::setRunners ( const StateMachineRunner runners)
Parameters
runnersThe value of the new runners.

§ setSystemTree()

bool openjaus::model::Component::setSystemTree ( SystemTree systemTree)
Parameters
systemTreeThe value of the new systemTree.

§ startServices()

void openjaus::model::Component::startServices ( )
protectedvirtual

§ startStateMachineRunners()

void openjaus::model::Component::startStateMachineRunners ( )
private

§ startTransportInterfaces()

void openjaus::model::Component::startTransportInterfaces ( )
private

§ stop()

void openjaus::model::Component::stop ( )

§ stopServices()

void openjaus::model::Component::stopServices ( )
protectedvirtual

§ stopStateMachineRunners()

void openjaus::model::Component::stopStateMachineRunners ( )
private

§ stopTransportInterfaces()

void openjaus::model::Component::stopTransportInterfaces ( )
private

§ toString()

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

§ toXml()

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

Friends And Related Function Documentation

§ operator<< [1/2]

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

§ operator<< [2/2]

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

Member Data Documentation

§ address

transport::Address openjaus::model::Component::address
private

§ authority

uint8_t openjaus::model::Component::authority
protected

§ DEFAULT_AUTHORITY

const uint8_t openjaus::model::Component::DEFAULT_AUTHORITY = 127
static

§ implements

std::vector< Service* >* openjaus::model::Component::implements
protected

§ info

ComponentInfo openjaus::model::Component::info
private

§ inheritsFrom

Component* openjaus::model::Component::inheritsFrom
protected

§ interfaces

std::vector< transport::Interface* > openjaus::model::Component::interfaces
protected

§ name

std::string openjaus::model::Component::name
private

§ runners

std::vector< StateMachineRunner* > openjaus::model::Component::runners
protected

§ running

bool openjaus::model::Component::running
private

§ systemTree

SystemTree* openjaus::model::Component::systemTree
protected

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