MIRA
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Protected Attributes | List of all members
AbstractAuthority Class Referenceabstract

This is the abstract base class of local and remote authority classes. More...

#include <fw/AbstractAuthority.h>

Inheritance diagram for AbstractAuthority:
Inheritance graph
[legend]

Public Types

typedef std::multimap
< std::string, std::string > 
ChannelNameMapping
 
typedef std::map< std::string,
Status
ChannelStatusMap
 

Public Member Functions

virtual ~AbstractAuthority ()
 
virtual StatusManager::StatusMap getStatusMap ()=0
 Return a status map that contains the status of the authority as well as all registered submodules. More...
 
virtual boost::shared_ptr
< PropertyNode
getProperties ()=0
 Returns the main property node of this Authority. More...
 
virtual std::set< std::string > getPublishedChannels ()=0
 Returns all published channels by this authority (and its sub-authorities) More...
 
virtual std::set< std::string > getSubscribedChannels ()=0
 Returns all subscribed channels by this authority (and its sub-authorities) More...
 
virtual std::set< std::string > getServiceInterfaces ()=0
 Returns all service interfaces provided by this authority. More...
 
virtual ChannelNameMapping getPublishedChannelNames ()=0
 Returns all published channels (pair of global and local names) by this authority (and its sub-authorities) More...
 
virtual ChannelNameMapping getSubscribedChannelNames ()=0
 Returns all subscribed channels (pair of global and local names) by this authority (and its sub-authorities) More...
 
virtual ChannelStatusMap getSubscribedChannelStatus ()=0
 Returns status for all subscribed channels (ok, no publisher, no data, ...) by this authority (and its sub-authorities) More...
 
virtual void start ()=0
 Starts/Resumes the authority. More...
 
virtual void stop ()=0
 Stops/Pauses the authority. To continue call start(). More...
 
virtual bool hasUnrecoverableFailure () const =0
 Returns true, if there was a failure while processing the immediate handlers. More...
 
virtual bool isStarted () const =0
 Returns true, if the authority was started (by calling start()). More...
 
virtual bool isRunning () const =0
 Return if the authority is running. More...
 
Detailed Information Retrieval

These methods allow to obtain detailed information on the Authority.

std::string getNamespace () const
 Return the resolved namespace of the authority. More...
 
std::string getGlobalName () const
 Return the fully qualified global name (includes namespace) This method returns the name without the trailing UUID added if the authority is anonymous. More...
 
std::string getGlobalID () const
 Return the fully qualified global id (includes namespace) More...
 
std::string getID () const
 Return the id of the authority. More...
 
std::string getName () const
 Return the name of the authority. More...
 
const AuthorityDescriptiongetDescription () const
 Return the description of this authority. More...
 

Protected Attributes

AuthorityDescription mDescription
 

Detailed Description

This is the abstract base class of local and remote authority classes.

It provides access to properties of the authority like name, id, namespace and status informations. The methods of this class are implemented by Authority and RemoteAuthority.

Member Typedef Documentation

typedef std::multimap<std::string, std::string> ChannelNameMapping
typedef std::map<std::string, Status> ChannelStatusMap

Constructor & Destructor Documentation

virtual ~AbstractAuthority ( )
inlinevirtual

Member Function Documentation

std::string getNamespace ( ) const
inline

Return the resolved namespace of the authority.

Returns
Namespace
std::string getGlobalName ( ) const
inline

Return the fully qualified global name (includes namespace) This method returns the name without the trailing UUID added if the authority is anonymous.

Use getGlobalID() to obtain the unique id of the authority.

Returns
Global Name
std::string getGlobalID ( ) const
inline

Return the fully qualified global id (includes namespace)

Returns
Global ID
std::string getID ( ) const
inline

Return the id of the authority.

Returns
ID
std::string getName ( ) const
inline

Return the name of the authority.

Returns
Name of this authority
const AuthorityDescription& getDescription ( ) const
inline

Return the description of this authority.

virtual StatusManager::StatusMap getStatusMap ( )
pure virtual

Return a status map that contains the status of the authority as well as all registered submodules.

Implemented in Authority, and RemoteAuthority.

virtual boost::shared_ptr<PropertyNode> getProperties ( )
pure virtual

Returns the main property node of this Authority.

Implemented in Authority, RemoteAuthority, and MicroUnit.

virtual std::set<std::string> getPublishedChannels ( )
pure virtual

Returns all published channels by this authority (and its sub-authorities)

Implemented in Authority, and RemoteAuthority.

virtual std::set<std::string> getSubscribedChannels ( )
pure virtual

Returns all subscribed channels by this authority (and its sub-authorities)

Implemented in Authority, and RemoteAuthority.

virtual std::set<std::string> getServiceInterfaces ( )
pure virtual

Returns all service interfaces provided by this authority.

Implemented in Authority, and RemoteAuthority.

virtual ChannelNameMapping getPublishedChannelNames ( )
pure virtual

Returns all published channels (pair of global and local names) by this authority (and its sub-authorities)

Implemented in Authority, and RemoteAuthority.

virtual ChannelNameMapping getSubscribedChannelNames ( )
pure virtual

Returns all subscribed channels (pair of global and local names) by this authority (and its sub-authorities)

Implemented in Authority, and RemoteAuthority.

virtual ChannelStatusMap getSubscribedChannelStatus ( )
pure virtual

Returns status for all subscribed channels (ok, no publisher, no data, ...) by this authority (and its sub-authorities)

Implemented in Authority, and RemoteAuthority.

virtual void start ( )
pure virtual

Starts/Resumes the authority.

Implemented in Authority, RemoteAuthority, Unit, MicroUnit, and QtUnit.

virtual void stop ( )
pure virtual

Stops/Pauses the authority. To continue call start().

Implemented in Authority, RemoteAuthority, Unit, and MicroUnit.

virtual bool hasUnrecoverableFailure ( ) const
pure virtual

Returns true, if there was a failure while processing the immediate handlers.

This is an unrecoverable failure that will disallow the further execution of the authority.

Implemented in Authority, and RemoteAuthority.

virtual bool isStarted ( ) const
pure virtual

Returns true, if the authority was started (by calling start()).

It will return false, if the authority was not yet started or stopped.

Implemented in Authority, and RemoteAuthority.

virtual bool isRunning ( ) const
pure virtual

Return if the authority is running.

Implemented in Authority, and RemoteAuthority.

Member Data Documentation

AuthorityDescription mDescription
protected

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