ariba::Module Class Reference

#include <source/ariba/Module.h>

Inheritance diagram for ariba::Module:

Inheritance graph
[legend]

List of all members.

Public Member Functions

 Module ()
virtual ~Module ()
virtual void initialize ()
virtual void start ()
virtual void stop ()
virtual string getName () const
virtual void setProperty (string key, string value)
virtual const string getProperty (string key) const
virtual const vector< string > getProperties () const


Detailed Description

This class serves as base class for generic modules that can be initialized, started, stopped and configured using standard human-readable properties.

Author:
Sebastian Mies <mies@tm.uka.de>

Definition at line 58 of file Module.h.


Constructor & Destructor Documentation

ariba::Module::Module (  ) 

Definition at line 44 of file Module.cpp.

ariba::Module::~Module (  )  [virtual]

Definition at line 48 of file Module.cpp.


Member Function Documentation

void ariba::Module::initialize (  )  [virtual]

This method (re-)initializes this module.

Reimplemented in ariba::AribaModule, and ariba::Node.

Definition at line 52 of file Module.cpp.

void ariba::Module::start (  )  [virtual]

This method (re-)starts this module

Reimplemented in ariba::AribaModule, and ariba::Node.

Definition at line 56 of file Module.cpp.

void ariba::Module::stop (  )  [virtual]

This method stops this module

Reimplemented in ariba::AribaModule, and ariba::Node.

Definition at line 60 of file Module.cpp.

string ariba::Module::getName (  )  const [virtual]

Returns the name of this module

Returns:
The name of this module

Reimplemented in ariba::AribaModule, and ariba::Node.

Definition at line 64 of file Module.cpp.

void ariba::Module::setProperty ( string  key,
string  value 
) [virtual]

Sets a property in this module

Parameters:
key The key of the property
value The value of the property

Reimplemented in ariba::AribaModule, and ariba::Node.

Definition at line 69 of file Module.cpp.

const string ariba::Module::getProperty ( string  key  )  const [virtual]

Returns the value of a specified property

Parameters:
key The key of the property
Returns:
The value of the property

Reimplemented in ariba::AribaModule, and ariba::Node.

Definition at line 73 of file Module.cpp.

const vector< string > ariba::Module::getProperties (  )  const [virtual]

Returns a vector containing all possible property keys in a human-readable form

Returns:
A vector containing all possible property keys

Reimplemented in ariba::AribaModule, and ariba::Node.

Definition at line 78 of file Module.cpp.


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

Generated on Wed May 27 18:23:56 2009 for Ariba by  doxygen 1.5.6