KiCad PCB EDA Suite
SIM_THREAD_REPORTER Class Reference
Inheritance diagram for SIM_THREAD_REPORTER:
SPICE_REPORTER REPORTER

Public Types

enum  SEVERITY {
  RPT_UNDEFINED = 0x0, RPT_INFO = 0x1, RPT_ACTION = 0x2, RPT_WARNING = 0x4,
  RPT_ERROR = 0x8
}
 Severity of the reported messages. More...
 
enum  LOCATION { LOC_HEAD = 0, LOC_BODY, LOC_TAIL }
 Location where the message is to be reported. More...
 

Public Member Functions

 SIM_THREAD_REPORTER (SIM_PLOT_FRAME *aParent)
 
REPORTERReport (const wxString &aText, SEVERITY aSeverity=RPT_UNDEFINED) override
 Function Report is a pure virtual function to override in the derived object. More...
 
bool HasMessage () const override
 Function HasMessage Returns true if the reporter client is non-empty. More...
 
void OnSimStateChange (SPICE_SIMULATOR *aObject, SIM_STATE aNewState) override
 
REPORTERReport (const char *aText, SEVERITY aSeverity=RPT_UNDEFINED)
 
virtual REPORTERReportTail (const wxString &aText, SEVERITY aSeverity=RPT_UNDEFINED)
 Function ReportTail Places the report at the end of the list, for objects that support report ordering. More...
 
virtual REPORTERReportHead (const wxString &aText, SEVERITY aSeverity=RPT_UNDEFINED)
 Function ReportHead Places the report at the beginning of the list for objects that support ordering. More...
 
REPORTERoperator<< (const wxString &aText)
 
REPORTERoperator<< (const wxChar *aText)
 
REPORTERoperator<< (wxChar aChar)
 
REPORTERoperator<< (const char *aText)
 

Private Attributes

SIM_PLOT_FRAMEm_parent
 

Detailed Description

Definition at line 56 of file sim_plot_frame.cpp.

Member Enumeration Documentation

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.

88  {
89  LOC_HEAD = 0,
90  LOC_BODY,
91  LOC_TAIL
92  };
enum REPORTER::SEVERITY
inherited

Severity of the reported messages.

Undefined are default status messages Info are processing messages for which no action is taken Action messages are items that modify the file(s) as expected Warning messages are items that might be problematic but don't prevent the process from completing Error messages are items that prevent the process from completing

Enumerator
RPT_UNDEFINED 
RPT_INFO 
RPT_ACTION 
RPT_WARNING 
RPT_ERROR 

Definition at line 74 of file reporter.h.

Constructor & Destructor Documentation

SIM_THREAD_REPORTER::SIM_THREAD_REPORTER ( SIM_PLOT_FRAME aParent)
inline

Definition at line 59 of file sim_plot_frame.cpp.

60  : m_parent( aParent )
61  {
62  }
SIM_PLOT_FRAME * m_parent

Member Function Documentation

bool SIM_THREAD_REPORTER::HasMessage ( ) const
inlineoverridevirtual

Function HasMessage Returns true if the reporter client is non-empty.

Implements REPORTER.

Definition at line 72 of file sim_plot_frame.cpp.

73  {
74  return false; // Technically "indeterminate" rather than false.
75  }
void SIM_THREAD_REPORTER::OnSimStateChange ( SPICE_SIMULATOR aObject,
SIM_STATE  aNewState 
)
inlineoverridevirtual

Implements SPICE_REPORTER.

Definition at line 77 of file sim_plot_frame.cpp.

References m_parent, SIM_IDLE, and SIM_RUNNING.

78  {
79  wxCommandEvent* event = NULL;
80 
81  switch( aNewState )
82  {
83  case SIM_IDLE:
84  event = new wxCommandEvent( EVT_SIM_FINISHED );
85  break;
86 
87  case SIM_RUNNING:
88  event = new wxCommandEvent( EVT_SIM_STARTED );
89  break;
90 
91  default:
92  wxFAIL;
93  return;
94  }
95 
96  wxQueueEvent( m_parent, event );
97  }
SIM_PLOT_FRAME * m_parent
REPORTER& REPORTER::operator<< ( const wxString &  aText)
inlineinherited

Definition at line 125 of file reporter.h.

References REPORTER::Report().

125 { return Report( aText ); }
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_UNDEFINED)=0
Function Report is a pure virtual function to override in the derived object.
REPORTER& REPORTER::operator<< ( const wxChar *  aText)
inlineinherited

Definition at line 126 of file reporter.h.

References REPORTER::Report().

126 { return Report( wxString( aText ) ); }
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_UNDEFINED)=0
Function Report is a pure virtual function to override in the derived object.
REPORTER& REPORTER::operator<< ( wxChar  aChar)
inlineinherited

Definition at line 127 of file reporter.h.

References REPORTER::Report().

127 { return Report( wxString( aChar ) ); }
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_UNDEFINED)=0
Function Report is a pure virtual function to override in the derived object.
REPORTER& REPORTER::operator<< ( const char *  aText)
inlineinherited

Definition at line 128 of file reporter.h.

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

128 { return Report( aText ); }
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_UNDEFINED)=0
Function Report is a pure virtual function to override in the derived object.
REPORTER& SIM_THREAD_REPORTER::Report ( const wxString &  aText,
SEVERITY  aSeverity = RPT_UNDEFINED 
)
inlineoverridevirtual

Function Report is a pure virtual function to override in the derived object.

Parameters
aTextis the string to report.
aSeverityis an indicator ( RPT_UNDEFINED, RPT_INFO, RPT_WARNING, RPT_ERROR, RPT_ACTION ) used to filter and format messages

Implements REPORTER.

Definition at line 64 of file sim_plot_frame.cpp.

References m_parent.

65  {
66  wxCommandEvent* event = new wxCommandEvent( EVT_SIM_REPORT );
67  event->SetString( aText );
68  wxQueueEvent( m_parent, event );
69  return *this;
70  }
SIM_PLOT_FRAME * m_parent
REPORTER & REPORTER::Report ( const char *  aText,
REPORTER::SEVERITY  aSeverity = RPT_UNDEFINED 
)
inherited

Definition at line 32 of file reporter.cpp.

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

33 {
34  Report( FROM_UTF8( aText ) );
35  return *this;
36 }
static wxString FROM_UTF8(const char *cstring)
function FROM_UTF8 converts a UTF8 encoded C string to a wxString for all wxWidgets build modes...
Definition: macros.h:53
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_UNDEFINED)=0
Function Report is a pure virtual function to override in the derived object.
virtual REPORTER& REPORTER::ReportHead ( const wxString &  aText,
SEVERITY  aSeverity = RPT_UNDEFINED 
)
inlinevirtualinherited

Function ReportHead Places the report at the beginning of the list for objects that support ordering.

Reimplemented in WX_HTML_PANEL_REPORTER.

Definition at line 118 of file reporter.h.

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

Referenced by DIALOG_EXPORT_STEP::onExportButton(), DIALOG_NETLIST::OnReadNetlistFileClick(), SCH_EDIT_FRAME::WriteNetListFile(), and WX_HTML_PANEL_REPORTER::WX_HTML_PANEL_REPORTER().

119  {
120  return Report( aText, aSeverity );
121  }
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_UNDEFINED)=0
Function Report is a pure virtual function to override in the derived object.
virtual REPORTER& REPORTER::ReportTail ( const wxString &  aText,
SEVERITY  aSeverity = RPT_UNDEFINED 
)
inlinevirtualinherited

Function ReportTail Places the report at the end of the list, for objects that support report ordering.

Reimplemented in WX_HTML_PANEL_REPORTER.

Definition at line 109 of file reporter.h.

References REPORTER::Report().

Referenced by SCH_EDIT_FRAME::AnnotateComponents(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), DIALOG_EXPORT_STEP::onExportButton(), DIALOG_UPDATE_PCB::PerformUpdate(), GERBER_JOBFILE_READER::ReadGerberJobFile(), DIALOG_ERC::TestErc(), BOARD_NETLIST_UPDATER::UpdateNetlist(), SCH_EDIT_FRAME::WriteNetListFile(), and WX_HTML_PANEL_REPORTER::WX_HTML_PANEL_REPORTER().

110  {
111  return Report( aText, aSeverity );
112  }
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_UNDEFINED)=0
Function Report is a pure virtual function to override in the derived object.

Member Data Documentation

SIM_PLOT_FRAME* SIM_THREAD_REPORTER::m_parent
private

Definition at line 100 of file sim_plot_frame.cpp.

Referenced by OnSimStateChange(), and Report().


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