KiCad PCB EDA Suite
STDOUT_REPORTER Class Reference

Debug type reporter, forwarding messages to std::cout. More...

#include <reporter.h>

Inheritance diagram for STDOUT_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

 STDOUT_REPORTER ()
 
virtual ~STDOUT_REPORTER ()
 
REPORTERReport (const wxString &aMsg, 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...
 
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
 

Static Public Member Functions

static REPORTERGetInstance ()
 

Detailed Description

Debug type reporter, forwarding messages to std::cout.

Definition at line 245 of file 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,
83 };
@ LOC_BODY
Definition: reporter.h:81
@ LOC_TAIL
Definition: reporter.h:82
@ LOC_HEAD
Definition: reporter.h:80

Constructor & Destructor Documentation

◆ STDOUT_REPORTER()

STDOUT_REPORTER::STDOUT_REPORTER ( )
inline

Definition at line 248 of file reporter.h.

249 {
250 }

Referenced by GetInstance().

◆ ~STDOUT_REPORTER()

virtual STDOUT_REPORTER::~STDOUT_REPORTER ( )
inlinevirtual

Definition at line 252 of file reporter.h.

253 {
254 }

Member Function Documentation

◆ GetInstance()

REPORTER & STDOUT_REPORTER::GetInstance ( )
static

Definition at line 147 of file reporter.cpp.

148{
149 static REPORTER* s_stdoutReporter = nullptr;
150
151 if( !s_stdoutReporter )
152 s_stdoutReporter = new STDOUT_REPORTER();
153
154 return *s_stdoutReporter;
155}
A pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:71

References STDOUT_REPORTER().

◆ GetUnits()

virtual EDA_UNITS REPORTER::GetUnits ( ) const
inlinevirtualinherited

Reimplemented in WX_HTML_REPORT_BOX.

Definition at line 123 of file reporter.h.

124 {
126 }

References MILLIMETRES.

◆ HasMessage()

bool STDOUT_REPORTER::HasMessage ( ) const
inlineoverridevirtual

Returns true if the reporter client is non-empty.

Implements REPORTER.

Definition at line 260 of file reporter.h.

260{ return false; }

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

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

◆ Report() [2/2]

REPORTER & STDOUT_REPORTER::Report ( const wxString &  aText,
SEVERITY  aSeverity = RPT_SEVERITY_UNDEFINED 
)
overridevirtual

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 128 of file reporter.cpp.

129{
130 switch( aSeverity )
131 {
132 case RPT_SEVERITY_UNDEFINED: std::cout << "SEVERITY_UNDEFINED: "; break;
133 case RPT_SEVERITY_INFO: std::cout << "SEVERITY_INFO: "; break;
134 case RPT_SEVERITY_WARNING: std::cout << "SEVERITY_WARNING: "; break;
135 case RPT_SEVERITY_ERROR: std::cout << "SEVERITY_ERROR: "; break;
136 case RPT_SEVERITY_ACTION: std::cout << "SEVERITY_ACTION: "; break;
138 case RPT_SEVERITY_IGNORE: break;
139 }
140
141 std::cout << aMsg << std::endl;
142
143 return *this;
144}
@ RPT_SEVERITY_WARNING
@ RPT_SEVERITY_ERROR
@ RPT_SEVERITY_UNDEFINED
@ RPT_SEVERITY_EXCLUSION
@ RPT_SEVERITY_IGNORE
@ RPT_SEVERITY_INFO
@ RPT_SEVERITY_ACTION

References RPT_SEVERITY_ACTION, RPT_SEVERITY_ERROR, RPT_SEVERITY_EXCLUSION, RPT_SEVERITY_IGNORE, RPT_SEVERITY_INFO, RPT_SEVERITY_UNDEFINED, and RPT_SEVERITY_WARNING.

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

References REPORTER::Report().

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

◆ ReportTail()


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