include/anna/core/oam/defines.hpp

   1 // ANNA - Anna is Not Nothingness Anymore                                                         //
   2 //                                                                                                //
   3 // (c) Copyright 2005-2015 Eduardo Ramos Testillano & Francisco Ruiz Rayo                         //
   4 //                                                                                                //
   5 // See project site at http://redmine.teslayout.com/projects/anna-suite                           //
   6 // See accompanying file LICENSE or copy at http://www.teslayout.com/projects/public/anna.LICENSE //
   7
   8
   9 #ifndef anna_core_oam_defines_hpp
  10 #define anna_core_oam_defines_hpp
  11
  12
  13 namespace anna {
  14
  15 namespace oam {
  16
  17
  18 /**
  19    Counter data container
  20 */
  21 typedef struct {
  22   /** Counter id over scope (0-999) */
  23   int Offset;
  24   /** Counter description (same for all cloned scopes...) */
  25   std::string Description;
  26 } counter_data_t;
  27
  28 /**
  29    Alarm data container
  30 */
  31 typedef struct {
  32   /** External text identification */
  33   int ExternalId;
  34   /** Comma-separated list of dynamic variable names (same order than launched with #activateAlarm and #cancelAlarm) */
  35   std::string DynamicVariablesCSL;
  36   /** Alarm activation identifier */
  37   int ActivationId;
  38   /** Alarm cancellation identifier. If missing, the alarm will interpreted as non-transferable */
  39   int CancellationId;
  40   /** Alarm description added within the module. If empty string is provided, default description for non-registered will be searched (#getDefaultInternalAlarmDescription) */
  41   std::string Description;
  42 } alarm_data_t;
  43
  44
  45 }
  46 }
  47
  48 #endif
  49