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

Public Types

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_SEVERITY_UNDEFINED) override
 Report a string with a given severity. More...
 
bool HasMessage () const override
 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_SEVERITY_UNDEFINED)
 
virtual REPORTERReportTail (const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)
 Places the report at the end of the list, for objects that support report ordering. More...
 
virtual REPORTERReportHead (const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)
 Places the report at the beginning of the list for objects that support ordering. More...
 
REPORTERoperator<< (const wxString &aText)
 
virtual EDA_UNITS GetUnits () const
 

Private Attributes

SIM_PLOT_FRAMEm_parent
 

Detailed Description

Definition at line 65 of file sim_plot_frame.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 79 of file reporter.h.

79  {
80  LOC_HEAD = 0,
81  LOC_BODY,
82  LOC_TAIL
83  };

Constructor & Destructor Documentation

◆ SIM_THREAD_REPORTER()

SIM_THREAD_REPORTER::SIM_THREAD_REPORTER ( SIM_PLOT_FRAME aParent)
inline

Definition at line 68 of file sim_plot_frame.cpp.

68  :
69  m_parent( aParent )
70  {
71  }
SIM_PLOT_FRAME * m_parent

Member Function Documentation

◆ GetUnits()

virtual EDA_UNITS REPORTER::GetUnits ( ) const
inlinevirtualinherited

Reimplemented in WX_HTML_REPORT_BOX.

Definition at line 123 of file reporter.h.

124  {
125  return EDA_UNITS::MILLIMETRES;
126  }

References MILLIMETRES.

◆ HasMessage()

bool SIM_THREAD_REPORTER::HasMessage ( ) const
inlineoverridevirtual

Returns true if the reporter client is non-empty.

Implements REPORTER.

Definition at line 81 of file sim_plot_frame.cpp.

82  {
83  return false; // Technically "indeterminate" rather than false.
84  }

◆ OnSimStateChange()

void SIM_THREAD_REPORTER::OnSimStateChange ( SPICE_SIMULATOR aObject,
SIM_STATE  aNewState 
)
inlineoverridevirtual

Implements SPICE_REPORTER.

Definition at line 86 of file sim_plot_frame.cpp.

87  {
88  wxCommandEvent* event = nullptr;
89 
90  switch( aNewState )
91  {
92  case SIM_IDLE:
93  event = new wxCommandEvent( EVT_SIM_FINISHED );
94  break;
95 
96  case SIM_RUNNING:
97  event = new wxCommandEvent( EVT_SIM_STARTED );
98  break;
99 
100  default:
101  wxFAIL;
102  return;
103  }
104 
105  wxQueueEvent( m_parent, event );
106  }
SIM_PLOT_FRAME * m_parent

References m_parent, SIM_IDLE, and SIM_RUNNING.

◆ operator<<()

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

Definition at line 116 of file reporter.h.

116 { return Report( aText ); }
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)=0
Report a string with a given severity.

References REPORTER::Report().

◆ Report() [1/2]

REPORTER& SIM_THREAD_REPORTER::Report ( const wxString &  aText,
SEVERITY  aSeverity = RPT_SEVERITY_UNDEFINED 
)
inlineoverridevirtual

Report a string with a given severity.

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 73 of file sim_plot_frame.cpp.

74  {
75  wxCommandEvent* event = new wxCommandEvent( EVT_SIM_REPORT );
76  event->SetString( aText );
77  wxQueueEvent( m_parent, event );
78  return *this;
79  }
SIM_PLOT_FRAME * m_parent

References m_parent.

◆ Report() [2/2]

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

Definition at line 36 of file reporter.cpp.

37 {
38  Report( FROM_UTF8( aText ) );
39  return *this;
40 }
static wxString FROM_UTF8(const char *cstring)
Convert a UTF8 encoded C string to a wxString for all wxWidgets build modes.
Definition: macros.h:110
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)=0
Report a string with a given severity.

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

◆ 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 108 of file reporter.h.

110  {
111  return Report( aText, aSeverity );
112  }
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)=0
Report a string with a given severity.

References REPORTER::Report().

Referenced by BACK_ANNOTATE::applyChangelist(), BACK_ANNOTATE::getPcbModulesFromString(), DIALOG_NETLIST::loadNetlist(), DIALOG_ERC::OnRunERCClick(), BACK_ANNOTATE::processNetNameChange(), and SCH_EDIT_FRAME::WriteNetListFile().

◆ ReportTail()

Member Data Documentation

◆ m_parent

SIM_PLOT_FRAME* SIM_THREAD_REPORTER::m_parent
private

Definition at line 109 of file sim_plot_frame.cpp.

Referenced by OnSimStateChange(), and Report().


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