A wrapper for reporting to a specific text location in a statusbar. More...

#include <reporter.h>

Inheritance diagram for STATUSBAR_REPORTER:

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

Public Member Functions
	STATUSBAR_REPORTER (wxStatusBar *aStatusBar, int aPosition=0)

REPORTER &	Report (const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED) override
	Report a string with a given severity.

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	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
wxStatusBar *	m_statusBar

int	m_position

int	m_reportedSeverityMask

Detailed Description

A wrapper for reporting to a specific text location in a statusbar.

Definition at line 296 of file reporter.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

◆ STATUSBAR_REPORTER()

STATUSBAR_REPORTER::STATUSBAR_REPORTER	(	wxStatusBar *	aStatusBar,
		int	aPosition = 0 )

inline

Definition at line 299 of file reporter.h.

References m_position, m_statusBar, and REPORTER::REPORTER().

Member Function Documentation

◆ Clear()

virtual void REPORTER::Clear ( )

inlinevirtualinherited

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

inlinevirtualinherited

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

inlinevirtualinherited

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

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

inlineinherited

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 )

inherited

Definition at line 49 of file reporter.cpp.

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

◆ Report() [2/2]

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

overridevirtual

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 213 of file reporter.cpp.

References m_position, m_statusBar, REPORTER::Report(), and REPORTER::REPORTER().

Referenced by EDA_3D_CANVAS::DoRePaint(), and EDA_3D_CANVAS::OnMouseMove().