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
	Returns true if any messages were reported.
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_reportedSeverityMask

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.

References m_reportedSeverityMask.

Referenced by CLI_REPORTER::GetInstance(), NULL_REPORTER::GetInstance(), STDOUT_REPORTER::GetInstance(), WXLOG_REPORTER::GetInstance(), INFOBAR_REPORTER::INFOBAR_REPORTER(), operator<<(), REDIRECT_REPORTER::REDIRECT_REPORTER(), CLI_REPORTER::Report(), CONSOLE_MSG_REPORTER::Report(), INFOBAR_REPORTER::Report(), JOBSET_OUTPUT_REPORTER::Report(), KI_TEST::CONSOLE_MSG_REPORTER::Report(), NULL_REPORTER::Report(), REDIRECT_REPORTER::Report(), Report(), Report(), SIM_THREAD_REPORTER::Report(), STATUSBAR_REPORTER::Report(), STDOUT_REPORTER::Report(), TEST_NETLIST_EXPORTER_SPICE_FIXTURE::SPICE_TEST_REPORTER::Report(), TEST_REPORTER::Report(), WX_HTML_PANEL_REPORTER::Report(), WX_HTML_REPORT_BOX::Report(), WX_STRING_REPORTER::Report(), WX_TEXT_CTRL_REPORTER::Report(), WXLOG_REPORTER::Report(), ReportHead(), WX_HTML_PANEL_REPORTER::ReportHead(), ReportTail(), WX_HTML_PANEL_REPORTER::ReportTail(), STATUSBAR_REPORTER::STATUSBAR_REPORTER(), WX_HTML_PANEL_REPORTER::WX_HTML_PANEL_REPORTER(), WX_STRING_REPORTER::WX_STRING_REPORTER(), and WX_TEXT_CTRL_REPORTER::WX_TEXT_CTRL_REPORTER().

~REPORTER()

virtual REPORTER::~REPORTER ( )

inlinevirtual

Definition at line 79 of file reporter.h.

Member Function Documentation

Clear()

virtual void REPORTER::Clear ( )

inlinevirtual

Reimplemented in TEST_REPORTER, WX_HTML_REPORT_BOX, and WX_STRING_REPORTER.

Definition at line 153 of file reporter.h.

References m_reportedSeverityMask.

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

GetUnits()

virtual EDA_UNITS REPORTER::GetUnits ( ) const

inlinevirtual

Reimplemented in WX_HTML_REPORT_BOX.

Definition at line 148 of file reporter.h.

References MM.

Referenced by BOOST_AUTO_TEST_CASE(), and BOOST_AUTO_TEST_CASE().

HasMessage()

virtual bool REPORTER::HasMessage ( ) const

inlinevirtual

Returns true if any messages were reported.

Reimplemented in CONSOLE_MSG_REPORTER, CONSOLE_MSG_REPORTER, INFOBAR_REPORTER, KI_TEST::CONSOLE_MSG_REPORTER, SIM_THREAD_REPORTER, TEST_NETLIST_EXPORTER_SPICE_FIXTURE::SPICE_TEST_REPORTER, TEST_REPORTER, WX_HTML_PANEL_REPORTER, and WX_HTML_REPORT_BOX.

Definition at line 134 of file reporter.h.

References m_reportedSeverityMask.

Referenced by SIMULATOR_FRAME_UI::applyTuners(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BITMAP2CMP_PANEL::ExportToBuffer(), BOARD_EDITOR_CONTROL::GenerateODBPPFiles(), SPICE_GENERATOR_IBIS::IbisDevice(), GERBVIEW_FRAME::LoadGerberJobFile(), GERBVIEW_FRAME::LoadZipArchiveFile(), SIM_MODEL::MigrateSimModel(), DIALOG_LIB_EDIT_PIN_TABLE::OnImportButtonClick(), DIALOG_SIM_MODEL< T >::onLibraryPathTextEnter(), SIMULATOR_FRAME::showNetlistErrors(), SCH_EDITOR_CONTROL::SimProbe(), ERC_TESTER::TestSimModelIssues(), and DIALOG_SIM_MODEL< T >::TransferDataToWindow().

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

References m_reportedSeverityMask.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), COMPONENT_CLASS_MANAGER::CompileAssignmentRule(), DRC_ENGINE::compileRules(), 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.

References Report(), and REPORTER().

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(), Report(), and REPORTER().

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

Definition at line 102 of file reporter.h.

References m_reportedSeverityMask, REPORTER(), and RPT_SEVERITY_UNDEFINED.

Referenced by 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(), BOOST_AUTO_TEST_CASE(), NGSPICE::cbSendChar(), DRC_RULE_CONDITION::Compile(), PCB_IO_MGR::ConvertLibrary(), SIM_MODEL::Create(), SIM_MODEL::Create(), DIALOG_GEN_FOOTPRINT_POSITION::CreateAsciiFiles(), EXCELLON_WRITER::CreateDrillandMapFilesSet(), GERBER_WRITER::CreateDrillandMapFilesSet(), SCH_PLOTTER::createDXFFiles(), DIALOG_GEN_FOOTPRINT_POSITION::CreateGerberFiles(), 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(), SCH_EDIT_FRAME::DeleteAnnotation(), EnsureFileDirectoryExists(), DRC_RULE_CONDITION::EvaluateFor(), footprintVsBoardStackup(), fuseShapes(), DIALOG_EXPORT_ODBPP::GenerateODBPPFiles(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), HelperGeneratePowerPortGraphics(), HelperGeneratePowerPortGraphics(), BOARD_ADAPTER::InitSettings(), LTSPICE_SCHEMATIC::Load(), PNS_LOG_FILE::Load(), RENDER_3D_OPENGL::load3dModels(), PCB_EDIT_FRAME::LoadFootprints(), makeWireFromChain(), DIALOG_IMPORT_NETLIST::onFilenameChanged(), DIALOG_EXPORT_2581::onOKClick(), operator<<(), padNeedsUpdate(), SPICE_LIBRARY_PARSER::parseFile(), 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_RAYTRACE_BASE::Reload(), RENDER_3D_OPENGL::reload(), DIALOG_SYMBOL_REMAP::remapSymbolsToLibTable(), RENDER_3D_RAYTRACE_BASE::render(), RENDER_3D_RAYTRACE_BASE::renderTracing(), CLI_REPORTER::Report(), NULL_REPORTER::Report(), REDIRECT_REPORTER::Report(), Report(), STATUSBAR_REPORTER::Report(), STDOUT_REPORTER::Report(), TEST_REPORTER::Report(), WX_HTML_PANEL_REPORTER::Report(), WX_STRING_REPORTER::Report(), WX_TEXT_CTRL_REPORTER::Report(), WXLOG_REPORTER::Report(), BOARD_INSPECTION_TOOL::reportCompileError(), ReportHead(), BOARD_INSPECTION_TOOL::reportHeader(), BOARD_INSPECTION_TOOL::reportHeader(), BOARD_INSPECTION_TOOL::reportHeader(), ReportTail(), SIM_LIB_MGR::ResolveLibraryPath(), JOBS_RUNNER::runSpecialExecute(), SIM_LIB_MGR::SetLibrary(), DIALOG_EXPORT_NETLIST::TransferDataFromWindow(), PROJECT_ARCHIVER::Unarchive(), GERBVIEW_FRAME::unarchiveFiles(), NETLIST_EXPORTER_ALLEGRO::WriteNetlist(), NETLIST_EXPORTER_CADSTAR::WriteNetlist(), NETLIST_EXPORTER_KICAD::WriteNetlist(), NETLIST_EXPORTER_ORCADPCB2::WriteNetlist(), NETLIST_EXPORTER_PADS::WriteNetlist(), SCH_EDIT_FRAME::WriteNetListFile(), 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.

References Report(), REPORTER(), and RPT_SEVERITY_UNDEFINED.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), DIALOG_IMPORT_NETLIST::loadNetlist(), 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.

References Report(), REPORTER(), and RPT_SEVERITY_UNDEFINED.

Referenced by SCH_EDIT_FRAME::AnnotateSymbols(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), EXCELLON_WRITER::CreateDrillandMapFilesSet(), GERBER_WRITER::CreateDrillandMapFilesSet(), SCH_PLOTTER::createDXFFiles(), SCH_PLOTTER::createPDFFile(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), SCH_PLOTTER::createPSFiles(), SCH_PLOTTER::createSVGFiles(), WX_HTML_PANEL_REPORTER::ReportTail(), SCH_SCREEN::UpdateSymbolLinks(), and SCH_EDIT_FRAME::WriteNetListFile().

Member Data Documentation

m_reportedSeverityMask

int REPORTER::m_reportedSeverityMask

private

Definition at line 159 of file reporter.h.

Referenced by Clear(), HasMessage(), HasMessageOfSeverity(), Report(), and REPORTER().

---

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

• reporter.h
• reporter.cpp