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_WARNING = 0x2, RPT_ERROR = 0x4,
  RPT_ACTION = 0x8
}
 

Severity of the reported messages.

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

Member Enumeration Documentation

enum REPORTER::SEVERITY
inherited

Severity of the reported messages.

Enumerator
RPT_UNDEFINED 
RPT_INFO 
RPT_WARNING 
RPT_ERROR 
RPT_ACTION 

Definition at line 65 of file reporter.h.

Constructor & Destructor Documentation

NULL_REPORTER::NULL_REPORTER ( )
inline

Definition at line 170 of file reporter.h.

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

171  {
172  }

Member Function Documentation

REPORTER & NULL_REPORTER::GetInstance ( )
static

Definition at line 86 of file reporter.cpp.

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

87 {
88  static REPORTER* s_nullReporter = NULL;
89 
90  if( !s_nullReporter )
91  {
92  s_nullReporter = new NULL_REPORTER();
93  }
94 
95  return *s_nullReporter;
96 }
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 178 of file reporter.h.

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

Definition at line 86 of file reporter.h.

References REPORTER::Report().

86 { 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 87 of file reporter.h.

References REPORTER::Report().

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

References REPORTER::Report().

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

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

89 { 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 81 of file reporter.cpp.

82 {
83  return *this;
84 }

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