KiCad PCB EDA Suite
SPICE_REPORTER Class Referenceabstract

Interface to receive simulation updates from SPICE_SIMULATOR class. More...

#include <spice_reporter.h>

Inheritance diagram for SPICE_REPORTER:
REPORTER SIM_THREAD_REPORTER

Public Types

enum  SEVERITY {
  RPT_UNDEFINED = 0x0, RPT_INFO = 0x1, RPT_WARNING = 0x2, RPT_ERROR = 0x4,
  RPT_ACTION = 0x8
}
 

Severity of the reported messages.

More...
 

Public Member Functions

virtual ~SPICE_REPORTER ()
 
virtual void OnSimStateChange (SPICE_SIMULATOR *aObject, SIM_STATE aNewState)=0
 
virtual REPORTERReport (const wxString &aText, SEVERITY aSeverity=RPT_UNDEFINED)=0
 Function Report is a pure virtual function to override in the derived object. More...
 
REPORTERReport (const char *aText, SEVERITY aSeverity=RPT_UNDEFINED)
 
REPORTERoperator<< (const wxString &aText)
 
REPORTERoperator<< (const wxChar *aText)
 
REPORTERoperator<< (wxChar aChar)
 
REPORTERoperator<< (const char *aText)
 

Detailed Description

Interface to receive simulation updates from SPICE_SIMULATOR class.

Definition at line 41 of file spice_reporter.h.

Member Enumeration Documentation

enum REPORTER::SEVERITY
inherited

Severity of the reported messages.

Enumerator
RPT_UNDEFINED 
RPT_INFO 
RPT_WARNING 
RPT_ERROR 
RPT_ACTION 

Definition at line 65 of file reporter.h.

65  {
66  RPT_UNDEFINED = 0x0,
67  RPT_INFO = 0x1,
68  RPT_WARNING = 0x2,
69  RPT_ERROR = 0x4,
70  RPT_ACTION = 0x8
71  };

Constructor & Destructor Documentation

virtual SPICE_REPORTER::~SPICE_REPORTER ( )
inlinevirtual

Definition at line 44 of file spice_reporter.h.

45  {
46  }

Member Function Documentation

virtual void SPICE_REPORTER::OnSimStateChange ( SPICE_SIMULATOR aObject,
SIM_STATE  aNewState 
)
pure virtual

Implemented in SIM_THREAD_REPORTER.

Referenced by NGSPICE::cbBGThreadRunning().

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

Definition at line 84 of file reporter.h.

References REPORTER::Report().

84 { 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 85 of file reporter.h.

References REPORTER::Report().

85 { 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 86 of file reporter.h.

References REPORTER::Report().

86 { 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 87 of file reporter.h.

References REPORTER::Report().

87 { 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.
virtual REPORTER& REPORTER::Report ( const wxString &  aText,
SEVERITY  aSeverity = RPT_UNDEFINED 
)
pure virtualinherited

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

Parameters
aTextis the string to report.

Implemented in NULL_REPORTER, WX_HTML_PANEL_REPORTER, WX_STRING_REPORTER, WX_TEXT_CTRL_REPORTER, SIM_THREAD_REPORTER, and STATUS_TEXT_REPORTER.

Referenced by BOARD_NETLIST_UPDATER::addNewComponent(), DIALOG_PLOT::applyPlotSettings(), NGSPICE::cbSendChar(), EXCELLON_WRITER::CreateDrillandMapFilesSet(), DIALOG_PLOT_SCHEMATIC::CreateDXFFile(), DIALOG_GEN_MODULE_POSITION::CreateFiles(), DIALOG_PLOT_SCHEMATIC::createHPGLFile(), CINFO3D_VISU::createLayers(), DIALOG_PLOT_SCHEMATIC::createPDFFile(), DIALOG_PLOT_SCHEMATIC::createPlotFileName(), DIALOG_PLOT_SCHEMATIC::createPSFile(), DIALOG_PLOT_SCHEMATIC::createSVGFile(), BOARD_NETLIST_UPDATER::deleteSinglePadNets(), BOARD_NETLIST_UPDATER::deleteUnusedComponents(), EnsureFileDirectoryExists(), DIALOG_SVG_PRINT::ExportSVGFile(), CINFO3D_VISU::InitSettings(), DIALOG_NETLIST::OnReadNetlistFileClick(), REPORTER::operator<<(), DIALOG_UPDATE_PCB::PerformUpdate(), DIALOG_PLOT::Plot(), C3D_RENDER_RAYTRACING::Redraw(), C3D_RENDER_OGL_LEGACY::Redraw(), C3D_RENDER_OGL_LEGACY::reload(), C3D_RENDER_RAYTRACING::reload(), C3D_RENDER_RAYTRACING::render(), BOARD_NETLIST_UPDATER::replaceComponent(), BOARD::ReplaceNetlist(), REPORTER::Report(), C3D_RENDER_RAYTRACING::rt_render_post_process_shade(), C3D_RENDER_RAYTRACING::rt_render_tracing(), BOARD_NETLIST_UPDATER::testConnectivity(), GERBVIEW_FRAME::unarchiveFiles(), BOARD_NETLIST_UPDATER::updateComponentPadConnections(), BOARD_NETLIST_UPDATER::updateComponentParameters(), BOARD_NETLIST_UPDATER::UpdateNetlist(), and SCH_EDIT_FRAME::WriteNetListFile().

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.

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