KiCad PCB EDA Suite
Loading...
Searching...
No Matches
REPORTER Class Referenceabstract

A pure virtual class used to derive REPORTER objects from. More...

#include <reporter.h>

Inheritance diagram for REPORTER:
CLI_REPORTER CONSOLE_MSG_REPORTER CONSOLE_MSG_REPORTER INFOBAR_REPORTER KI_TEST::CONSOLE_MSG_REPORTER NULL_REPORTER SIMULATOR_REPORTER STATUSBAR_REPORTER STDOUT_REPORTER WXLOG_REPORTER WX_HTML_PANEL_REPORTER WX_HTML_REPORT_BOX WX_STRING_REPORTER WX_TEXT_CTRL_REPORTER

Public Types

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

Public Member Functions

virtual REPORTERReport (const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)=0
 Report a string with a given severity. More...
 
virtual REPORTERReportTail (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 REPORTERReportHead (const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)
 Places the report at the beginning of the list for objects that support ordering. More...
 
REPORTERReport (const char *aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)
 
REPORTERoperator<< (const wxString &aText)
 
virtual bool HasMessage () const =0
 Returns true if the reporter client is non-empty. More...
 
virtual EDA_UNITS GetUnits () const
 
virtual ~REPORTER ()
 

Detailed Description

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

Member Enumeration Documentation

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

Constructor & Destructor Documentation

◆ ~REPORTER()

virtual REPORTER::~REPORTER ( )
inlinevirtual

Definition at line 128 of file reporter.h.

Member Function Documentation

◆ GetUnits()

virtual EDA_UNITS REPORTER::GetUnits ( ) const
inlinevirtual

Reimplemented in WX_HTML_REPORT_BOX.

Definition at line 123 of file reporter.h.

◆ HasMessage()

◆ operator<<()

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

Definition at line 116 of file reporter.h.

References Report().

◆ Report() [1/2]

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

Definition at line 38 of file reporter.cpp.

References From_UTF8(), and Report().

◆ Report() [2/2]

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

Report a string with a given severity.

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 CLI_REPORTER, STDOUT_REPORTER, WXLOG_REPORTER, WX_HTML_REPORT_BOX, SIM_THREAD_REPORTER, WX_TEXT_CTRL_REPORTER, WX_STRING_REPORTER, WX_HTML_PANEL_REPORTER, NULL_REPORTER, STATUSBAR_REPORTER, INFOBAR_REPORTER, KI_TEST::CONSOLE_MSG_REPORTER, CONSOLE_MSG_REPORTER, TEST_NETLIST_EXPORTER_SPICE_FIXTURE::SPICE_TEST_REPORTER, TEST_NETLIST_EXPORTER_SPICE_FIXTURE::SPICE_TEST_REPORTER, and CONSOLE_MSG_REPORTER.

Referenced by GERBER_JOBFILE_WRITER::addJSONFilesAttributes(), GERBER_JOBFILE_WRITER::addJSONMaterialStackup(), SCH_IO_ALTIUM::AddLibTextBox(), BOARD_NETLIST_UPDATER::addNewFootprint(), SCH_EDIT_FRAME::AnnotateSymbols(), DIALOG_PLOT::applyPlotSettings(), PROJECT_ARCHIVER::Archive(), DIALOG_SYMBOL_REMAP::backupProject(), NGSPICE::cbSendChar(), TRACKS_CLEANER::CleanupBoard(), DRC_RULE_CONDITION::Compile(), SIM_MODEL::Create(), DIALOG_GEN_FOOTPRINT_POSITION::CreateAsciiFiles(), EXCELLON_WRITER::CreateDrillandMapFilesSet(), GERBER_WRITER::CreateDrillandMapFilesSet(), SCH_PLOTTER::createDXFFiles(), DIALOG_GEN_FOOTPRINT_POSITION::CreateGerberFiles(), SCH_PLOTTER::createHPGLFiles(), GERBER_JOBFILE_WRITER::CreateJobFile(), BOARD_ADAPTER::createLayers(), GENDRILL_WRITER_BASE::CreateMapFilesSet(), SIM_LIB_MGR::CreateModel(), SCH_PLOTTER::createPDFFile(), SCH_PLOTTER::createPlotFileName(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), SCH_PLOTTER::createPSFiles(), SCH_PLOTTER::createSVGFiles(), PCBNEW_JOBS_HANDLER::doFpExportSvg(), EESCHEMA_JOBS_HANDLER::doSymExportSvg(), EnsureFileDirectoryExists(), DRC_RULE_CONDITION::EvaluateFor(), DIALOG_EXPORT_SVG::ExportSVGFile(), FOOTPRINT::FootprintNeedsUpdate(), HYPERLYNX_EXPORTER::formatPadShape(), LTSPICE_SCHEMATIC::GetAscAndAsyFilePaths(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), CADSTAR_SCH_ARCHIVE_LOADER::getLocationOfNetElement(), HelperGeneratePowerPortGraphics(), EESCHEMA_JOBS_HANDLER::InitRenderSettings(), BOARD_ADAPTER::InitSettings(), EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportDrc(), PCBNEW_JOBS_HANDLER::JobExportDrill(), PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportFpSvg(), PCBNEW_JOBS_HANDLER::JobExportFpUpgrade(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportGerbers(), PCBNEW_JOBS_HANDLER::JobExportIpc2581(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), PCBNEW_JOBS_HANDLER::JobExportPdf(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), PCBNEW_JOBS_HANDLER::JobExportPos(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), PCBNEW_JOBS_HANDLER::JobExportStep(), PCBNEW_JOBS_HANDLER::JobExportSvg(), EESCHEMA_JOBS_HANDLER::JobSchErc(), EESCHEMA_JOBS_HANDLER::JobSymExportSvg(), EESCHEMA_JOBS_HANDLER::JobSymUpgrade(), PNS_LOG_FILE::Load(), CADSTAR_SCH_ARCHIVE_LOADER::Load(), LTSPICE_SCHEMATIC::Load(), RENDER_3D_OPENGL::load3dModels(), CADSTAR_SCH_ARCHIVE_LOADER::loadChildSheets(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), PCB_EDIT_FRAME::LoadFootprints(), SCH_IO_EAGLE::loadInstance(), CADSTAR_SCH_ARCHIVE_LOADER::loadLibPart(), PCBNEW_JOBS_HANDLER::loadOverrideDrawingSheet(), CADSTAR_SCH_ARCHIVE_LOADER::loadPartsLibrary(), SCH_IO_LTSPICE::LoadSchematicFile(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbol(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), CADSTAR_SCH_ARCHIVE_LOADER::loadTextVariables(), PNS_TEST_DEBUG_DECORATOR::Message(), DIALOG_IMPORT_NETLIST::onFilenameChanged(), operator<<(), padNeedsUpdate(), DRC_RULES_PARSER::Parse(), SCH_IO_ALTIUM::ParseAdditional(), SCH_IO_ALTIUM::ParseAltiumSch(), SCH_IO_ALTIUM::ParseArc(), SCH_IO_ALTIUM::ParseBezier(), SCH_IO_ALTIUM::ParseCircle(), SCH_IO_ALTIUM::ParseComponent(), SCH_IO_ALTIUM::ParseDesignator(), SCH_IO_ALTIUM::ParseEllipse(), SCH_IO_ALTIUM::ParseEllipticalArc(), SPICE_LIBRARY_PARSER::parseFile(), SCH_IO_ALTIUM::ParseFileHeader(), SCH_IO_ALTIUM::ParseFileName(), SCH_IO_ALTIUM::ParseHarnessConnector(), SCH_IO_ALTIUM::ParseHarnessEntry(), SCH_IO_ALTIUM::ParseHarnessPort(), SCH_IO_ALTIUM::ParseHarnessType(), SCH_IO_ALTIUM::ParseImage(), SCH_IO_ALTIUM::ParseImplementation(), SCH_IO_ALTIUM::ParseLabel(), SCH_IO_ALTIUM::ParseLibFile(), SCH_IO_ALTIUM::ParseLine(), SCH_IO_ALTIUM::ParsePin(), SCH_IO_ALTIUM::ParsePolygon(), SCH_IO_ALTIUM::ParsePolyline(), SCH_IO_ALTIUM::ParsePort(), SCH_IO_ALTIUM::ParsePowerPort(), SCH_IO_ALTIUM::ParseRectangle(), SCH_IO_ALTIUM::ParseRoundRectangle(), SCH_IO_ALTIUM::ParseSheetEntry(), SCH_IO_ALTIUM::ParseSheetName(), SCH_IO_ALTIUM::ParseSignalHarness(), SCH_IO_ALTIUM::ParseStorage(), DRC_RULES_PARSER::parseValueWithUnits(), DIALOG_PLOT::Plot(), RENDER_3D_RAYTRACE::postProcessShading(), SPICE_LIBRARY_PARSER::readFallbacks(), SIM_LIBRARY_KIBIS::ReadFile(), SIM_MODEL::ReadTypeFromFields(), RENDER_3D_OPENGL::Redraw(), RENDER_3D_RAYTRACE::Redraw(), RENDER_3D_OPENGL::reload(), RENDER_3D_RAYTRACE::Reload(), DIALOG_SYMBOL_REMAP::remapSymbolsToLibTable(), RENDER_3D_RAYTRACE::render(), BOARD_NETLIST_UPDATER::replaceFootprint(), PNS_LOG_PLAYER::ReplayLog(), Report(), IBIS_ANY::Report(), DRC_ENGINE::ReportAux(), BOARD_INSPECTION_TOOL::reportCompileError(), DRC_RULES_PARSER::reportDeprecation(), DRC_RULES_PARSER::reportError(), ReportHead(), BOARD_INSPECTION_TOOL::reportHeader(), ReportTail(), DRC_ENGINE::ReportViolation(), SIM_LIB_MGR::SetLibrary(), BOARD_NETLIST_UPDATER::testConnectivity(), DIALOG_EXPORT_NETLIST::TransferDataFromWindow(), PROJECT_ARCHIVER::Unarchive(), GERBVIEW_FRAME::unarchiveFiles(), BOARD_NETLIST_UPDATER::updateComponentPadConnections(), BOARD_NETLIST_UPDATER::updateCopperZoneNets(), BOARD_NETLIST_UPDATER::updateFootprintParameters(), BOARD_NETLIST_UPDATER::UpdateNetlist(), NETLIST_EXPORTER_ALLEGRO::WriteNetlist(), NETLIST_EXPORTER_CADSTAR::WriteNetlist(), NETLIST_EXPORTER_KICAD::WriteNetlist(), NETLIST_EXPORTER_ORCADPCB2::WriteNetlist(), SCH_EDIT_FRAME::WriteNetListFile(), and zoneNeedsUpdate().

◆ ReportHead()

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

◆ ReportTail()


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