source: source/ariba/Module.h@ 5481

Last change on this file since 5481 was 2409, checked in by mies, 16 years ago

moved tidy & pingpong

File size: 3.1 KB
Line 
1// [License]
2// The Ariba-Underlay Copyright
3//
4// Copyright (c) 2008-2009, Institute of Telematics, UniversitÀt Karlsruhe (TH)
5//
6// Institute of Telematics
7// UniversitÀt Karlsruhe (TH)
8// Zirkel 2, 76128 Karlsruhe
9// Germany
10//
11// Redistribution and use in source and binary forms, with or without
12// modification, are permitted provided that the following conditions are
13// met:
14//
15// 1. Redistributions of source code must retain the above copyright
16// notice, this list of conditions and the following disclaimer.
17// 2. Redistributions in binary form must reproduce the above copyright
18// notice, this list of conditions and the following disclaimer in the
19// documentation and/or other materials provided with the distribution.
20//
21// THIS SOFTWARE IS PROVIDED BY THE INSTITUTE OF TELEMATICS ``AS IS'' AND
22// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
24// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OF TELEMATICS OR
25// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
26// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
27// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
28// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
29// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
30// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
31// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32//
33// The views and conclusions contained in the software and documentation
34// are those of the authors and should not be interpreted as representing
35// official policies, either expressed or implied, of the Institute of
36// Telematics.
37// [License]
38
39#ifndef MODULE_H_
40#define MODULE_H_
41
42#include <string>
43#include <vector>
44
45// usings
46using std::vector;
47using std::string;
48
49namespace ariba {
50
51/**
52 * This class serves as base class for generic modules that
53 * can be initialized, started, stopped and configured using standard
54 * human-readable properties.
55 *
56 * @author Sebastian Mies <mies@tm.uka.de>
57 */
58class Module {
59public:
60 Module();
61 virtual ~Module();
62
63 /**
64 * This method (re-)initializes this module.
65 */
66 virtual void initialize();
67
68 /**
69 * This method (re-)starts this module
70 */
71 virtual void start();
72
73 /**
74 * This method stops this module
75 */
76 virtual void stop();
77
78 /**
79 * Returns the name of this module
80 *
81 * @return The name of this module
82 */
83 virtual string getName() const;
84
85 /**
86 * Sets a property in this module
87 *
88 * @param key The key of the property
89 * @param value The value of the property
90 */
91 virtual void setProperty( string key, string value );
92
93 /**
94 * Returns the value of a specified property
95 *
96 * @param key The key of the property
97 * @return The value of the property
98 */
99 virtual const string getProperty( string key ) const;
100
101 /**
102 * Returns a vector containing all possible property keys in a
103 * human-readable form
104 *
105 * @return A vector containing all possible property keys
106 */
107 virtual const vector<string> getProperties() const;
108};
109
110} // namespace ariba
111
112#endif /* MODULE_H_ */
Note: See TracBrowser for help on using the repository browser.