REPORTER Class Reference

REPORTER is 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
virtual REPORTER &	Report (const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)=0
	Function Report is a pure virtual function to override in the derived object. More...
virtual REPORTER &	ReportTail (const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)
	Function ReportTail 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)
	Function ReportHead 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
	Function HasMessage Returns true if the reporter client is non-empty. More...
virtual EDA_UNITS	GetUnits () const
virtual	~REPORTER ()

Detailed Description

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

                  {
        LOC_HEAD = 0,
        LOC_BODY,
        LOC_TAIL
    };

Constructor & Destructor Documentation

~REPORTER()

virtual REPORTER::~REPORTER ( )

inlinevirtual

Definition at line 126 of file reporter.h.

    {
    }

Member Function Documentation

GetUnits()

virtual EDA_UNITS REPORTER::GetUnits ( ) const

inlinevirtual

Reimplemented in WX_HTML_REPORT_BOX.

Definition at line 121 of file reporter.h.

    {
        return EDA_UNITS::MILLIMETRES;
    }

References MILLIMETRES.

Referenced by PCB_INSPECTION_TOOL::reportClearance(), and PCB_INSPECTION_TOOL::reportZoneConnection().

HasMessage()

virtual bool REPORTER::HasMessage ( ) const

pure virtual

Function HasMessage 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_HTML_REPORT_BOX, and WX_STRING_REPORTER_FILTERED.

Referenced by DIALOG_ANNOTATE::OnApplyClick(), and DRC_RULES_PARSER::Parse().

operator<<() [1/4]

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

inline

Definition at line 110 of file reporter.h.

{ return Report( aText ); }

References Report().

operator<<() [2/4]

REPORTER& REPORTER::operator<< ( const wxChar *  aText )

inline

Definition at line 111 of file reporter.h.

{ return Report( wxString( aText ) ); }

References Report().

operator<<() [3/4]

REPORTER& REPORTER::operator<< ( wxChar  aChar )

inline

Definition at line 112 of file reporter.h.

{ return Report( wxString( aChar ) ); }

References Report().

operator<<() [4/4]

REPORTER& REPORTER::operator<< ( const char *  aText )

inline

Definition at line 113 of file reporter.h.

{ return Report( aText ); }

References Report().

Report() [1/2]

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

pure virtual

Function Report is a pure virtual function to override in the derived object.

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

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_HTML_REPORT_BOX, and WX_STRING_REPORTER_FILTERED.

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(), SCH_REFERENCE_LIST::CheckAnnotation(), 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(), BOARD_NETLIST_UPDATER::deleteUnusedComponents(), EnsureFileDirectoryExists(), DRC_RULE_CONDITION::EvaluateFor(), DIALOG_EXPORT_SVG::ExportSVGFile(), HYPERLYNX_EXPORTER::formatPadShape(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), BOARD_ADAPTER::InitSettings(), C3D_RENDER_OGL_LEGACY::load_3D_models(), PCB_EDIT_FRAME::LoadFootprints(), DIALOG_NETLIST::onFilenameChanged(), operator<<(), DRC_RULES_PARSER::Parse(), DRC_RULES_PARSER::parseValueWithUnits(), DIALOG_PLOT::Plot(), C3D_RENDER_RAYTRACING::Redraw(), C3D_RENDER_OGL_LEGACY::Redraw(), C3D_RENDER_RAYTRACING::Reload(), C3D_RENDER_OGL_LEGACY::reload(), DIALOG_SYMBOL_REMAP::remapSymbolsToLibTable(), C3D_RENDER_RAYTRACING::render(), BOARD_NETLIST_UPDATER::replaceComponent(), Report(), DRC_ENGINE::ReportAux(), PCB_INSPECTION_TOOL::reportClearance(), DRC_RULES_PARSER::reportError(), ReportHead(), ReportTail(), DRC_ENGINE::ReportViolation(), PCB_INSPECTION_TOOL::reportZoneConnection(), C3D_RENDER_RAYTRACING::rt_render_post_process_shade(), C3D_RENDER_RAYTRACING::rt_render_tracing(), BOARD_NETLIST_UPDATER::testConnectivity(), PROJECT_ARCHIVER::Unarchive(), GERBVIEW_FRAME::unarchiveFiles(), BOARD_NETLIST_UPDATER::updateComponentPadConnections(), BOARD_NETLIST_UPDATER::updateComponentParameters(), BOARD_NETLIST_UPDATER::updateCopperZoneNets(), BOARD_NETLIST_UPDATER::UpdateNetlist(), and SCH_EDIT_FRAME::WriteNetListFile().

Report() [2/2]

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

Definition at line 33 of file reporter.cpp.

{
    Report( FROM_UTF8( aText ) );
    return *this;
}

References FROM_UTF8(), and Report().

ReportHead()

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

inlinevirtual

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

Reimplemented in WX_HTML_PANEL_REPORTER.

Definition at line 103 of file reporter.h.

    {
        return Report( aText, aSeverity );
    }

References Report().

Referenced by BACK_ANNOTATE::applyChangelist(), BACK_ANNOTATE::getPcbModulesFromString(), DIALOG_NETLIST::loadNetlist(), BACK_ANNOTATE::processNetNameChange(), and SCH_EDIT_FRAME::WriteNetListFile().

ReportTail()

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

inlinevirtual

Function ReportTail Places the report at the end of the list, for objects that support report ordering.

Reimplemented in WX_HTML_PANEL_REPORTER.

Definition at line 94 of file reporter.h.

    {
        return Report( aText, aSeverity );
    }

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().

---

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

• reporter.h
• reporter.cpp