KiCad PCB EDA Suite
CONSOLE_MSG_REPORTER Class Reference

#include <drc_proto.h>

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

 CONSOLE_MSG_REPORTER (CONSOLE_LOG *log)
 
 ~CONSOLE_MSG_REPORTER ()
 
virtual REPORTERReport (const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED) override
 Report a string with a given severity. More...
 
virtual 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
 

Private Attributes

CONSOLE_LOGm_log
 

Detailed Description

Definition at line 125 of file drc_proto.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

◆ CONSOLE_MSG_REPORTER()

CONSOLE_MSG_REPORTER::CONSOLE_MSG_REPORTER ( CONSOLE_LOG log)
inline

Definition at line 128 of file drc_proto.h.

128  :
129  m_log(log)
130  {};
CONSOLE_LOG * m_log
Definition: drc_proto.h:160

◆ ~CONSOLE_MSG_REPORTER()

CONSOLE_MSG_REPORTER::~CONSOLE_MSG_REPORTER ( )
inline

Definition at line 131 of file drc_proto.h.

131 {};

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 CONSOLE_MSG_REPORTER::HasMessage ( ) const
inlineoverridevirtual

Returns true if the reporter client is non-empty.

Implements REPORTER.

Definition at line 154 of file drc_proto.h.

155  {
156  return true;
157  }

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

◆ Report() [2/2]

virtual REPORTER& CONSOLE_MSG_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 134 of file drc_proto.h.

136  {
137  switch( aSeverity )
138  {
139  case RPT_SEVERITY_ERROR:
141  m_log->Print("ERROR | ");
142  break;
143 
144  default:
146  m_log->Print(" | ");
147  }
148 
150  m_log->Print( aText + "\n" );
151  return *this;
152  }
CONSOLE_LOG * m_log
Definition: drc_proto.h:160
void Print(const wxString &aMessage)
Definition: drc_proto.h:60
void SetColor(COLOR color)
Definition: drc_proto.h:72

References CONSOLE_LOG::DEFAULT, m_log, CONSOLE_LOG::Print(), CONSOLE_LOG::RED, RPT_SEVERITY_ERROR, and CONSOLE_LOG::SetColor().

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

Member Data Documentation

◆ m_log

CONSOLE_LOG* CONSOLE_MSG_REPORTER::m_log
private

Definition at line 160 of file drc_proto.h.

Referenced by Report().


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