Configuration.hpp

Go to the documentation of this file.

// 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_Configuration_hpp
#define anna_core_oam_Configuration_hpp


#include <anna/core/Singleton.hpp>
#include <anna/core/RuntimeException.hpp>

// STL
#include <string>
#include <vector>

namespace anna {
namespace xml {
class Node;
}
}


namespace anna {

namespace oam {


class Configuration : public anna::Singleton <Configuration> {

  // Post-configuration for the final alarm text used for context data over each module (functionality, logic data, etc.):
  typedef std::vector<std::string> string_vector_t;
  string_vector_t a_alarm_text_preffix_components;
  string_vector_t a_alarm_text_suffix_components;
  bool a_alarms_preffix_enabled;   // Show general alarm preffix
  bool a_alarms_suffix_enabled;    // Show general alarm suffix


  // Delimiters (zone separator for preffix/text/suffix, and left/right/separator for preffix/suffix):
  char a_alarm_text_delimiter_zS;
  std::string a_alarm_text_delimiter_psL;
  std::string a_alarm_text_delimiter_psS;
  std::string a_alarm_text_delimiter_psR;

  const string_vector_t * getAlarmPreffixComponents() const { return (a_alarms_preffix_enabled ? &a_alarm_text_preffix_components : NULL); }
  const string_vector_t * getAlarmSuffixComponents() const { return (a_alarms_suffix_enabled ? &a_alarm_text_suffix_components : NULL); }

  void getAlarmTextDelimiters(char & zS, std::string & psL, std::string & psS, std::string & psR) const ;


  Configuration(); // private constructor

  friend class anna::Singleton <Configuration>;
  friend class Module;

public:

  void setAlarmTextDelimiters(const char zS, const std::string & psL, const std::string & psS, const std::string & psR) ;


  void setAlarmPreffixComponents(const std::vector<std::string> & components) { a_alarm_text_preffix_components = components; }


  void setAlarmSuffixComponents(const std::vector<std::string> & components) { a_alarm_text_suffix_components = components; }


  void enableAlarmsPreffix() ;


  void enableAlarmsSuffix() ;


  void disableAlarmsPreffix() ;


  void disableAlarmsSuffix() ;

  anna::xml::Node* asXML(anna::xml::Node* parent) const ;
};

}
}

#endif