anna::oam::Configuration Class Reference

#include <Configuration.hpp>

Inheritance diagram for anna::oam::Configuration:

Collaboration diagram for anna::oam::Configuration:

Public Member Functions
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)
void	setAlarmSuffixComponents (const std::vector< std::string > &components)
void	enableAlarmsPreffix ()
void	enableAlarmsSuffix ()
void	disableAlarmsPreffix ()
void	disableAlarmsSuffix ()
anna::xml::Node *	asXML (anna::xml::Node *parent) const

Friends
class	anna::Singleton< Configuration >
class	Module

Additional Inherited Members
Static Public Member Functions inherited from anna::Singleton< T >
static T &	instantiate ()
static void	release ()

Detailed Description

Class used for general OAM configuration

Member Function Documentation

asXML()

anna::xml::Node* anna::oam::Configuration::asXML

(

anna::xml::Node *

parent

)

const

Class XML representation

Returns

XML with class content

disableAlarmsPreffix()

void anna::oam::Configuration::disableAlarmsPreffix

(

)

Hide general alarm preffix (enabled by default at constructor).

disableAlarmsSuffix()

void anna::oam::Configuration::disableAlarmsSuffix

(

)

Hide general alarm suffix (enabled by default at constructor).

enableAlarmsPreffix()

void anna::oam::Configuration::enableAlarmsPreffix

(

)

Show general alarm preffix (enabled by default at constructor).

enableAlarmsSuffix()

void anna::oam::Configuration::enableAlarmsSuffix

(

)

Show general alarm suffix (enabled by default at constructor).

setAlarmPreffixComponents()

void anna::oam::Configuration::setAlarmPreffixComponents ( const std::vector< std::string > &  components )

inline

Optional preffix definition to modify dinamically the alarm texts at context. This affects to all the management modules. It is usually used on application start tipically with the facility name, although this information is already shown at the EG component but easier to identify through that detailed text. Note that preffix components string should be multilanguage texts.

Parameters

components

Preffix components for alarm text

{ a_alarm_text_preffix_components = components; }

setAlarmSuffixComponents()

void anna::oam::Configuration::setAlarmSuffixComponents ( const std::vector< std::string > &  components )

inline

Optional suffix definition to modify dinamically the alarm texts at context. This affects to all the management modules. It is usually used by application libraries tipically with the oam module name. However this information could be only useful for developers, and usually would be set by each oam module. Note that suffix components string should be multilanguage texts.

Parameters

components

Suffix components for alarm text

{ a_alarm_text_suffix_components = components; }

setAlarmTextDelimiters()

void anna::oam::Configuration::setAlarmTextDelimiters	(	const char	zS,
		const std::string &	psL,
		const std::string &	psS,
		const std::string &	psR
	)

Final detailed alarm text is composed by three parts: preffix, database text and suffix. To separate these zones, we configure the zone separator (space character by default). Within preffix/suffix we can configure left, right and separator delimiters (by default, we use square brackets and pipe):

     ------- preffix -------        ------- suffix -------
    [ pc1 | pc2 | ... | pcM ] text [ sc1 | sc2 | ... | scN ]

    Then, pc[i]/sc[i] are the preffix/suffix components.
    Usually, 'pc1' is the application facility name.
    Dashes could be used instead of pipe '|' with nice result.

Parameters

zS	Zone separator delimiter
psL	Preffix/Suffix left delimiter
psS	Preffix/Suffix separator delimiter
psR	Preffix/Suffix right delimiter

Friends And Related Function Documentation

anna::Singleton< Configuration >

friend class anna::Singleton< Configuration >

friend

Module

friend class Module

friend

---

The documentation for this class was generated from the following file:

• /tmp/anna/include/anna/core/oam/Configuration.hpp