![]() |
KiCad PCB EDA Suite
|
A pure virtual class used to derive REPORTER objects from. More...
#include <reporter.h>
Public Types | |
enum | LOCATION { LOC_HEAD = 0, LOC_BODY, LOC_TAIL } |
Location where the message is to be reported. More... | |
Public Member Functions | |
virtual REPORTER & | Report (const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)=0 |
Report a string with a given severity. More... | |
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 & | Report (const char *aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED) |
REPORTER & | operator<< (const wxString &aText) |
REPORTER & | operator<< (const wxChar *aText) |
REPORTER & | operator<< (wxChar aChar) |
REPORTER & | operator<< (const char *aText) |
virtual bool | HasMessage () const =0 |
Returns true if the reporter client is non-empty. More... | |
virtual EDA_UNITS | GetUnits () const |
virtual | ~REPORTER () |
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:
the reporter has 4 severity levels (flags) tagging the messages:
They are indicators for the message formatting and displaying code, filtering is not made here.
Definition at line 64 of file reporter.h.
enum REPORTER::LOCATION |
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 73 of file reporter.h.
|
inlinevirtual |
Definition at line 125 of file reporter.h.
|
inlinevirtual |
Reimplemented in WX_HTML_REPORT_BOX.
Definition at line 120 of file reporter.h.
References MILLIMETRES.
Referenced by BOARD_INSPECTION_TOOL::reportClearance(), and BOARD_INSPECTION_TOOL::reportZoneConnection().
|
pure virtual |
Returns true if the reporter client is non-empty.
Implemented in INFOBAR_REPORTER, STATUSBAR_REPORTER, STDOUT_REPORTER, NULL_REPORTER, WX_HTML_PANEL_REPORTER, WX_STRING_REPORTER, WX_TEXT_CTRL_REPORTER, CONSOLE_MSG_REPORTER, SIM_THREAD_REPORTER, WX_STRING_REPORTER_FILTERED, and WX_HTML_REPORT_BOX.
Referenced by DIALOG_ANNOTATE::OnApplyClick(), and DRC_RULES_PARSER::Parse().
|
inline |
Definition at line 110 of file reporter.h.
References Report().
|
inline |
Definition at line 111 of file reporter.h.
References Report().
|
inline |
Definition at line 112 of file reporter.h.
References Report().
|
inline |
Definition at line 113 of file reporter.h.
References Report().
|
pure virtual |
Report a string with a given severity.
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 |
Implemented in INFOBAR_REPORTER, STATUSBAR_REPORTER, STDOUT_REPORTER, NULL_REPORTER, WX_HTML_PANEL_REPORTER, WX_STRING_REPORTER, WX_TEXT_CTRL_REPORTER, CONSOLE_MSG_REPORTER, SIM_THREAD_REPORTER, WX_STRING_REPORTER_FILTERED, and WX_HTML_REPORT_BOX.
Referenced by GERBER_JOBFILE_WRITER::addJSONFilesAttributes(), GERBER_JOBFILE_WRITER::addJSONMaterialStackup(), BOARD_NETLIST_UPDATER::addNewComponent(), SCH_EDIT_FRAME::AnnotateComponents(), DIALOG_PLOT::applyPlotSettings(), PROJECT_ARCHIVER::Archive(), DIALOG_SYMBOL_REMAP::backupProject(), NGSPICE::cbSendChar(), DRC_RULE_CONDITION::Compile(), DIALOG_GEN_FOOTPRINT_POSITION::CreateAsciiFiles(), GERBER_WRITER::CreateDrillandMapFilesSet(), EXCELLON_WRITER::CreateDrillandMapFilesSet(), DIALOG_PLOT_SCHEMATIC::CreateDXFFile(), DIALOG_GEN_FOOTPRINT_POSITION::CreateGerberFiles(), DIALOG_PLOT_SCHEMATIC::createHPGLFile(), GERBER_JOBFILE_WRITER::CreateJobFile(), BOARD_ADAPTER::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(), EnsureFileDirectoryExists(), DRC_RULE_CONDITION::EvaluateFor(), DIALOG_EXPORT_SVG::ExportSVGFile(), HYPERLYNX_EXPORTER::formatPadShape(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), BOARD_ADAPTER::InitSettings(), RENDER_3D_LEGACY::load3dModels(), PCB_EDIT_FRAME::LoadFootprints(), DIALOG_NETLIST::onFilenameChanged(), operator<<(), DRC_RULES_PARSER::Parse(), DRC_RULES_PARSER::parseValueWithUnits(), DIALOG_PLOT::Plot(), RENDER_3D_RAYTRACE::postProcessShading(), RENDER_3D_LEGACY::Redraw(), RENDER_3D_RAYTRACE::Redraw(), RENDER_3D_RAYTRACE::Reload(), RENDER_3D_LEGACY::reload(), DIALOG_SYMBOL_REMAP::remapSymbolsToLibTable(), RENDER_3D_RAYTRACE::render(), RENDER_3D_RAYTRACE::renderTracing(), BOARD_NETLIST_UPDATER::replaceComponent(), Report(), DRC_ENGINE::ReportAux(), BOARD_INSPECTION_TOOL::reportClearance(), DRC_RULES_PARSER::reportError(), ReportHead(), ReportTail(), DRC_ENGINE::ReportViolation(), BOARD_INSPECTION_TOOL::reportZoneConnection(), BOARD_NETLIST_UPDATER::testConnectivity(), PROJECT_ARCHIVER::Unarchive(), GERBVIEW_FRAME::unarchiveFiles(), BOARD_NETLIST_UPDATER::updateComponentPadConnections(), BOARD_NETLIST_UPDATER::updateCopperZoneNets(), BOARD_NETLIST_UPDATER::updateFootprintParameters(), BOARD_NETLIST_UPDATER::UpdateNetlist(), and SCH_EDIT_FRAME::WriteNetListFile().
REPORTER & REPORTER::Report | ( | const char * | aText, |
SEVERITY | aSeverity = RPT_SEVERITY_UNDEFINED |
||
) |
Definition at line 33 of file reporter.cpp.
References FROM_UTF8(), and Report().
|
inlinevirtual |
Places the report at the beginning of the list for objects that support ordering.
Reimplemented in WX_HTML_PANEL_REPORTER.
Definition at line 102 of file reporter.h.
References Report().
Referenced by BACK_ANNOTATE::applyChangelist(), BACK_ANNOTATE::getPcbModulesFromString(), DIALOG_NETLIST::loadNetlist(), DIALOG_ERC::OnRunERCClick(), BACK_ANNOTATE::processNetNameChange(), and SCH_EDIT_FRAME::WriteNetListFile().
|
inlinevirtual |
Places the report at the end of the list, for objects that support report ordering.
Reimplemented in WX_HTML_PANEL_REPORTER.
Definition at line 93 of file reporter.h.
References Report().
Referenced by SCH_EDIT_FRAME::AnnotateComponents(), BACK_ANNOTATE::BackAnnotateSymbols(), BACK_ANNOTATE::checkForUnusedSymbols(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), BACK_ANNOTATE::getChangeList(), GERBER_JOBFILE_READER::ReadGerberJobFile(), BOARD_NETLIST_UPDATER::UpdateNetlist(), SCH_SCREEN::UpdateSymbolLinks(), and SCH_EDIT_FRAME::WriteNetListFile().