ObserverSignatureRegistry.hpp
Go to the documentation of this file.
1 /*
2 
3  This file is part of OpenFLUID software
4  Copyright(c) 2007, INRA - Montpellier SupAgro
5 
6 
7  == GNU General Public License Usage ==
8 
9  OpenFLUID is free software: you can redistribute it and/or modify
10  it under the terms of the GNU General Public License as published by
11  the Free Software Foundation, either version 3 of the License, or
12  (at your option) any later version.
13 
14  OpenFLUID is distributed in the hope that it will be useful,
15  but WITHOUT ANY WARRANTY; without even the implied warranty of
16  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  GNU General Public License for more details.
18 
19  You should have received a copy of the GNU General Public License
20  along with OpenFLUID. If not, see <http://www.gnu.org/licenses/>.
21 
22 
23  == Other Usage ==
24 
25  Other Usage means a use of OpenFLUID that is inconsistent with the GPL
26  license, and requires a written agreement between You and INRA.
27  Licensees for Other Usage of OpenFLUID may use this file in accordance
28  with the terms contained in the written agreement between You and INRA.
29 
30 */
31 
32 /**
33  @file ObserverSignatureRegistry.hpp
34 
35  @author Aline LIBRES <aline.libres@gmail.com>
36  @author Jean-Christophe Fabre <jean-christophe.fabre@supagro.inra.fr>
37 */
38 
39 
40 #ifndef __OPENFLUID_MACHINE_OBSERVERSIGNATUREREGISTRY_HPP__
41 #define __OPENFLUID_MACHINE_OBSERVERSIGNATUREREGISTRY_HPP__
42 
43 
44 #include <vector>
45 #include <string>
46 
47 #include <openfluid/dllexport.hpp>
50 
51 
52 namespace openfluid { namespace machine {
53 
54 
55 class ObserverSignatureInstance;
56 
57 
58 class OPENFLUID_API ObserverSignatureRegistry : public WareSignatureRegistry<ObserverSignatureInstance>
59 {
60 
62 
63 
64  private:
65 
66  std::vector<ObserverSignatureInstance*> m_AvailableSignatures;
67 
69 
70  virtual ~ObserverSignatureRegistry();
71 
72 
73  public:
74 
75  /**
76  @brief Returns the Signature of the Observer with ObserverID if available
77  @throw openfluid::base::FrameworkException if this Observer plugin is not available
78  */
80 
81  /**
82  @brief Updates the list of available signatures, according to Runtime environment paths
83  */
84  void update();
85 
86  const std::vector<openfluid::machine::ObserverSignatureInstance*>& getAvailableSignatures() const;
87 
88  void unloadAll();
89 
90 };
91 
92 
93 } } // namespaces
94 
95 
96 #endif /* OBSERVERSIGNATUREREGISTRY_HPP_ */
Definition: WareSignatureRegistry.hpp:50
std::string WareID_t
Definition: TypeDefs.hpp:50
Definition: ObserverSignatureRegistry.hpp:58
#define OPENFLUID_SINGLETON_DEFINITION(T)
Definition: SingletonMacros.hpp:78
Definition: ApplicationException.hpp:47
Definition: ObserverInstance.hpp:53
#define OPENFLUID_API
Definition: dllexport.hpp:87