CONSOLE_MSG_REPORTER Class Reference

#include <console_log.h>

Inheritance diagram for CONSOLE_MSG_REPORTER:

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

Public Member Functions
	CONSOLE_MSG_REPORTER (CONSOLE_LOG *log)
	~CONSOLE_MSG_REPORTER ()
virtual REPORTER &	Report (const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED) override
	Report a string with a given severity.
virtual bool	HasMessage () const override
	Returns true if the reporter client is non-empty.
	CONSOLE_MSG_REPORTER (CONSOLE_LOG *log)
	~CONSOLE_MSG_REPORTER ()
virtual REPORTER &	Report (const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED) override
	Report a string with a given severity.
virtual bool	HasMessage () const override
	Returns true if the reporter client is non-empty.
REPORTER &	Report (const char *aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)
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 &	operator<< (const wxString &aText)
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
CONSOLE_LOG *	m_log
int	m_severityMask

Detailed Description

Definition at line 123 of file console_log.h.

Member Enumeration Documentation

LOCATION

enum REPORTER::LOCATION

inherited

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

CONSOLE_MSG_REPORTER() [1/2]

CONSOLE_MSG_REPORTER::CONSOLE_MSG_REPORTER ( CONSOLE_LOG *  log )

inline

Definition at line 126 of file console_log.h.

~CONSOLE_MSG_REPORTER() [1/2]

CONSOLE_MSG_REPORTER::~CONSOLE_MSG_REPORTER ( )

inline

Definition at line 129 of file console_log.h.

CONSOLE_MSG_REPORTER() [2/2]

CONSOLE_MSG_REPORTER::CONSOLE_MSG_REPORTER ( CONSOLE_LOG *  log )

inline

Definition at line 128 of file drc_proto.h.

~CONSOLE_MSG_REPORTER() [2/2]

CONSOLE_MSG_REPORTER::~CONSOLE_MSG_REPORTER ( )

inline

Definition at line 131 of file drc_proto.h.

Member Function Documentation

Clear()

virtual void REPORTER::Clear ( )

inlinevirtualinherited

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

inlinevirtualinherited

Reimplemented in WX_HTML_REPORT_BOX.

Definition at line 145 of file reporter.h.

Referenced by BOOST_AUTO_TEST_CASE().

HasMessage() [1/2]

virtual bool CONSOLE_MSG_REPORTER::HasMessage ( ) const

inlineoverridevirtual

Returns true if the reporter client is non-empty.

Implements REPORTER.

Definition at line 152 of file console_log.h.

HasMessage() [2/2]

virtual bool CONSOLE_MSG_REPORTER::HasMessage ( ) const

inlineoverridevirtual

Returns true if the reporter client is non-empty.

Implements REPORTER.

Definition at line 154 of file drc_proto.h.

HasMessageOfSeverity()

virtual bool REPORTER::HasMessageOfSeverity ( int  aSeverityMask ) const

inlinevirtualinherited

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 )

inlineinherited

Definition at line 129 of file reporter.h.

Report() [1/3]

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

inherited

Definition at line 49 of file reporter.cpp.

References From_UTF8(), and REPORTER::Report().

Report() [2/3]

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

inlineoverridevirtual

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 from REPORTER.

Definition at line 132 of file console_log.h.

References CONSOLE_LOG::DEFAULT, m_log, CONSOLE_LOG::Print(), CONSOLE_LOG::RED, RPT_SEVERITY_ERROR, and CONSOLE_LOG::SetColor().

Report() [3/3]

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

inlineoverridevirtual

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 from REPORTER.

Definition at line 134 of file drc_proto.h.

References CONSOLE_LOG::DEFAULT, m_log, CONSOLE_LOG::Print(), CONSOLE_LOG::RED, RPT_SEVERITY_ERROR, and CONSOLE_LOG::SetColor().

ReportHead()

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

inlinevirtualinherited

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  )

inlinevirtualinherited

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_log

CONSOLE_LOG * CONSOLE_MSG_REPORTER::m_log

private

Definition at line 158 of file console_log.h.

Referenced by Report().

m_severityMask

int REPORTER::m_severityMask

privateinherited

Definition at line 156 of file reporter.h.

---

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

• console_log.h
• drc_proto.h