A wrapper for reporting to a wxString object. More...

#include <reporter.h>

Inheritance diagram for WX_STRING_REPORTER:

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

Public Member Functions
	WX_STRING_REPORTER ()

virtual	~WX_STRING_REPORTER ()

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

bool	HasMessage () const override
	Returns true if the reporter client is non-empty.

bool	HasMessageOfSeverity (int aSeverityMask) const override
	Returns true if the reporter has one or more messages matching the specified severity mask.

const wxString &	GetMessages () const

void	Clear ()

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 EDA_UNITS	GetUnits () const

Private Attributes
wxString	m_string

int	m_severityMask

Detailed Description

A wrapper for reporting to a wxString object.

Definition at line 170 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 80 of file reporter.h.

Constructor & Destructor Documentation

◆ WX_STRING_REPORTER()

WX_STRING_REPORTER::WX_STRING_REPORTER ( )

inline

Definition at line 173 of file reporter.h.

◆ ~WX_STRING_REPORTER()

virtual WX_STRING_REPORTER::~WX_STRING_REPORTER ( )

inlinevirtual

Definition at line 179 of file reporter.h.

Member Function Documentation

◆ Clear()

void WX_STRING_REPORTER::Clear ( )

Definition at line 90 of file reporter.cpp.

References m_severityMask, and m_string.

Referenced by SIMULATOR_FRAME::EditAnalysis(), SIMULATOR_FRAME::LoadSimulator(), SIMULATOR_FRAME::ReloadSimulator(), ERC_TESTER::TestSimModelIssues(), and DIALOG_SIM_MODEL< T >::TransferDataToWindow().

◆ GetMessages()

const wxString & WX_STRING_REPORTER::GetMessages ( ) const

◆ GetUnits()

virtual EDA_UNITS REPORTER::GetUnits ( ) const

inlinevirtualinherited

Reimplemented in WX_HTML_REPORT_BOX.

Definition at line 130 of file reporter.h.

◆ HasMessage()

bool WX_STRING_REPORTER::HasMessage ( ) const

overridevirtual

Returns true if the reporter client is non-empty.

Implements REPORTER.

Definition at line 97 of file reporter.cpp.

References m_string.

Referenced by SIMULATOR_FRAME_UI::applyTuners(), PCB_EDIT_FRAME::GenODBPPFiles(), SPICE_GENERATOR_IBIS::IbisDevice(), GERBVIEW_FRAME::LoadGerberJobFile(), GERBVIEW_FRAME::LoadZipArchiveFile(), SIM_MODEL::MigrateSimModel(), DIALOG_SIM_MODEL< T >::onLibraryPathTextEnter(), SIMULATOR_FRAME::showNetlistErrors(), SCH_EDITOR_CONTROL::SimProbe(), ERC_TESTER::TestSimModelIssues(), and DIALOG_SIM_MODEL< T >::TransferDataToWindow().

◆ HasMessageOfSeverity()

bool WX_STRING_REPORTER::HasMessageOfSeverity ( int aSeverityMask ) const

overridevirtual

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

Reimplemented from REPORTER.

Definition at line 103 of file reporter.cpp.

References m_severityMask.

Referenced by SIMULATOR_CONTROL::NewAnalysisTab(), and SIMULATOR_FRAME::showNetlistErrors().

◆ operator<<()

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

inlineinherited

Definition at line 117 of file reporter.h.

◆ Report() [1/2]

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

inherited

Definition at line 46 of file reporter.cpp.

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

◆ Report() [2/2]

REPORTER & WX_STRING_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

Implements REPORTER.

Definition at line 76 of file reporter.cpp.

References m_severityMask, and m_string.

Referenced by SIMULATOR_FRAME_UI::applyTuners(), and GERBVIEW_FRAME::LoadListOfGerberAndDrillFiles().