KiCad PCB EDA Suite
REPORTER Class Referenceabstract

Class REPORTER is a pure virtual class used to derive REPORTER objects from. More...

#include <reporter.h>

Inheritance diagram for REPORTER:
NULL_REPORTER SPICE_REPORTER STATUS_TEXT_REPORTER WX_HTML_PANEL_REPORTER WX_STRING_REPORTER WX_TEXT_CTRL_REPORTER SIM_THREAD_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

virtual REPORTERReport (const wxString &aText, SEVERITY aSeverity=RPT_UNDEFINED)=0
 Function Report is a pure virtual function to override in the derived object. More...
 
REPORTERReport (const char *aText, SEVERITY aSeverity=RPT_UNDEFINED)
 
REPORTERoperator<< (const wxString &aText)
 
REPORTERoperator<< (const wxChar *aText)
 
REPORTERoperator<< (wxChar aChar)
 
REPORTERoperator<< (const char *aText)
 

Detailed Description

Class REPORTER is a pure virtual class used to derive REPORTER objects from.

The purpose of the REPORTER object is to offer a way for a procedural function to report multiple errors without having to:

  • know too much about the caller's UI, i.e. wx.
  • stop after the first error

the reporter has 4 severity levels (flags) tagging the messages:

  • information
  • warning
  • error
  • action (i.e. indication of changes - add component, change footprint, etc. ) They are indicators for the message formatting and displaying code, filtering is not made here.

Definition at line 61 of file reporter.h.

Member Enumeration Documentation

Severity of the reported messages.

Enumerator
RPT_UNDEFINED 
RPT_INFO 
RPT_WARNING 
RPT_ERROR 
RPT_ACTION 

Definition at line 65 of file reporter.h.

65  {
66  RPT_UNDEFINED = 0x0,
67  RPT_INFO = 0x1,
68  RPT_WARNING = 0x2,
69  RPT_ERROR = 0x4,
70  RPT_ACTION = 0x8
71  };

Member Function Documentation

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

Definition at line 86 of file reporter.h.

References 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)
inline

Definition at line 87 of file reporter.h.

References 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)
inline

Definition at line 88 of file reporter.h.

References 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)
inline

Definition at line 89 of file reporter.h.

References 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.
virtual REPORTER& REPORTER::Report ( const wxString &  aText,
SEVERITY  aSeverity = RPT_UNDEFINED 
)
pure virtual

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

Implemented in NULL_REPORTER, WX_HTML_PANEL_REPORTER, WX_STRING_REPORTER, WX_TEXT_CTRL_REPORTER, SIM_THREAD_REPORTER, and STATUS_TEXT_REPORTER.

Referenced by BOARD_NETLIST_UPDATER::addNewComponent(), DIALOG_PLOT::applyPlotSettings(), NGSPICE::cbSendChar(), DIALOG_EXCHANGE_MODULE::change_1_Module(), GERBER_WRITER::CreateDrillandMapFilesSet(), EXCELLON_WRITER::CreateDrillandMapFilesSet(), DIALOG_PLOT_SCHEMATIC::CreateDXFFile(), DIALOG_GEN_MODULE_POSITION::CreateFiles(), DIALOG_PLOT_SCHEMATIC::createHPGLFile(), GERBER_JOBFILE_WRITER::CreateJobFile(), CINFO3D_VISU::createLayers(), GENDRILL_WRITER_BASE::CreateMapFilesSet(), DIALOG_PLOT_SCHEMATIC::createPDFFile(), DIALOG_PLOT_SCHEMATIC::createPlotFileName(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), DIALOG_PLOT_SCHEMATIC::createPSFile(), DIALOG_PLOT_SCHEMATIC::createSVGFile(), BOARD_NETLIST_UPDATER::deleteSinglePadNets(), BOARD_NETLIST_UPDATER::deleteUnusedComponents(), EnsureFileDirectoryExists(), DIALOG_SVG_PRINT::ExportSVGFile(), CINFO3D_VISU::InitSettings(), PCB_EDIT_FRAME::LoadFootprints(), DIALOG_NETLIST::OnReadNetlistFileClick(), operator<<(), DIALOG_UPDATE_PCB::PerformUpdate(), DIALOG_PLOT::Plot(), DIALOG_EXCHANGE_MODULE::RebuildCmpList(), C3D_RENDER_OGL_LEGACY::Redraw(), C3D_RENDER_RAYTRACING::Redraw(), C3D_RENDER_OGL_LEGACY::reload(), C3D_RENDER_RAYTRACING::reload(), DIALOG_SYMBOL_REMAP::remapSymbolsToLibTable(), C3D_RENDER_RAYTRACING::render(), BOARD_NETLIST_UPDATER::replaceComponent(), BOARD::ReplaceNetlist(), Report(), C3D_RENDER_RAYTRACING::rt_render_post_process_shade(), C3D_RENDER_RAYTRACING::rt_render_tracing(), BOARD_NETLIST_UPDATER::testConnectivity(), GERBVIEW_FRAME::unarchiveFiles(), BOARD_NETLIST_UPDATER::updateComponentPadConnections(), BOARD_NETLIST_UPDATER::updateComponentParameters(), BOARD_NETLIST_UPDATER::UpdateNetlist(), and SCH_EDIT_FRAME::WriteNetListFile().

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

Definition at line 32 of file reporter.cpp.

References FROM_UTF8(), and 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.

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