1 // ANNA - Anna is Not Nothingness Anymore
3 // (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
5 // http://redmine.teslayout.com/projects/anna-suite
7 // Redistribution and use in source and binary forms, with or without
8 // modification, are permitted provided that the following conditions
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
17 // * Neither the name of the copyright holder 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.
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.
33 // Authors: eduardo.ramos.testillano@gmail.com
34 // cisco.tierra@gmail.com
37 #ifndef anna_core_util_Component_hpp
38 #define anna_core_util_Component_hpp
42 #include <anna/core/RuntimeException.hpp>
43 #include <anna/core/mt/Mutex.hpp>
54 Component parent class
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.
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.
66 Class* object = anna::functions::component <Class> (FILE_LOCATION);
71 If component 'Class' hasn't been registered, #anna::functions::component will launch an exception.
73 class Component : public anna::Mutex {
81 Gets the class name configured at constructor.
82 \return The class name configured at constructor.
84 const char* getClassName() const throw() { return a_className.c_str(); }
87 * Class string representation
89 * @return String with class content
91 virtual std::string asString(void) const throw();
94 Class XML representation.
95 \param parent XML node over which we will put instance information.
96 \return XML documentcon with class content.
98 virtual anna::xml::Node* asXML(anna::xml::Node* parent) const throw();
105 @param className Logical name for tha class.
107 explicit Component(const char* className);
111 const std::string a_className;
113 //Component (const Component& other);