include/anna/core/util/Component.hpp

   1 // ANNA - Anna is Not Nothingness 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_Component_hpp
  38 #define anna_core_util_Component_hpp
  39
  40
  41
  42 #include <anna/core/RuntimeException.hpp>
  43 #include <anna/core/mt/Mutex.hpp>
  44
  45 namespace anna {
  46 namespace xml {
  47 class Node;
  48 }
  49 }
  50
  51 namespace anna {
  52
  53 /**
  54    Component parent class
  55
  56    It must be only one instance for each component, but we can't inherit them from anna::Singleton because the
  57    programmer must have the posibility to re-implement the component. The main difference regarding anna components
  58    is that anna component are not associated to the application, allowing to be used on non-anna applications
  59    (instead of anna application, component is got internally through a singleton anna::ComponentManager).
  60    In this way, some anna libraries could build resources based on this, allowing its use by many kind of projects.
  61
  62    ANNA components excludes concept of predecessor component and start/stop procedures, because complete use of
  63    components must be done over pure-anna applications with its anna::app::componet resources.
  64
  65    \code
  66       Class* object = anna::functions::component <Class> (FILE_LOCATION);
  67
  68       ..... object use ....
  69    \endcode
  70
  71    If component 'Class' hasn't been registered, #anna::functions::component will launch an exception.
  72 */
  73 class Component : public anna::Mutex {
  74 public:
  75   /**
  76      Destructor.
  77   */
  78   virtual ~Component();
  79
  80   /**
  81      Gets the class name configured at constructor.
  82      \return The class name configured at constructor.
  83   */
  84   const char* getClassName() const throw() { return a_className.c_str(); }
  85
  86   /**
  87   * Class string representation
  88   *
  89   * @return String with class content
  90   */
  91   virtual std::string asString(void) const throw();
  92
  93   /**
  94      Class XML representation.
  95      \param parent XML node over which we will put instance information.
  96      \return XML documentcon with class content.
  97   */
  98   virtual anna::xml::Node* asXML(anna::xml::Node* parent) const throw();
  99
 100
 101 protected:
 102
 103   /**
 104      Contructor.
 105      @param className Logical name for tha class.
 106   */
 107   explicit Component(const char* className);
 108
 109 private:
 110
 111   const std::string a_className;
 112
 113   //Component (const Component& other);
 114 };
 115
 116 }
 117
 118 #endif
 119