#include <jobset.h>

Inheritance diagram for JOBSET_OUTPUT_REPORTER:

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

Public Member Functions
	JOBSET_OUTPUT_REPORTER (const wxString &aTempDirPath, PROGRESS_REPORTER *aProgressReporter)

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

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

const wxString &	GetMessages () const

void	Clear () override

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

Private Attributes
wxString	m_tempDirPath

bool	m_includeDebug

PROGRESS_REPORTER *	m_progressReporter

wxString	m_string

int	m_reportedSeverityMask

Detailed Description

Definition at line 35 of file jobset.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

◆ JOBSET_OUTPUT_REPORTER()

JOBSET_OUTPUT_REPORTER::JOBSET_OUTPUT_REPORTER	(	const wxString &	aTempDirPath,
		PROGRESS_REPORTER *	aProgressReporter )

inline

Definition at line 38 of file jobset.h.

References m_includeDebug, m_progressReporter, and m_tempDirPath.

Member Function Documentation

◆ Clear()

void WX_STRING_REPORTER::Clear ( )

overridevirtualinherited

Reimplemented from REPORTER.

Definition at line 83 of file reporter.cpp.

References REPORTER::Clear(), and m_string.

Referenced by BOOST_AUTO_TEST_CASE(), ERC_TESTER::TestSimModelIssues(), and DIALOG_SIM_MODEL< T >::TransferDataToWindow().

◆ GetMessages()

const wxString & WX_STRING_REPORTER::GetMessages ( ) const

inherited

Definition at line 77 of file reporter.cpp.

References m_string.

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(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), KI_TEST::CheckFootprint(), BITMAP2CMP_PANEL::ExportToBuffer(), BOARD_EDITOR_CONTROL::GenerateODBPPFiles(), SPICE_GENERATOR_IBIS::IbisDevice(), GERBVIEW_FRAME::LoadGerberJobFile(), GERBVIEW_FRAME::LoadListOfGerberAndDrillFiles(), GERBVIEW_FRAME::LoadZipArchiveFile(), SIMULATOR_CONTROL::NewAnalysisTab(), DIALOG_SIM_MODEL< T >::onBrowseButtonClick(), DIALOG_LIB_EDIT_PIN_TABLE::OnImportButtonClick(), DIALOG_SIM_MODEL< T >::onLibraryPathTextEnter(), DIALOG_BOM::OnRunGenerator(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProject(), SIMULATOR_FRAME::showNetlistErrors(), SCH_EDITOR_CONTROL::SimProbe(), ERC_TESTER::TestSimModelIssues(), DIALOG_SIM_MODEL< T >::TransferDataToWindow(), and TEST_NETLIST_EXPORTER_FIXTURE< Exporter >::WriteNetlist().

◆ 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 & JOBSET_OUTPUT_REPORTER::Report	(	const wxString &	aText,
		SEVERITY	aSeverity )

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 45 of file jobset.h.

References m_includeDebug, m_progressReporter, m_tempDirPath, WX_STRING_REPORTER::Report(), REPORTER::REPORTER(), RPT_SEVERITY_ACTION, RPT_SEVERITY_DEBUG, and text.