KiCad PCB EDA Suite
WX_STRING_REPORTER Class Reference

A wrapper for reporting to a wxString object. More...

#include <reporter.h>

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

 WX_STRING_REPORTER (wxString *aString)
 
virtual ~WX_STRING_REPORTER ()
 
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...
 
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

wxString * m_string
 

Detailed Description

A wrapper for reporting to a wxString object.

Definition at line 163 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,
81  LOC_BODY,
82  LOC_TAIL
83  };

Constructor & Destructor Documentation

◆ WX_STRING_REPORTER()

WX_STRING_REPORTER::WX_STRING_REPORTER ( wxString *  aString)
inline

Definition at line 166 of file reporter.h.

166  :
167  REPORTER(),
168  m_string( aString )
169  {
170  }
A pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:70
wxString * m_string
Definition: reporter.h:181

◆ ~WX_STRING_REPORTER()

virtual WX_STRING_REPORTER::~WX_STRING_REPORTER ( )
inlinevirtual

Definition at line 172 of file reporter.h.

173  {
174  }

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.

Referenced by BOARD_INSPECTION_TOOL::reportClearance().

◆ HasMessage()

bool WX_STRING_REPORTER::HasMessage ( ) const
overridevirtual

Returns true if the reporter client is non-empty.

Implements REPORTER.

Definition at line 69 of file reporter.cpp.

70 {
71  return !m_string->IsEmpty();
72 }
wxString * m_string
Definition: reporter.h:181

References m_string.

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

REPORTER & WX_STRING_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 59 of file reporter.cpp.

60 {
61  wxCHECK_MSG( m_string != nullptr, *this,
62  wxT( "No wxString object defined in WX_STRING_REPORTER." ) );
63 
64  *m_string << aText << wxS( "\n" );
65  return *this;
66 }
wxString * m_string
Definition: reporter.h:181

References m_string.

Referenced by GERBVIEW_FRAME::LoadExcellonFiles(), and GERBVIEW_FRAME::LoadListOfGerberAndDrillFiles().

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

wxString* WX_STRING_REPORTER::m_string
private

Definition at line 181 of file reporter.h.

Referenced by HasMessage(), and Report().


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