NULL_REPORTER Class Reference

A singleton reporter that reports to nowhere. More...

#include <reporter.h>

Inheritance diagram for NULL_REPORTER:

Public Types
enum	LOCATION { LOC_HEAD = 0 , LOC_BODY , LOC_TAIL }
	Location where the message is to be reported. More...

Public Member Functions
	NULL_REPORTER ()
virtual	~NULL_REPORTER ()
REPORTER &	Report (const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED) override
	Report a string with a given severity. More...
bool	HasMessage () const override
	Returns true if the reporter client is non-empty. More...
REPORTER &	Report (const char *aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)
virtual REPORTER &	ReportTail (const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)
	Places the report at the end of the list, for objects that support report ordering. More...
virtual REPORTER &	ReportHead (const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)
	Places the report at the beginning of the list for objects that support ordering. More...
REPORTER &	operator<< (const wxString &aText)
virtual EDA_UNITS	GetUnits () const

Static Public Member Functions
static REPORTER &	GetInstance ()

Detailed Description

A singleton reporter that reports to nowhere.

Used as to simplify code by avoiding the reportee to check for a non-NULL reporter object.

Definition at line 222 of file reporter.h.

Member Enumeration Documentation

LOCATION

enum REPORTER::LOCATION

inherited

Location where the message is to be reported.

LOC_HEAD messages are printed before all others (typically intro messages) LOC_BODY messages are printed in the middle LOC_TAIL messages are printed after all others (typically status messages)

Enumerator
LOC_HEAD
LOC_BODY
LOC_TAIL

Definition at line 79 of file reporter.h.

 {
 LOC_HEAD = 0,
 LOC_BODY,
 LOC_TAIL
 };

Constructor & Destructor Documentation

NULL_REPORTER()

NULL_REPORTER::NULL_REPORTER ( )

inline

Definition at line 225 of file reporter.h.

 {
 }

Referenced by GetInstance().

~NULL_REPORTER()

virtual NULL_REPORTER::~NULL_REPORTER ( )

inlinevirtual

Definition at line 229 of file reporter.h.

 {
 }

Member Function Documentation

GetInstance()

REPORTER & NULL_REPORTER::GetInstance ( )

static

Definition at line 117 of file reporter.cpp.

{
 static REPORTER* s_nullReporter = nullptr;
 
 if( !s_nullReporter )
 s_nullReporter = new NULL_REPORTER();
 
 return *s_nullReporter;
}

References NULL_REPORTER().

Referenced by BOARD_NETLIST_UPDATER::BOARD_NETLIST_UPDATER(), KICAD_MANAGER_FRAME::CloseProject(), SCH_EDIT_FRAME::doAutoSave(), PCB_EDIT_FRAME::doAutoSave(), and PNS_LOG_PLAYER::PNS_LOG_PLAYER().

GetUnits()

virtual EDA_UNITS REPORTER::GetUnits ( ) const

inlinevirtualinherited

Reimplemented in WX_HTML_REPORT_BOX.

Definition at line 123 of file reporter.h.

 {
 return EDA_UNITS::MILLIMETRES;
 }

References MILLIMETRES.

HasMessage()

bool NULL_REPORTER::HasMessage ( ) const

inlineoverridevirtual

Returns true if the reporter client is non-empty.

Implements REPORTER.

Definition at line 238 of file reporter.h.

{ return false; }

operator<<()

REPORTER & REPORTER::operator<< ( const wxString &  aText )

inlineinherited

Definition at line 116 of file reporter.h.

{ return Report( aText ); }

References REPORTER::Report().

Report() [1/2]

REPORTER & REPORTER::Report ( const char *  aText, SEVERITY  aSeverity = RPT_SEVERITY_UNDEFINED  )

inherited

Definition at line 36 of file reporter.cpp.

{
 Report( FROM_UTF8( aText ) );
 return *this;
}

References FROM_UTF8(), and REPORTER::Report().

Report() [2/2]

REPORTER & NULL_REPORTER::Report ( const wxString &  aText, SEVERITY  aSeverity = RPT_SEVERITY_UNDEFINED  )

overridevirtual

Report a string with a given severity.

Parameters

aText	is the string to report.
aSeverity	is an indicator ( RPT_UNDEFINED, RPT_INFO, RPT_WARNING, RPT_ERROR, RPT_ACTION ) used to filter and format messages

Implements REPORTER.

Definition at line 111 of file reporter.cpp.

{
 return *this;
}

ReportHead()

virtual REPORTER & REPORTER::ReportHead ( const wxString &  aText, SEVERITY  aSeverity = RPT_SEVERITY_UNDEFINED  )

inlinevirtualinherited

Places the report at the beginning of the list for objects that support ordering.

Reimplemented in WX_HTML_PANEL_REPORTER.

Definition at line 108 of file reporter.h.

 {
 return Report( aText, aSeverity );
 }

References REPORTER::Report().

Referenced by BACK_ANNOTATE::applyChangelist(), BACK_ANNOTATE::getPcbModulesFromString(), DIALOG_IMPORT_NETLIST::loadNetlist(), DIALOG_ERC::OnRunERCClick(), BACK_ANNOTATE::processNetNameChange(), DIALOG_EXPORT_NETLIST::TransferDataFromWindow(), and SCH_EDIT_FRAME::WriteNetListFile().

ReportTail()

virtual REPORTER & REPORTER::ReportTail ( const wxString &  aText, SEVERITY  aSeverity = RPT_SEVERITY_UNDEFINED  )

inlinevirtualinherited

Places the report at the end of the list, for objects that support report ordering.

Reimplemented in WX_HTML_PANEL_REPORTER.

Definition at line 99 of file reporter.h.

 {
 return Report( aText, aSeverity );
 }

References REPORTER::Report().

Referenced by SCH_EDIT_FRAME::AnnotateSymbols(), BACK_ANNOTATE::BackAnnotateSymbols(), BACK_ANNOTATE::checkForUnusedSymbols(), EXCELLON_WRITER::CreateDrillandMapFilesSet(), GERBER_WRITER::CreateDrillandMapFilesSet(), SCH_PLOTTER::createDXFFiles(), SCH_PLOTTER::createHPGLFiles(), SCH_PLOTTER::createPDFFile(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), SCH_PLOTTER::createPSFiles(), SCH_PLOTTER::createSVGFiles(), BACK_ANNOTATE::getChangeList(), DIALOG_PLOT::Plot(), GERBER_JOBFILE_READER::ReadGerberJobFile(), BOARD_NETLIST_UPDATER::UpdateNetlist(), SCH_SCREEN::UpdateSymbolLinks(), and SCH_EDIT_FRAME::WriteNetListFile().

---

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

• reporter.h
• reporter.cpp