ts::ReporterBase Class Reference

Base class for classes using a Report object. More...

#include <tsReporterBase.h>

Inheritance diagram for ts::ReporterBase:

Public Member Functions
	ReporterBase (Report *report=nullptr)
	Constructor.
	ReporterBase (ReporterBase *delegate)
	Constructor.
virtual	~ReporterBase ()
	Destructor.
bool	muteReport (bool mute)
	Temporarily mute the associated report.
Report &	report () const
	Access the Report which is associated with this object.
Report *	setReport (Report *report)
	Associate this object with another Report to log errors.
ReporterBase *	setReport (ReporterBase *delegate)
	Associate this object with another ReporterBase to log errors.

Static Public Member Functions
static int	SilentLevel (bool silent)
	Compute a log severity level from a "silent" parameter.

Detailed Description

Base class for classes using a Report object.

Constructor & Destructor Documentation

ReporterBase() [1/2]

ts::ReporterBase::ReporterBase ( Report *  report = nullptr )

inlineexplicit

Constructor.

Parameters

[in]

report

Where to report errors. The report object must remain valid as long as this object exists or setReport() is used with another Report object. If report is null, log messages are discarded.

ReporterBase() [2/2]

ts::ReporterBase::ReporterBase ( ReporterBase *  delegate )

inlineexplicit

Constructor.

Parameters

[in]

delegate

Use the report of another ReporterBase. If delegate is null, log messages are discarded.

Member Function Documentation

report()

Report & ts::ReporterBase::report

(

)

const

Access the Report which is associated with this object.

Can be called from another thread only if the Report object is thread-safe.

Returns

A reference to the associated report.

setReport() [1/2]

Report * ts::ReporterBase::setReport

(

Report *

report

)

Associate this object with another Report to log errors.

Parameters

[in]

report

Where to report errors. The report object must remain valid as long as this object exists or setReport() is used with another Report object. If report is null, log messages are discarded.

Returns

The address of the previous Report object or a null pointer if there was none.

setReport() [2/2]

ReporterBase * ts::ReporterBase::setReport

(

ReporterBase *

delegate

)

Associate this object with another ReporterBase to log errors.

Parameters

[in]

delegate

Use the report of another ReporterBase. If delegate is null, the previous explicit Report is used..

Returns

The address of the previous ReporterBase object or a null pointer if there was none.

muteReport()

bool ts::ReporterBase::muteReport

(

bool

mute

)

Temporarily mute the associated report.

Parameters

[in]

mute

It true, report() will return a null report (log messages are discarded), until muteReport() is invoked again with mute set to false.

Returns

Previous state of the mute field.

SilentLevel()

static int ts::ReporterBase::SilentLevel ( bool  silent )

inlinestatic

Compute a log severity level from a "silent" parameter.

Some subclass methods have a "silent" parameter to avoid reporting errors which may be insignificant, typically when closing a device after an error, in which case the close operation may produce other errors if the previous error left the device in an inconsistent state. While those errors should not be displayed as errors, we still display them at debug level.

Parameters

[in]

silent

If true, do not report errors, report debug messages instead.

Returns

Error when silent is false, Debug otherwise.

---

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

• tsReporterBase.h