include/anna/core/util/ComponentManager.hpp

   1 // ANNA - Anna is Not 'N' Anymore
   2 //
   3 // (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
   4 //
   5 // https://bitbucket.org/testillano/anna
   6 //
   7 // Redistribution and use in source and binary forms, with or without
   8 // modification, are permitted provided that the following conditions
   9 // are met:
  10 //
  11 //     * Redistributions of source code must retain the above copyright
  12 // notice, this list of conditions and the following disclaimer.
  13 //     * Redistributions in binary form must reproduce the above
  14 // copyright notice, this list of conditions and the following disclaimer
  15 // in the documentation and/or other materials provided with the
  16 // distribution.
  17 //     * Neither the name of Google Inc. nor the names of its
  18 // contributors may be used to endorse or promote products derived from
  19 // this software without specific prior written permission.
  20 //
  21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32 //
  33 // Authors: eduardo.ramos.testillano@gmail.com
  34 //          cisco.tierra@gmail.com
  35
  36
  37 #ifndef anna_core_util_ComponentManager_hpp
  38 #define anna_core_util_ComponentManager_hpp
  39
  40 #include <anna/core/Singleton.hpp>
  41 #include <anna/core/RuntimeException.hpp>
  42
  43 // STL
  44 #include <string>
  45 #include <map>
  46
  47 namespace anna {
  48 namespace xml {
  49 class Node;
  50 }
  51 }
  52
  53 namespace anna {
  54
  55 class Component;
  56
  57 class ComponentManager : public Singleton <ComponentManager> {
  58
  59 public:
  60
  61   /**
  62      Returns component instance for the class name provided, <null> if not found.
  63      \return component instance for the class name provided, <null> if not found.
  64   */
  65   Component* find(const char* className) throw();
  66
  67   /**
  68      Class XML representation.
  69      \param parent XML node over which we will put instance information.
  70      \return XML documentcon with class content.
  71   */
  72   virtual xml::Node* asXML(xml::Node* parent) const throw();
  73
  74
  75 private:
  76
  77   std::map < std::string /* class name */, Component* > a_components;
  78
  79
  80   // private constructor
  81   ComponentManager() {};
  82
  83   void attach(Component*) throw(RuntimeException);
  84   void detach(Component*) throw(RuntimeException);
  85
  86
  87   friend class Singleton <ComponentManager>;
  88   friend class Component;  // to access attach & detach
  89 };
  90
  91 }
  92
  93 #endif
  94