fesa-core  5.0.1
fesa::AbstractUserDiagnostics Class Referenceabstract

User side diagnostic infrastructure. More...

#include <AbstractUserDiagnostics.h>

Public Member Functions

virtual ~AbstractUserDiagnostics ()
 Destructor.
 
virtual const
DiagnosticsDefs::DiagnosticTopics & 
getTopics () const =0
 Get diagnostic topics. More...
 
virtual void log (const std::string &topic, DiagnosticsDefs::DiagnosticMessage &diagMsg)=0
 Log a diagnostic message. More...
 
virtual void enable (const std::string &topic) const =0
 Enable logging for the given topic. More...
 
virtual void disable (const std::string &topic) const =0
 Disable logging for the given topic. More...
 

Protected Member Functions

 AbstractUserDiagnostics ()
 Constructor.
 

Detailed Description

User side diagnostic infrastructure.

Member Function Documentation

virtual void fesa::AbstractUserDiagnostics::disable ( const std::string &  topic) const
pure virtual

Disable logging for the given topic.

Parameters
[in]topicThe diagnostic topic to disable logging for
virtual void fesa::AbstractUserDiagnostics::enable ( const std::string &  topic) const
pure virtual

Enable logging for the given topic.

Parameters
[in]topicThe diagnostic topic to enable logging for
virtual const DiagnosticsDefs::DiagnosticTopics& fesa::AbstractUserDiagnostics::getTopics ( ) const
pure virtual

Get diagnostic topics.

Returns
List of diagnostic topics
virtual void fesa::AbstractUserDiagnostics::log ( const std::string &  topic,
DiagnosticsDefs::DiagnosticMessage diagMsg 
)
pure virtual

Log a diagnostic message.

Parameters
[in]topicThe diagnostic topic which the diagnostic message is concerned with
[in]diagnosticMessageThe diagnostic message to log

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