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

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

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

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.

Member Function Documentation

◆ Clear()

void WX_STRING_REPORTER::Clear ( )

overridevirtualinherited

Reimplemented from REPORTER.

Definition at line 89 of file reporter.cpp.

References REPORTER::Clear(), and WX_STRING_REPORTER::m_string.

Referenced by BOOST_AUTO_TEST_CASE(), 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

inherited

Definition at line 83 of file reporter.cpp.

References WX_STRING_REPORTER::m_string.

Referenced by SIMULATOR_FRAME_UI::applyTuners(), BOOST_AUTO_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 145 of file reporter.h.

Referenced by BOOST_AUTO_TEST_CASE().

◆ HasMessage()

bool WX_STRING_REPORTER::HasMessage ( ) const

overridevirtualinherited

Returns true if the reporter client is non-empty.

Implements REPORTER.

Definition at line 96 of file reporter.cpp.

References WX_STRING_REPORTER::m_string.

Referenced by SIMULATOR_FRAME_UI::applyTuners(), 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 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/2]

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/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 PROGRESS_REPORTER::KeepRefreshing(), m_includeDebug, m_progressReporter, m_tempDirPath, PROGRESS_REPORTER::Report(), WX_STRING_REPORTER::Report(), RPT_SEVERITY_ACTION, RPT_SEVERITY_DEBUG, and text.

◆ 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_includeDebug

bool JOBSET_OUTPUT_REPORTER::m_includeDebug

private

Definition at line 66 of file jobset.h.

Referenced by Report().

◆ m_progressReporter

PROGRESS_REPORTER* JOBSET_OUTPUT_REPORTER::m_progressReporter

private

Definition at line 67 of file jobset.h.

Referenced by Report().

◆ m_severityMask

int REPORTER::m_severityMask

privateinherited

Definition at line 156 of file reporter.h.

◆ m_string

wxString WX_STRING_REPORTER::m_string

privateinherited

Definition at line 207 of file reporter.h.

Referenced by WX_STRING_REPORTER::Clear(), WX_STRING_REPORTER::GetMessages(), WX_STRING_REPORTER::HasMessage(), and WX_STRING_REPORTER::Report().

◆ m_tempDirPath

wxString JOBSET_OUTPUT_REPORTER::m_tempDirPath

private

Definition at line 65 of file jobset.h.

Referenced by Report().

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

jobset.h

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ LOCATION

Constructor & Destructor Documentation

◆ JOBSET_OUTPUT_REPORTER()

Member Function Documentation

◆ Clear()

◆ GetMessages()

◆ GetUnits()

◆ HasMessage()

◆ HasMessageOfSeverity()

◆ operator<<()

◆ Report() [1/2]

◆ Report() [2/2]

◆ ReportHead()

◆ ReportTail()

Member Data Documentation

◆ m_includeDebug

◆ m_progressReporter

◆ m_severityMask

◆ m_string

◆ m_tempDirPath