REPORTER Class Reference

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

#include <reporter.h>

Inheritance diagram for REPORTER:

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

Public Member Functions
	REPORTER ()
virtual	~REPORTER ()
virtual REPORTER &	Report (const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)
	Report a string with a given severity.
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.
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.
REPORTER &	Report (const char *aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)
REPORTER &	operator<< (const wxString &aText)
virtual bool	HasMessage () const =0
	Returns true if the reporter client is non-empty.
virtual bool	HasMessageOfSeverity (int aSeverityMask) const
	Returns true if the reporter has one or more messages matching the specified severity mask.
virtual EDA_UNITS	GetUnits () const
virtual void	Clear ()

Private Attributes
int	m_severityMask

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

Member Enumeration Documentation

LOCATION

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

Constructor & Destructor Documentation

REPORTER()

REPORTER::REPORTER ( )

inline

Definition at line 75 of file reporter.h.

~REPORTER()

virtual REPORTER::~REPORTER ( )

inlinevirtual

Definition at line 79 of file reporter.h.

Member Function Documentation

Clear()

virtual void REPORTER::Clear ( )

inlinevirtual

Reimplemented in WX_HTML_REPORT_BOX, WX_STRING_REPORTER, and TEST_REPORTER.

Definition at line 150 of file reporter.h.

Referenced by WX_HTML_REPORT_BOX::Clear(), WX_STRING_REPORTER::Clear(), TEST_REPORTER::Clear(), and SCH_PLOTTER::createPlotFileName().

GetUnits()

virtual EDA_UNITS REPORTER::GetUnits ( ) const

inlinevirtual

Reimplemented in WX_HTML_REPORT_BOX.

Definition at line 145 of file reporter.h.

Referenced by BOOST_AUTO_TEST_CASE().

HasMessage()

virtual bool REPORTER::HasMessage ( ) const

pure virtual

Returns true if the reporter client is non-empty.

Implemented in WX_HTML_REPORT_BOX, WX_HTML_PANEL_REPORTER, SIM_THREAD_REPORTER, WX_TEXT_CTRL_REPORTER, WX_STRING_REPORTER, NULL_REPORTER, CLI_REPORTER, STDOUT_REPORTER, WXLOG_REPORTER, STATUSBAR_REPORTER, INFOBAR_REPORTER, KI_TEST::CONSOLE_MSG_REPORTER, CONSOLE_MSG_REPORTER, TEST_REPORTER, TEST_NETLIST_EXPORTER_SPICE_FIXTURE::SPICE_TEST_REPORTER, and CONSOLE_MSG_REPORTER.

Referenced by BOOST_AUTO_TEST_CASE(), DRC_RULES_PARSER::Parse(), and DRC_RULES_PARSER::ParseComponentClassAssignmentRules().

HasMessageOfSeverity()

virtual bool REPORTER::HasMessageOfSeverity ( int  aSeverityMask ) const

inlinevirtual

Returns true if the reporter has one or more messages matching the specified severity mask.

Reimplemented in WX_HTML_PANEL_REPORTER.

Definition at line 140 of file reporter.h.

Referenced by BOOST_AUTO_TEST_CASE(), COMPONENT_CLASS_MANAGER::CompileAssignmentRule(), EESCHEMA_JOBS_HANDLER::doSymExportSvg(), EXPORTER_STEP::Export(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), DIALOG_SIM_MODEL< T >::loadLibrary(), SIMULATOR_CONTROL::NewAnalysisTab(), NETLIST_EXPORTER_SPICE::ReadSchematicAndLibraries(), SIM_LIB_MGR::SetLibrary(), and SIMULATOR_FRAME::showNetlistErrors().

operator<<()

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

inline

Definition at line 129 of file reporter.h.

Report() [1/2]

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

Definition at line 49 of file reporter.cpp.

References From_UTF8(), and Report().

Report() [2/2]

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

inlinevirtual

Report a string with a given severity.

Parameters

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

Reimplemented in CLI_REPORTER, STDOUT_REPORTER, WXLOG_REPORTER, JOBSET_OUTPUT_REPORTER, WX_HTML_REPORT_BOX, WX_HTML_PANEL_REPORTER, SIM_THREAD_REPORTER, WX_TEXT_CTRL_REPORTER, WX_STRING_REPORTER, NULL_REPORTER, STATUSBAR_REPORTER, INFOBAR_REPORTER, KI_TEST::CONSOLE_MSG_REPORTER, CONSOLE_MSG_REPORTER, TEST_REPORTER, TEST_NETLIST_EXPORTER_SPICE_FIXTURE::SPICE_TEST_REPORTER, and CONSOLE_MSG_REPORTER.

Definition at line 102 of file reporter.h.

Referenced by STEP_PCB_MODEL::AddComponent(), GERBER_JOBFILE_WRITER::addJSONFilesAttributes(), GERBER_JOBFILE_WRITER::addJSONMaterialStackup(), BOARD_NETLIST_UPDATER::addNewFootprint(), STEP_PCB_MODEL::AddPadShape(), STEP_PCB_MODEL::AddPolygonShapes(), SCH_EDIT_FRAME::AnnotateSymbols(), DIALOG_PLOT::applyPlotSettings(), PROJECT_ARCHIVER::Archive(), PROJECT_ARCHIVER::AreZipArchivesIdentical(), DIALOG_SYMBOL_REMAP::backupProject(), PIN_INFO_FORMATTER::boolFromString(), BOOST_AUTO_TEST_CASE(), EXPORTER_STEP::buildBoard3DShapes(), EXPORTER_STEP::buildFootprint3DShapes(), NGSPICE::cbSendChar(), TRACKS_CLEANER::CleanupBoard(), DRC_RULE_CONDITION::Compile(), DRC_ENGINE::compileRules(), STEP_PCB_MODEL::CompressSTEP(), BITMAPCONV_INFO::ConvertBitmap(), ALTIUM_PCB::ConvertComponentBody6ToFootprintItem(), PCBNEW_JOBS_HANDLER::convertLayerArg(), PCB_IO_MGR::ConvertLibrary(), ALTIUM_PCB::ConvertPads6ToBoardItemOnNonCopper(), ALTIUM_PCB::ConvertPads6ToFootprintItemOnCopper(), ALTIUM_PCB::ConvertPads6ToFootprintItemOnNonCopper(), ALTIUM_PCB::ConvertShapeBasedRegions6ToBoardItem(), ALTIUM_PCB::ConvertShapeBasedRegions6ToFootprintItem(), ALTIUM_PCB::ConvertTexts6ToBoardItem(), ALTIUM_PCB::ConvertTexts6ToFootprintItem(), ALTIUM_PCB::ConvertTracks6ToBoardItem(), SIM_MODEL::Create(), DIALOG_GEN_FOOTPRINT_POSITION::CreateAsciiFiles(), GERBER_WRITER::CreateDrillandMapFilesSet(), EXCELLON_WRITER::CreateDrillandMapFilesSet(), SCH_PLOTTER::createDXFFiles(), DIALOG_GEN_FOOTPRINT_POSITION::CreateGerberFiles(), GERBER_JOBFILE_WRITER::CreateJobFile(), BOARD_ADAPTER::createLayers(), GENDRILL_WRITER_BASE::CreateMapFilesSet(), SIM_LIB_MGR::CreateModel(), BITMAPCONV_INFO::createOutputData(), STEP_PCB_MODEL::CreatePCB(), SCH_PLOTTER::createPDFFile(), SCH_PLOTTER::createPlotFileName(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), SCH_PLOTTER::createPSFiles(), SCH_PLOTTER::createSVGFiles(), SCH_EDIT_FRAME::DeleteAnnotation(), PCBNEW_JOBS_HANDLER::doFpExportSvg(), EESCHEMA_JOBS_HANDLER::doSymExportSvg(), EnsureFileDirectoryExists(), DRC_RULE_CONDITION::EvaluateFor(), EXPORTER_STEP::Export(), fontconfig::FONTCONFIG::FindFont(), HYPERLYNX_EXPORTER::formatPadShape(), fuseShapes(), DIALOG_EXPORT_ODBPP::GenerateODBPPFiles(), LTSPICE_SCHEMATIC::GetAscAndAsyFilePaths(), PCBNEW_JOBS_HANDLER::getBoard(), PIN_TABLE_IMPORT::getColOrderFromCSV(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), ALTIUM_PCB::GetKicadLayersToIterate(), CADSTAR_SCH_ARCHIVE_LOADER::getLocationOfNetElement(), STEP_PCB_MODEL::getModelLabel(), EESCHEMA_JOBS_HANDLER::getSchematic(), HelperGeneratePowerPortGraphics(), ALTIUM_PCB::HelperParseDimensions6Center(), ALTIUM_PCB::HelperParseDimensions6Datum(), ALTIUM_PCB::HelperParseDimensions6Leader(), ALTIUM_PCB::HelperParseDimensions6Linear(), ALTIUM_PCB::HelperParseDimensions6Radial(), ALTIUM_PCB::HelperParsePad6NonCopper(), ALTIUM_PCB::HelperSetTextboxAlignmentAndPos(), DRC_ENGINE::InitEngine(), 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::JobExportGencad(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportGerbers(), PCBNEW_JOBS_HANDLER::JobExportIpc2581(), PCBNEW_JOBS_HANDLER::JobExportIpcD356(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), PCBNEW_JOBS_HANDLER::JobExportPdf(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), PCBNEW_JOBS_HANDLER::JobExportPos(), PCBNEW_JOBS_HANDLER::JobExportPs(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), PCBNEW_JOBS_HANDLER::JobExportRender(), 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(), CADSTAR_SCH_ARCHIVE_LOADER::loadLibPart(), PCBNEW_JOBS_HANDLER::loadOverrideDrawingSheet(), CADSTAR_SCH_ARCHIVE_LOADER::loadPartsLibrary(), SCH_IO_ALTIUM::LoadSchematicFile(), SCH_IO_LTSPICE::LoadSchematicFile(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbol(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), CADSTAR_SCH_ARCHIVE_LOADER::loadTextVariables(), STEP_PCB_MODEL::MakeShapeAsThickSegment(), STEP_PCB_MODEL::MakeShapes(), makeWireFromChain(), PNS_TEST_DEBUG_DECORATOR::Message(), DIALOG_IMPORT_NETLIST::onFilenameChanged(), padNeedsUpdate(), ALTIUM_PCB::Parse(), DRC_RULES_PARSER::Parse(), ALTIUM_PCB::ParseClasses6Data(), DRC_RULES_PARSER::ParseComponentClassAssignmentRules(), ALTIUM_PCB::ParseComponentsBodies6Data(), ALTIUM_PCB::ParseDimensions6Data(), SPICE_LIBRARY_PARSER::parseFile(), ALTIUM_PCB::ParseFootprint(), ALTIUM_PCB::ParseModelsData(), ALTIUM_PCB::ParsePolygons6Data(), DRC_RULES_PARSER::parseValueWithUnits(), ALTIUM_PCB::ParseVias6Data(), PCBNEW_JOBS_HANDLER::PCBNEW_JOBS_HANDLER(), STEP_PCB_MODEL::performMeshing(), PCB_PLOTTER::Plot(), PCB_PLOTTER::PlotJobToPlotOpts(), RENDER_3D_RAYTRACE_BASE::postProcessShading(), SIM_LIBRARY_IBIS::ReadFile(), NETLIST_EXPORTER_SPICE::ReadSchematicAndLibraries(), SIM_MODEL::ReadTypeFromFields(), RENDER_3D_OPENGL::Redraw(), RENDER_3D_RAYTRACE_GL::Redraw(), RENDER_3D_RAYTRACE_RAM::Redraw(), RENDER_3D_OPENGL::reload(), RENDER_3D_RAYTRACE_BASE::Reload(), DIALOG_SYMBOL_REMAP::remapSymbolsToLibTable(), RENDER_3D_RAYTRACE_BASE::render(), RENDER_3D_RAYTRACE_BASE::renderTracing(), BOARD_NETLIST_UPDATER::replaceFootprint(), PNS_LOG_PLAYER::ReplayLog(), Report(), IBIS_BASE::Report(), CLI_REPORTER::Report(), STDOUT_REPORTER::Report(), WXLOG_REPORTER::Report(), IO_BASE::Report(), WX_HTML_PANEL_REPORTER::Report(), WX_TEXT_CTRL_REPORTER::Report(), WX_STRING_REPORTER::Report(), NULL_REPORTER::Report(), STATUSBAR_REPORTER::Report(), TEST_REPORTER::Report(), BOARD_INSPECTION_TOOL::reportCompileError(), DRC_RULES_PARSER::reportDeprecation(), DRC_RULES_PARSER::reportError(), BOARD_INSPECTION_TOOL::reportHeader(), DRC_ENGINE::ReportViolation(), SIM_LIB_MGR::ResolveLibraryPath(), JOBS_RUNNER::RunJobsForDestination(), DRC_ENGINE::RunTests(), KICAD_PRINTER::Send(), SIM_LIB_MGR::SetLibrary(), LTSPICE_SCHEMATIC::StructureBuilder(), BOARD_NETLIST_UPDATER::testConnectivity(), DIALOG_EXPORT_NETLIST::TransferDataFromWindow(), PROJECT_ARCHIVER::Unarchive(), GERBVIEW_FRAME::unarchiveFiles(), BOARD_NETLIST_UPDATER::updateComponentClass(), BOARD_NETLIST_UPDATER::updateComponentPadConnections(), BOARD_NETLIST_UPDATER::updateCopperZoneNets(), BOARD_NETLIST_UPDATER::updateFootprintGroup(), BOARD_NETLIST_UPDATER::updateFootprintParameters(), BOARD_NETLIST_UPDATER::updateGroups(), BOARD_NETLIST_UPDATER::UpdateNetlist(), STEP_PCB_MODEL::WriteBREP(), STEP_PCB_MODEL::WriteGLTF(), NETLIST_EXPORTER_ALLEGRO::WriteNetlist(), NETLIST_EXPORTER_CADSTAR::WriteNetlist(), NETLIST_EXPORTER_KICAD::WriteNetlist(), NETLIST_EXPORTER_ORCADPCB2::WriteNetlist(), NETLIST_EXPORTER_PADS::WriteNetlist(), SCH_EDIT_FRAME::WriteNetListFile(), STEP_PCB_MODEL::WritePLY(), STEP_PCB_MODEL::WriteSTEP(), STEP_PCB_MODEL::WriteSTL(), STEP_PCB_MODEL::WriteXAO(), and zoneNeedsUpdate().

ReportHead()

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

inlinevirtual

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

Reimplemented in WX_HTML_PANEL_REPORTER.

Definition at line 121 of file reporter.h.

Referenced by BACK_ANNOTATE::applyChangelist(), BOOST_AUTO_TEST_CASE(), BACK_ANNOTATE::getPcbModulesFromString(), DIALOG_IMPORT_NETLIST::loadNetlist(), DIALOG_ERC::OnRunERCClick(), BACK_ANNOTATE::processNetNameChange(), WX_HTML_PANEL_REPORTER::ReportHead(), DIALOG_EXPORT_NETLIST::TransferDataFromWindow(), and SCH_EDIT_FRAME::WriteNetListFile().

ReportTail()

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

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

Referenced by SCH_EDIT_FRAME::AnnotateSymbols(), BACK_ANNOTATE::BackAnnotateSymbols(), BOOST_AUTO_TEST_CASE(), BACK_ANNOTATE::checkForUnusedSymbols(), GERBER_WRITER::CreateDrillandMapFilesSet(), EXCELLON_WRITER::CreateDrillandMapFilesSet(), SCH_PLOTTER::createDXFFiles(), SCH_PLOTTER::createPDFFile(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), SCH_PLOTTER::createPSFiles(), SCH_PLOTTER::createSVGFiles(), BACK_ANNOTATE::getChangeList(), PCB_PLOTTER::Plot(), GERBER_JOBFILE_READER::ReadGerberJobFile(), WX_HTML_PANEL_REPORTER::ReportTail(), BOARD_NETLIST_UPDATER::UpdateNetlist(), SCH_SCREEN::UpdateSymbolLinks(), and SCH_EDIT_FRAME::WriteNetListFile().

Member Data Documentation

m_severityMask

int REPORTER::m_severityMask

private

Definition at line 156 of file reporter.h.

---

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

• reporter.h
• reporter.cpp