KiCad PCB EDA Suite
NULL_REPORTER Class Reference

Class NULL_REPORTER. More...

#include <reporter.h>

Inheritance diagram for NULL_REPORTER:
REPORTER

Public Types

enum  SEVERITY {
  RPT_UNDEFINED = 0x0, RPT_INFO = 0x1, RPT_ACTION = 0x2, RPT_WARNING = 0x4,
  RPT_ERROR = 0x8
}
 Severity of the reported messages. More...
 
enum  LOCATION { LOC_HEAD = 0, LOC_BODY, LOC_TAIL }
 Location where the message is to be reported. More...
 

Public Member Functions

 NULL_REPORTER ()
 
REPORTERReport (const wxString &aText, SEVERITY aSeverity=RPT_UNDEFINED) override
 Function Report is a pure virtual function to override in the derived object. More...
 
bool HasMessage () const override
 Function HasMessage Returns true if the reporter client is non-empty. More...
 
REPORTERReport (const char *aText, SEVERITY aSeverity=RPT_UNDEFINED)
 
virtual REPORTERReportTail (const wxString &aText, SEVERITY aSeverity=RPT_UNDEFINED)
 Function ReportTail Places the report at the end of the list, for objects that support report ordering. More...
 
virtual REPORTERReportHead (const wxString &aText, SEVERITY aSeverity=RPT_UNDEFINED)
 Function ReportHead Places the report at the beginning of the list for objects that support ordering. More...
 
REPORTERoperator<< (const wxString &aText)
 
REPORTERoperator<< (const wxChar *aText)
 
REPORTERoperator<< (wxChar aChar)
 
REPORTERoperator<< (const char *aText)
 

Static Public Member Functions

static REPORTERGetInstance ()
 

Detailed Description

Class NULL_REPORTER.

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 210 of file reporter.h.

Member Enumeration Documentation

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 88 of file reporter.h.

88  {
89  LOC_HEAD = 0,
90  LOC_BODY,
91  LOC_TAIL
92  };
enum REPORTER::SEVERITY
inherited

Severity of the reported messages.

Undefined are default status messages Info are processing messages for which no action is taken Action messages are items that modify the file(s) as expected Warning messages are items that might be problematic but don't prevent the process from completing Error messages are items that prevent the process from completing

Enumerator
RPT_UNDEFINED 
RPT_INFO 
RPT_ACTION 
RPT_WARNING 
RPT_ERROR 

Definition at line 74 of file reporter.h.

Constructor & Destructor Documentation

NULL_REPORTER::NULL_REPORTER ( )
inline

Definition at line 213 of file reporter.h.

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

214  {
215  }

Member Function Documentation

REPORTER & NULL_REPORTER::GetInstance ( )
static

Definition at line 104 of file reporter.cpp.

Referenced by BOARD_NETLIST_UPDATER::BOARD_NETLIST_UPDATER(), SCH_EDIT_FRAME::doUpdatePcb(), and SCH_EDIT_FRAME::prepareForNetlist().

105 {
106  static REPORTER* s_nullReporter = NULL;
107 
108  if( !s_nullReporter )
109  {
110  s_nullReporter = new NULL_REPORTER();
111  }
112 
113  return *s_nullReporter;
114 }
Class REPORTER is a pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:61
bool NULL_REPORTER::HasMessage ( ) const
inlineoverridevirtual

Function HasMessage Returns true if the reporter client is non-empty.

Implements REPORTER.

Definition at line 221 of file reporter.h.

221 { return false; }
REPORTER& REPORTER::operator<< ( const wxString &  aText)
inlineinherited

Definition at line 125 of file reporter.h.

References REPORTER::Report().

125 { return Report( aText ); }
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_UNDEFINED)=0
Function Report is a pure virtual function to override in the derived object.
REPORTER& REPORTER::operator<< ( const wxChar *  aText)
inlineinherited

Definition at line 126 of file reporter.h.

References REPORTER::Report().

126 { return Report( wxString( aText ) ); }
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_UNDEFINED)=0
Function Report is a pure virtual function to override in the derived object.
REPORTER& REPORTER::operator<< ( wxChar  aChar)
inlineinherited

Definition at line 127 of file reporter.h.

References REPORTER::Report().

127 { return Report( wxString( aChar ) ); }
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_UNDEFINED)=0
Function Report is a pure virtual function to override in the derived object.
REPORTER& REPORTER::operator<< ( const char *  aText)
inlineinherited

Definition at line 128 of file reporter.h.

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

128 { return Report( aText ); }
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_UNDEFINED)=0
Function Report is a pure virtual function to override in the derived object.
REPORTER & REPORTER::Report ( const char *  aText,
REPORTER::SEVERITY  aSeverity = RPT_UNDEFINED 
)
inherited

Definition at line 32 of file reporter.cpp.

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

33 {
34  Report( FROM_UTF8( aText ) );
35  return *this;
36 }
static wxString FROM_UTF8(const char *cstring)
function FROM_UTF8 converts a UTF8 encoded C string to a wxString for all wxWidgets build modes...
Definition: macros.h:53
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_UNDEFINED)=0
Function Report is a pure virtual function to override in the derived object.
REPORTER & NULL_REPORTER::Report ( const wxString &  aText,
SEVERITY  aSeverity = RPT_UNDEFINED 
)
overridevirtual

Function Report is a pure virtual function to override in the derived object.

Parameters
aTextis the string to report.
aSeverityis an indicator ( RPT_UNDEFINED, RPT_INFO, RPT_WARNING, RPT_ERROR, RPT_ACTION ) used to filter and format messages

Implements REPORTER.

Definition at line 99 of file reporter.cpp.

100 {
101  return *this;
102 }
virtual REPORTER& REPORTER::ReportHead ( const wxString &  aText,
SEVERITY  aSeverity = RPT_UNDEFINED 
)
inlinevirtualinherited

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

Reimplemented in WX_HTML_PANEL_REPORTER.

Definition at line 118 of file reporter.h.

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

Referenced by DIALOG_NETLIST::loadNetlist(), DIALOG_EXPORT_STEP::onExportButton(), SCH_EDIT_FRAME::WriteNetListFile(), and WX_HTML_PANEL_REPORTER::WX_HTML_PANEL_REPORTER().

119  {
120  return Report( aText, aSeverity );
121  }
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_UNDEFINED)=0
Function Report is a pure virtual function to override in the derived object.
virtual REPORTER& REPORTER::ReportTail ( const wxString &  aText,
SEVERITY  aSeverity = RPT_UNDEFINED 
)
inlinevirtualinherited

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

Reimplemented in WX_HTML_PANEL_REPORTER.

Definition at line 109 of file reporter.h.

References REPORTER::Report().

Referenced by SCH_EDIT_FRAME::AnnotateComponents(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), DIALOG_EXPORT_STEP::onExportButton(), GERBER_JOBFILE_READER::ReadGerberJobFile(), DIALOG_ERC::TestErc(), BOARD_NETLIST_UPDATER::UpdateNetlist(), SCH_EDIT_FRAME::WriteNetListFile(), and WX_HTML_PANEL_REPORTER::WX_HTML_PANEL_REPORTER().

110  {
111  return Report( aText, aSeverity );
112  }
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_UNDEFINED)=0
Function Report is a pure virtual function to override in the derived object.

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