#include <loggingThrottleAlarmInterface.h>
Inheritance diagram for LogThrottleAlarm:
Public Member Functions | |
| LogThrottleAlarm (std::string faultFamily, std::string faultMember, int faultCode) | |
| virtual | ~LogThrottleAlarm () |
| virtual void | raiseLogThrottleAlarm ()=0 |
| virtual void | clearLogThrottleAlarm ()=0 |
Protected Attributes | |
| const std::string | m_faultFamily |
| const std::string | m_faultMember |
| const int | m_faultCode |
Detailed Description
The logging module is built much before alarms by the ACS/Makefile.
In order to send alarms when the log throttle reaches it maximum allowed number of logs per second, we define here an interface whose implementation must be provided later in maci.
Constructor & Destructor Documentation
| LogThrottleAlarm::LogThrottleAlarm | ( | std::string | faultFamily, | |
| std::string | faultMember, | |||
| int | faultCode | |||
| ) | [inline] |
Constructor
- Parameters:
-
faultFamily The fault family of the alarm to raise/clear faultMember The fault member of the alarm to raise/clear faultCode The fault code of the alarm to raise/clear
| virtual LogThrottleAlarm::~LogThrottleAlarm | ( | ) | [inline, virtual] |
Virtual destructor
Member Function Documentation
| virtual void LogThrottleAlarm::clearLogThrottleAlarm | ( | ) | [pure virtual] |
Clear the alarm when the alarm throttle allowed the logging
Implemented in maci::LogThrottleAlarmImpl.
| virtual void LogThrottleAlarm::raiseLogThrottleAlarm | ( | ) | [pure virtual] |
Raise an alarm when the alarm throttle inhibit the logging
Implemented in maci::LogThrottleAlarmImpl.
Member Data Documentation
const int LogThrottleAlarm::m_faultCode [protected] |
The Fault Code of the log throttle alarm
const std::string LogThrottleAlarm::m_faultFamily [protected] |
The Fault Family of the log throttle alarm
const std::string LogThrottleAlarm::m_faultMember [protected] |
The Fault Member of the log throttle alarm
The documentation for this class was generated from the following file:
