JOBSET_OUTPUT_REPORTER Class Reference

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)
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.
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 ()
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_tempDirPath
wxString	m_string
int	m_severityMask

Detailed Description

Definition at line 145 of file jobs_runner.cpp.

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

JOBSET_OUTPUT_REPORTER()

JOBSET_OUTPUT_REPORTER::JOBSET_OUTPUT_REPORTER ( const wxString &  aTempDirPath )

inline

Definition at line 148 of file jobs_runner.cpp.

Member Function Documentation

Clear()

void WX_STRING_REPORTER::Clear ( )

inherited

Definition at line 90 of file reporter.cpp.

References WX_STRING_REPORTER::m_severityMask, and WX_STRING_REPORTER::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

inherited

Definition at line 84 of file reporter.cpp.

References WX_STRING_REPORTER::m_string.

Referenced by SIMULATOR_FRAME_UI::applyTuners(), BOOST_AUTO_TEST_CASE(), BITMAP2CMP_PANEL::ExportToBuffer(), PCB_EDIT_FRAME::GenODBPPFiles(), SPICE_GENERATOR_IBIS::IbisDevice(), GERBVIEW_FRAME::LoadGerberJobFile(), GERBVIEW_FRAME::LoadListOfGerberAndDrillFiles(), GERBVIEW_FRAME::LoadZipArchiveFile(), SIMULATOR_CONTROL::NewAnalysisTab(), DIALOG_SIM_MODEL< T >::onBrowseButtonClick(), DIALOG_OUTPUT_RUN_RESULTS::OnJobListItemSelected(), 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 130 of file reporter.h.

HasMessage()

bool WX_STRING_REPORTER::HasMessage ( ) const

overridevirtualinherited

Returns true if the reporter client is non-empty.

Implements REPORTER.

Definition at line 97 of file reporter.cpp.

References WX_STRING_REPORTER::m_string.

Referenced by SIMULATOR_FRAME_UI::applyTuners(), BITMAP2CMP_PANEL::ExportToBuffer(), 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

overridevirtualinherited

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 WX_STRING_REPORTER::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 & 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 WX_STRING_REPORTER.

Definition at line 153 of file jobs_runner.cpp.

References m_tempDirPath, WX_STRING_REPORTER::Report(), RPT_SEVERITY_ACTION, 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 109 of file reporter.h.

Referenced by BACK_ANNOTATE::applyChangelist(), BACK_ANNOTATE::getPcbModulesFromString(), DIALOG_IMPORT_NETLIST::loadNetlist(), DIALOG_ERC::OnRunERCClick(), BACK_ANNOTATE::processNetNameChange(), 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 100 of file reporter.h.

Referenced by SCH_EDIT_FRAME::AnnotateSymbols(), BACK_ANNOTATE::BackAnnotateSymbols(), BACK_ANNOTATE::checkForUnusedSymbols(), EXCELLON_WRITER::CreateDrillandMapFilesSet(), GERBER_WRITER::CreateDrillandMapFilesSet(), SCH_PLOTTER::createDXFFiles(), SCH_PLOTTER::createHPGLFiles(), SCH_PLOTTER::createPDFFile(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), SCH_PLOTTER::createPSFiles(), SCH_PLOTTER::createSVGFiles(), BACK_ANNOTATE::getChangeList(), PCB_PLOTTER::Plot(), GERBER_JOBFILE_READER::ReadGerberJobFile(), BOARD_NETLIST_UPDATER::UpdateNetlist(), SCH_SCREEN::UpdateSymbolLinks(), and SCH_EDIT_FRAME::WriteNetListFile().

Member Data Documentation

m_severityMask

int WX_STRING_REPORTER::m_severityMask

privateinherited

Definition at line 193 of file reporter.h.

Referenced by WX_STRING_REPORTER::Clear(), WX_STRING_REPORTER::HasMessageOfSeverity(), and WX_STRING_REPORTER::Report().

m_string

wxString WX_STRING_REPORTER::m_string

privateinherited

Definition at line 192 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 164 of file jobs_runner.cpp.

Referenced by Report().

---

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

• jobs_runner.cpp