Allow separate stacks registration through services operation
[anna.git] / include / anna / core / oam / Module.hpp
index 032c3a3..520bef2 100644 (file)
@@ -1,37 +1,9 @@
-// ANNA - Anna is Not Nothingness Anymore
-//
-// (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
-//
-// http://redmine.teslayout.com/projects/anna-suite
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions
-// are met:
-//
-//     * Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-//     * Redistributions in binary form must reproduce the above
-// copyright notice, this list of conditions and the following disclaimer
-// in the documentation and/or other materials provided with the
-// distribution.
-//     *  Neither the name of the copyright holder nor the names of its
-// contributors may be used to endorse or promote products derived from
-// this software without specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-//
-// Authors: eduardo.ramos.testillano@gmail.com
-//          cisco.tierra@gmail.com
+// ANNA - Anna is Not Nothingness Anymore                                                         //
+//                                                                                                //
+// (c) Copyright 2005-2015 Eduardo Ramos Testillano & Francisco Ruiz Rayo                         //
+//                                                                                                //
+// See project site at http://redmine.teslayout.com/projects/anna-suite                           //
+// See accompanying file LICENSE or copy at http://www.teslayout.com/projects/public/anna.LICENSE //
 
 
 #ifndef anna_core_oam_Module_hpp
@@ -164,15 +136,10 @@ class Module {
 
   Handler a_defaultHandler;        // default OAM handler
   Handler *a_handler;              // Handler reference
+  std::string a_name;         // module description
 
-  std::string a_className;         // module description
-  bool a_counters_enabled;         // Enable/Disable registered counters over this module (default is 'true')
-  bool a_alarms_enabled;           // Enable/Disable registered alarms over this module (default is 'true')
-
-  // dynamic modifications over alarm text
-  bool a_alarms_preffix_enabled;   // Show own module alarm preffix
-  bool a_alarms_suffix_enabled;    // Show own module alarm suffix
-  std::string alarmComponentsToText(const std::vector<std::string> & components, const std::string & psL, const std::string & psS, const std::string & psR) const throw();
+  bool a_counters_enabled;         // Enable/Disable registered counters over this module (default is 'false')
+  bool a_alarms_enabled;           // Enable/Disable registered alarms over this module (default is 'false')
 
   // GENERIC COUNTERS
   anna::oam::CounterScope* a_active_counter_scope; // Current scope for counters generation
@@ -184,9 +151,13 @@ class Module {
   // GENERIC ALARMS
   typedef std::map < int /*type*/, alarm_data_t > alarm_container;
   alarm_container a_alarms;
-
   void alarmEvent(bool activation, const int & type, va_list argList) const throw();
 
+  // dynamic modifications over alarm text
+  bool a_alarms_preffix_enabled;   // Show own module alarm preffix
+  bool a_alarms_suffix_enabled;    // Show own module alarm suffix
+  std::string alarmComponentsToText(const std::vector<std::string> & components, const std::string & psL, const std::string & psS, const std::string & psR) const throw();
+
   // Counters
   typedef scope_container::iterator scope_iterator;
   typedef scope_container::const_iterator const_scope_iterator;
@@ -230,29 +201,33 @@ class Module {
   alarm_iterator alarm_end() throw() { return a_alarms.end(); }
   void getAlarmPreffixSuffixAndZoneSeparator(std::string & preffix, std::string & suffix, char & zS) const throw();
 
-
 public:
 
-  static const int MaxScope = 100; /**< Numero maximo de ambitos */
+  static const int MaxScope = 1000; /**< Numero maximo de ambitos */
 
 
   /** Constructor
-      @param className Logical name for the class (better use fullNaming format including namespace resolution)
+      @param name Logical name for the class (better use fullNaming format including namespace resolution)
    */
-  Module(const std::string &className) :    a_className(className),
+  Module(const std::string &name) :
     a_handler(&a_defaultHandler),
-    a_counters_enabled(true),
-    a_counterRecorder(NULL),
-    a_counterRecording(false),
-    a_alarms_enabled(true),
+    a_name(name),
+    a_counters_enabled(false),
+    a_alarms_enabled(false),
     a_alarms_preffix_enabled(true),
-    a_alarms_suffix_enabled(true) {;}
+    a_alarms_suffix_enabled(true),
+    a_counterRecorder(NULL),
+    a_counterRecording(false) {;}
 
   /**
    * Destructor
    */
   virtual ~Module();
 
+  /**
+  * Number of scopes registered
+  */
+  int scopes() const { return a_scopes.size(); }
 
   /**
   * Enable all the counters registered in this module (enabled by default at constructor).
@@ -278,6 +253,16 @@ public:
   */
   void disableAlarms(void) throw();
 
+  /**
+    Getter for counters enabled
+  */
+  bool countersEnabled() const throw() { return a_counters_enabled; }
+
+  /**
+    Getter for alarms enabled
+  */
+  bool alarmsEnabled() const throw() { return a_alarms_enabled; }
+
   /**
   * Show own module alarm preffix (enabled by default at constructor).
   * Usually managed at PROCCESS implementation
@@ -404,7 +389,7 @@ public:
 
      @param OAM module name
   */
-  const char *getClassName() const throw() { return a_className.c_str(); }
+  const char *getName() const throw() { return a_name.c_str(); }
 
 
   /**