KiCad PCB EDA Suite
Loading...
Searching...
No Matches
SIM_CONSOLE_REPORTER Class Reference
Inheritance diagram for SIM_CONSOLE_REPORTER:
SYNC_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_CONSOLE_REPORTER ()
 
wxString TakePendingMessages ()
 
REPORTERReport (const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED) override
 Report a string with a given severity.
 
REPORTERReport (const char *aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)
 
REPORTERReportTail (const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED) override
 Places the report at the end of the list, for objects that support report ordering.
 
REPORTERReportHead (const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED) override
 Places the report at the beginning of the list for objects that support ordering.
 
bool HasMessage () const override
 Returns true if any messages were reported.
 
bool HasMessageOfSeverity (int aSeverityMask) const override
 Returns true if the reporter has one or more messages matching the specified severity mask.
 
EDA_UNITS GetUnits () const override
 
void Clear () override
 
REPORTERoperator<< (const wxString &aText)
 

Protected Attributes

REPORTERm_reporter
 
std::mutex m_mutex
 

Private Attributes

WX_STRING_REPORTER m_strRep
 
int m_reportedSeverityMask
 

Detailed Description

Definition at line 67 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 87 of file reporter.h.

Constructor & Destructor Documentation

◆ SIM_CONSOLE_REPORTER()

SIM_CONSOLE_REPORTER::SIM_CONSOLE_REPORTER ( )
inline

Definition at line 70 of file simulator_frame.cpp.

References m_strRep, and SYNC_REPORTER::SYNC_REPORTER().

Member Function Documentation

◆ Clear()

void SYNC_REPORTER::Clear ( )
overridevirtualinherited

Reimplemented from REPORTER.

Definition at line 128 of file reporter.cpp.

References m_mutex, and m_reporter.

Referenced by BOOST_AUTO_TEST_CASE().

◆ GetUnits()

EDA_UNITS SYNC_REPORTER::GetUnits ( ) const
overridevirtualinherited

Reimplemented from REPORTER.

Definition at line 152 of file reporter.cpp.

References m_mutex, and m_reporter.

◆ HasMessage()

bool SYNC_REPORTER::HasMessage ( ) const
overridevirtualinherited

Returns true if any messages were reported.

Reimplemented from REPORTER.

Definition at line 136 of file reporter.cpp.

References m_mutex, and m_reporter.

Referenced by BOOST_AUTO_TEST_CASE().

◆ HasMessageOfSeverity()

bool SYNC_REPORTER::HasMessageOfSeverity ( int aSeverityMask) const
overridevirtualinherited

Returns true if the reporter has one or more messages matching the specified severity mask.

Reimplemented from REPORTER.

Definition at line 144 of file reporter.cpp.

References m_mutex, and m_reporter.

Referenced by BOOST_AUTO_TEST_CASE().

◆ operator<<()

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

Definition at line 128 of file reporter.h.

References Report(), and REPORTER().

◆ Report() [1/2]

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

Definition at line 73 of file reporter.cpp.

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

◆ Report() [2/2]

REPORTER & SYNC_REPORTER::Report ( const wxString & aText,
SEVERITY aSeverity = RPT_SEVERITY_UNDEFINED )
overridevirtualinherited

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

Reimplemented from REPORTER.

Definition at line 101 of file reporter.cpp.

References m_mutex, m_reporter, and REPORTER::REPORTER().

Referenced by BOOST_AUTO_TEST_CASE(), and BOOST_AUTO_TEST_CASE().

◆ ReportHead()

REPORTER & SYNC_REPORTER::ReportHead ( const wxString & aText,
SEVERITY aSeverity = RPT_SEVERITY_UNDEFINED )
overridevirtualinherited

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

Reimplemented from REPORTER.

Definition at line 119 of file reporter.cpp.

References m_mutex, m_reporter, and REPORTER::REPORTER().

Referenced by BOOST_AUTO_TEST_CASE().

◆ ReportTail()

REPORTER & SYNC_REPORTER::ReportTail ( const wxString & aText,
SEVERITY aSeverity = RPT_SEVERITY_UNDEFINED )
overridevirtualinherited

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

Reimplemented from REPORTER.

Definition at line 110 of file reporter.cpp.

References m_mutex, m_reporter, and REPORTER::REPORTER().

Referenced by BOOST_AUTO_TEST_CASE().

◆ TakePendingMessages()

wxString SIM_CONSOLE_REPORTER::TakePendingMessages ( )
inline

Definition at line 75 of file simulator_frame.cpp.

References SYNC_REPORTER::m_mutex, and m_strRep.

Member Data Documentation

◆ m_mutex

std::mutex SYNC_REPORTER::m_mutex
mutableprotectedinherited

◆ m_reportedSeverityMask

int REPORTER::m_reportedSeverityMask
privateinherited

Definition at line 158 of file reporter.h.

Referenced by Clear(), HasMessage(), HasMessageOfSeverity(), Report(), and REPORTER().

◆ m_reporter

REPORTER& SYNC_REPORTER::m_reporter
protectedinherited

◆ m_strRep

WX_STRING_REPORTER SIM_CONSOLE_REPORTER::m_strRep
private

Definition at line 86 of file simulator_frame.cpp.

Referenced by SIM_CONSOLE_REPORTER(), and TakePendingMessages().


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