KiCad PCB EDA Suite
Loading...
Searching...
No Matches
SIM_THREAD_REPORTER Class Reference
Inheritance diagram for SIM_THREAD_REPORTER:
SIMULATOR_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 (SIMULATOR_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 (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

SIMULATOR_FRAMEm_parent
 

Detailed Description

Definition at line 64 of file simulator_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.

Constructor & Destructor Documentation

◆ SIM_THREAD_REPORTER()

SIM_THREAD_REPORTER::SIM_THREAD_REPORTER ( SIMULATOR_FRAME aParent)
inline

Definition at line 67 of file simulator_frame.cpp.

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.

◆ HasMessage()

bool SIM_THREAD_REPORTER::HasMessage ( ) const
inlineoverridevirtual

Returns true if the reporter client is non-empty.

Implements REPORTER.

Definition at line 80 of file simulator_frame.cpp.

◆ OnSimStateChange()

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

Implements SIMULATOR_REPORTER.

Definition at line 85 of file simulator_frame.cpp.

References m_parent, SIM_IDLE, and SIM_RUNNING.

◆ operator<<()

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

Definition at line 116 of file reporter.h.

References REPORTER::Report().

◆ Report() [1/2]

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

Definition at line 38 of file reporter.cpp.

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

◆ Report() [2/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 72 of file simulator_frame.cpp.

References m_parent.

◆ ReportHead()

virtual REPORTER & REPORTER::ReportHead ( const wxString &  aText,
SEVERITY  aSeverity = RPT_SEVERITY_UNDEFINED 
)
inlinevirtualinherited

◆ ReportTail()

Member Data Documentation

◆ m_parent

SIMULATOR_FRAME* SIM_THREAD_REPORTER::m_parent
private

Definition at line 100 of file simulator_frame.cpp.

Referenced by OnSimStateChange(), and Report().


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