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  LOCATION { LOC_HEAD = 0, LOC_BODY, LOC_TAIL }
 Location where the message is to be reported. 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_SEVERITY_UNDEFINED)=0
 Report a string with a given severity. More...
 
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 bool HasMessage () const =0
 Returns true if the reporter client is non-empty. More...
 
virtual EDA_UNITS GetUnits () const
 

Detailed Description

Interface to receive simulation updates from SPICE_SIMULATOR class.

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

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

Constructor & Destructor Documentation

◆ ~SPICE_REPORTER()

virtual SPICE_REPORTER::~SPICE_REPORTER ( )
inlinevirtual

Definition at line 44 of file spice_reporter.h.

45  {
46  }

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

virtual bool REPORTER::HasMessage ( ) const
pure virtualinherited

◆ OnSimStateChange()

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

Implemented in SIM_THREAD_REPORTER.

Referenced by NGSPICE::cbBGThreadRunning().

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

virtual REPORTER& REPORTER::Report ( const wxString &  aText,
SEVERITY  aSeverity = RPT_SEVERITY_UNDEFINED 
)
pure virtualinherited

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

Implemented in INFOBAR_REPORTER, STATUSBAR_REPORTER, WXLOG_REPORTER, STDOUT_REPORTER, NULL_REPORTER, WX_HTML_PANEL_REPORTER, WX_STRING_REPORTER, WX_TEXT_CTRL_REPORTER, CONSOLE_MSG_REPORTER, SIM_THREAD_REPORTER, and WX_HTML_REPORT_BOX.

Referenced by GERBER_JOBFILE_WRITER::addJSONFilesAttributes(), GERBER_JOBFILE_WRITER::addJSONMaterialStackup(), BOARD_NETLIST_UPDATER::addNewFootprint(), SCH_EDIT_FRAME::AnnotateSymbols(), DIALOG_PLOT::applyPlotSettings(), PROJECT_ARCHIVER::Archive(), DIALOG_SYMBOL_REMAP::backupProject(), NGSPICE::cbSendChar(), DRC_RULE_CONDITION::Compile(), DIALOG_GEN_FOOTPRINT_POSITION::CreateAsciiFiles(), GERBER_WRITER::CreateDrillandMapFilesSet(), EXCELLON_WRITER::CreateDrillandMapFilesSet(), DIALOG_PLOT_SCHEMATIC::createDXFFiles(), DIALOG_GEN_FOOTPRINT_POSITION::CreateGerberFiles(), DIALOG_PLOT_SCHEMATIC::createHPGLFiles(), GERBER_JOBFILE_WRITER::CreateJobFile(), BOARD_ADAPTER::createLayers(), GENDRILL_WRITER_BASE::CreateMapFilesSet(), DIALOG_PLOT_SCHEMATIC::createPDFFile(), DIALOG_PLOT_SCHEMATIC::createPlotFileName(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), DIALOG_PLOT_SCHEMATIC::createPSFiles(), DIALOG_PLOT_SCHEMATIC::createSVGFiles(), EnsureFileDirectoryExists(), DRC_RULE_CONDITION::EvaluateFor(), DIALOG_EXPORT_SVG::ExportSVGFile(), HYPERLYNX_EXPORTER::formatPadShape(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), CADSTAR_SCH_ARCHIVE_LOADER::getLocationOfNetElement(), HelperGeneratePowerPortGraphics(), BOARD_ADAPTER::InitSettings(), CADSTAR_SCH_ARCHIVE_LOADER::Load(), RENDER_3D_OPENGL::load3dModels(), CADSTAR_SCH_ARCHIVE_LOADER::loadChildSheets(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), PCB_EDIT_FRAME::LoadFootprints(), SCH_EAGLE_PLUGIN::loadInstance(), CADSTAR_SCH_ARCHIVE_LOADER::loadPartsLibrary(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbol(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), CADSTAR_SCH_ARCHIVE_LOADER::loadTextVariables(), DIALOG_NETLIST::onFilenameChanged(), REPORTER::operator<<(), DRC_RULES_PARSER::Parse(), SCH_ALTIUM_PLUGIN::ParseAltiumSch(), SCH_ALTIUM_PLUGIN::ParseArc(), SCH_ALTIUM_PLUGIN::ParseBezier(), SCH_ALTIUM_PLUGIN::ParseDesignator(), SCH_ALTIUM_PLUGIN::ParseFileHeader(), SCH_ALTIUM_PLUGIN::ParseFileName(), SCH_ALTIUM_PLUGIN::ParseImage(), SCH_ALTIUM_PLUGIN::ParseImplementation(), SCH_ALTIUM_PLUGIN::ParseLabel(), SCH_ALTIUM_PLUGIN::ParseLine(), SCH_ALTIUM_PLUGIN::ParsePin(), SCH_ALTIUM_PLUGIN::ParsePolygon(), SCH_ALTIUM_PLUGIN::ParsePolyline(), SCH_ALTIUM_PLUGIN::ParsePort(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), SCH_ALTIUM_PLUGIN::ParseRectangle(), SCH_ALTIUM_PLUGIN::ParseRoundRectangle(), SCH_ALTIUM_PLUGIN::ParseSheetEntry(), SCH_ALTIUM_PLUGIN::ParseSheetName(), SCH_ALTIUM_PLUGIN::ParseStorage(), DRC_RULES_PARSER::parseValueWithUnits(), DIALOG_PLOT::Plot(), RENDER_3D_RAYTRACE::postProcessShading(), RENDER_3D_OPENGL::Redraw(), RENDER_3D_RAYTRACE::Redraw(), RENDER_3D_RAYTRACE::Reload(), RENDER_3D_OPENGL::reload(), DIALOG_SYMBOL_REMAP::remapSymbolsToLibTable(), RENDER_3D_RAYTRACE::render(), RENDER_3D_RAYTRACE::renderTracing(), BOARD_NETLIST_UPDATER::replaceFootprint(), REPORTER::Report(), DRC_ENGINE::ReportAux(), DRC_RULES_PARSER::reportError(), REPORTER::ReportHead(), REPORTER::ReportTail(), DRC_ENGINE::ReportViolation(), BOARD_NETLIST_UPDATER::testConnectivity(), PROJECT_ARCHIVER::Unarchive(), GERBVIEW_FRAME::unarchiveFiles(), BOARD_NETLIST_UPDATER::updateComponentPadConnections(), BOARD_NETLIST_UPDATER::updateCopperZoneNets(), BOARD_NETLIST_UPDATER::updateFootprintParameters(), BOARD_NETLIST_UPDATER::UpdateNetlist(), and SCH_EDIT_FRAME::WriteNetListFile().

◆ 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()


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