EMANE  1.2.1
component.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2013-2014 - Adjacent Link LLC, Bridgewater, New Jersey
3  * Copyright (c) 2008 - DRS CenGen, LLC, Columbia, Maryland
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * * Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12  * * Redistributions in binary form must reproduce the above copyright
13  * notice, this list of conditions and the following disclaimer in
14  * the documentation and/or other materials provided with the
15  * distribution.
16  * * Neither the name of DRS CenGen, LLC nor the names of its
17  * contributors may be used to endorse or promote products derived
18  * from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
24  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
27  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
30  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31  * POSSIBILITY OF SUCH DAMAGE.
32  */
33 
34 #ifndef EMANECOMPONENT_HEADER_
35 #define EMANECOMPONENT_HEADER_
36 
37 #include "emane/registrar.h"
39 
40 #include <list>
41 
42 namespace EMANE
43 {
50 
51 
57  class StopException{};
58 
59 
81  class Component
82  {
83  public:
84  virtual ~Component(){}
85 
92  virtual void initialize(Registrar & registrar) = 0;
93 
102  virtual void configure(const ConfigurationUpdate & update) = 0;
103 
111  // start the component
112  virtual void start() = 0;
113 
114 
119  virtual void postStart(){};
120 
127  virtual void stop() = 0;
128 
132  virtual void destroy() throw() = 0;
133 
134  protected:
136  };
137 }
138 
139 #endif //EMANECOMPONENT_HEADER_
140 
virtual ~Component()
Definition: component.h:84
The Registrar interface provides access to all of the emulator registrars.
Definition: registrar.h:50
virtual void postStart()
Definition: component.h:119
Exception thrown during a component stop.
Definition: component.h:57
std::vector< ConfigurationNameAnyValues > ConfigurationUpdate
Exception thrown during component initialization.
Definition: component.h:49
Definition: agent.h:43
Generic interface used to configure and control all components.
Definition: component.h:81