fesa::Diagnostics Class Reference

Diagnostic infrastructure. More...

#include <Diagnostics.h>

List of all members.

Public Member Functions
	Diagnostics (const FrameworkDiagnostics &frameworkDiagnostics, const boost::shared_ptr< AbstractUserDiagnostics > &userDiagnostics)
	Constructor.
	~Diagnostics ()
	Destructor.
const DiagnosticUtils::DiagnosticTopics &	getTopics (DiagnosticUtils::Side side) const
	Get diagnostic topics.
void	log (const std::string &topic, DiagnosticUtils::DiagnosticMessage &diagMsg)
	Log a diagnostic message.
void	enable (DiagnosticUtils::Side side, const std::string &topic) const
	Enable logging for the given topic.
void	disable (DiagnosticUtils::Side side, const std::string &topic) const
	Disable logging for the given topic.
Private Member Functions
	Diagnostics (const Diagnostics &diagnostics)
Diagnostics &	operator= (const Diagnostics &diagnostics)
Private Attributes
FrameworkDiagnostics	frameworkDiagnostics_
boost::shared_ptr < AbstractUserDiagnostics >	userDiagnostics_

---

Detailed Description

Diagnostic infrastructure.

Definition at line 19 of file Diagnostics.h.

---

Constructor & Destructor Documentation

fesa::Diagnostics::Diagnostics	(	const FrameworkDiagnostics &	frameworkDiagnostics,
		const boost::shared_ptr< AbstractUserDiagnostics > &	userDiagnostics
	)

Constructor.

Parameters:

[in]	frameworkDiagnostics	Diagnostics done on the framework side
[in]	frameworkDiagnostics	Diagnostics done on the user side

Definition at line 14 of file Diagnostics.cpp.

fesa::Diagnostics::~Diagnostics

(

)

Destructor.

Definition at line 21 of file Diagnostics.cpp.

fesa::Diagnostics::Diagnostics

(

const Diagnostics &

diagnostics

)

[private]

---

Member Function Documentation

void fesa::Diagnostics::disable	(	DiagnosticUtils::Side	side,
		const std::string &	topic
	)			const

Disable logging for the given topic.

Parameters:

[in]	side	The side on which diagnostics are performed, framework or user
[in]	topic	The diagnostic topic to disable logging for

Definition at line 82 of file Diagnostics.cpp.

References fesa::FrameworkDiagnostics::disable(), fesa::DiagnosticUtils::framework, frameworkDiagnostics_, fesa::DiagnosticUtils::user, and userDiagnostics_.

void fesa::Diagnostics::enable	(	DiagnosticUtils::Side	side,
		const std::string &	topic
	)			const

Enable logging for the given topic.

Parameters:

[in]	side	The side on which diagnostics are performed, framework or user
[in]	topic	The diagnostic topic to enable logging for

Definition at line 65 of file Diagnostics.cpp.

References fesa::FrameworkDiagnostics::enable(), fesa::DiagnosticUtils::framework, frameworkDiagnostics_, fesa::DiagnosticUtils::user, and userDiagnostics_.

const DiagnosticUtils::DiagnosticTopics & fesa::Diagnostics::getTopics

(

DiagnosticUtils::Side

side

)

const

Get diagnostic topics.

Parameters:

[in]

side

The side on which diagnostics are performed, framework or user

Returns:

List of diagnostic topics for the given side

Definition at line 27 of file Diagnostics.cpp.

References fesa::DiagnosticUtils::framework, frameworkDiagnostics_, fesa::FrameworkDiagnostics::getTopics(), fesa::DiagnosticUtils::user, and userDiagnostics_.

void fesa::Diagnostics::log	(	const std::string &	topic,
		DiagnosticUtils::DiagnosticMessage &	diagMsg
	)

Log a diagnostic message.

Parameters:

[in]	topic	The diagnostic topic which the diagnostic message is concerned with
[in]	diagMsg	The diagnostic message to log

Definition at line 42 of file Diagnostics.cpp.

References fesa::DiagnosticUtils::framework, frameworkDiagnostics_, fesa::FrameworkDiagnostics::log(), fesa::DiagnosticUtils::DiagnosticMessage::name, fesa::DiagnosticUtils::DiagnosticMessage::side, fesa::DiagnosticUtils::user, and userDiagnostics_.

Diagnostics& fesa::Diagnostics::operator=

(

const Diagnostics &

diagnostics

)

[private]

---

Member Data Documentation

FrameworkDiagnostics fesa::Diagnostics::frameworkDiagnostics_ [private]

Definition at line 58 of file Diagnostics.h.

Referenced by disable(), enable(), getTopics(), and log().

boost::shared_ptr<AbstractUserDiagnostics> fesa::Diagnostics::userDiagnostics_ [private]

Definition at line 59 of file Diagnostics.h.

Referenced by disable(), enable(), getTopics(), and log().

---

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

• Diagnostic/Diagnostics.h
• Diagnostic/Diagnostics.cpp