KiCad PCB EDA Suite
RC_ITEM Class Reference

A holder for a rule check item, DRC in Pcbnew or ERC in Eeschema. More...

#include <rc_item.h>

Inheritance diagram for RC_ITEM:
CLEANUP_ITEM DRC_ITEM ERC_ITEM

Public Types

typedef std::vector< KIIDKIIDS
 

Public Member Functions

 RC_ITEM ()
 
 RC_ITEM (std::shared_ptr< RC_ITEM > aItem)
 
virtual ~RC_ITEM ()
 
void SetErrorMessage (const wxString &aMessage)
 
void SetItems (const KIIDS &aIds)
 
void AddItem (EDA_ITEM *aItem)
 
void SetItems (const EDA_ITEM *aItem, const EDA_ITEM *bItem=nullptr, const EDA_ITEM *cItem=nullptr, const EDA_ITEM *dItem=nullptr)
 
void SetItems (const KIID &aItem, const KIID &bItem=niluuid, const KIID &cItem=niluuid, const KIID &dItem=niluuid)
 
KIID GetMainItemID () const
 
KIID GetAuxItemID () const
 
KIID GetAuxItem2ID () const
 
KIID GetAuxItem3ID () const
 
void SetParent (MARKER_BASE *aMarker)
 
MARKER_BASEGetParent () const
 
virtual wxString ShowReport (EDA_UNITS aUnits, SEVERITY aSeverity, const std::map< KIID, EDA_ITEM * > &aItemMap) const
 Translate this object into a text string suitable for saving to disk in a report. More...
 
int GetErrorCode () const
 
void SetErrorCode (int aCode)
 
virtual wxString GetErrorMessage () const
 Return the error message of a RC_ITEM. More...
 
wxString GetErrorText () const
 
wxString GetSettingsKey () const
 
virtual wxString GetViolatingRuleDesc () const
 

Static Public Member Functions

static wxString ShowCoord (EDA_UNITS aUnits, const wxPoint &aPos)
 Format a coordinate or position to text. More...
 

Protected Attributes

int m_errorCode
 The error code's numeric value. More...
 
wxString m_errorMessage
 A message describing the details of this specific error. More...
 
wxString m_errorTitle
 The string describing the type of error. More...
 
wxString m_settingsKey
 The key used to describe this type of error in settings. More...
 
MARKER_BASEm_parent
 The marker this item belongs to, if any. More...
 
KIIDS m_ids
 

Detailed Description

A holder for a rule check item, DRC in Pcbnew or ERC in Eeschema.

RC_ITEMs can have zero, one, or two related EDA_ITEMs.

Definition at line 74 of file rc_item.h.

Member Typedef Documentation

◆ KIIDS

typedef std::vector<KIID> RC_ITEM::KIIDS

Definition at line 77 of file rc_item.h.

Constructor & Destructor Documentation

◆ RC_ITEM() [1/2]

RC_ITEM::RC_ITEM ( )
inline

Definition at line 79 of file rc_item.h.

79  :
80  m_errorCode( 0 ),
81  m_parent( nullptr )
82  {
83  }
int m_errorCode
The error code's numeric value.
Definition: rc_item.h:166
MARKER_BASE * m_parent
The marker this item belongs to, if any.
Definition: rc_item.h:170

◆ RC_ITEM() [2/2]

RC_ITEM::RC_ITEM ( std::shared_ptr< RC_ITEM aItem)
inline

Definition at line 85 of file rc_item.h.

86  {
87  m_errorCode = aItem->m_errorCode;
88  m_errorMessage = aItem->m_errorMessage;
89  m_errorTitle = aItem->m_errorTitle;
90  m_settingsKey = aItem->m_settingsKey;
91  m_parent = aItem->m_parent;
92  m_ids = aItem->m_ids;
93  }
KIIDS m_ids
Definition: rc_item.h:172
wxString m_settingsKey
The key used to describe this type of error in settings.
Definition: rc_item.h:169
int m_errorCode
The error code's numeric value.
Definition: rc_item.h:166
wxString m_errorMessage
A message describing the details of this specific error.
Definition: rc_item.h:167
MARKER_BASE * m_parent
The marker this item belongs to, if any.
Definition: rc_item.h:170
wxString m_errorTitle
The string describing the type of error.
Definition: rc_item.h:168

References m_errorCode, m_errorMessage, m_errorTitle, m_ids, m_parent, and m_settingsKey.

◆ ~RC_ITEM()

virtual RC_ITEM::~RC_ITEM ( )
inlinevirtual

Definition at line 95 of file rc_item.h.

95 { }

Member Function Documentation

◆ AddItem()

void RC_ITEM::AddItem ( EDA_ITEM aItem)

Definition at line 55 of file rc_item.cpp.

56 {
57  m_ids.push_back( aItem->m_Uuid );
58 }
KIIDS m_ids
Definition: rc_item.h:172
const KIID m_Uuid
Definition: eda_item.h:475

References m_ids, and EDA_ITEM::m_Uuid.

◆ GetAuxItem2ID()

KIID RC_ITEM::GetAuxItem2ID ( ) const
inline

Definition at line 122 of file rc_item.h.

122 { return m_ids.size() > 2 ? m_ids[2] : niluuid;; }
KIIDS m_ids
Definition: rc_item.h:172
KIID niluuid(0)

References m_ids, and niluuid.

◆ GetAuxItem3ID()

KIID RC_ITEM::GetAuxItem3ID ( ) const
inline

Definition at line 123 of file rc_item.h.

123 { return m_ids.size() > 3 ? m_ids[3] : niluuid;; }
KIIDS m_ids
Definition: rc_item.h:172
KIID niluuid(0)

References m_ids, and niluuid.

◆ GetAuxItemID()

KIID RC_ITEM::GetAuxItemID ( ) const
inline

Definition at line 121 of file rc_item.h.

121 { return m_ids.size() > 1 ? m_ids[1] : niluuid;; }
KIIDS m_ids
Definition: rc_item.h:172
KIID niluuid(0)

References m_ids, and niluuid.

Referenced by ShowReport().

◆ GetErrorCode()

int RC_ITEM::GetErrorCode ( ) const
inline

◆ GetErrorMessage()

wxString RC_ITEM::GetErrorMessage ( ) const
virtual

Return the error message of a RC_ITEM.

Definition at line 38 of file rc_item.cpp.

39 {
40  if( m_errorMessage.IsEmpty() )
41  return GetErrorText();
42  else
43  return m_errorMessage;
44 }
wxString GetErrorText() const
Definition: rc_item.h:145
wxString m_errorMessage
A message describing the details of this specific error.
Definition: rc_item.h:167

References GetErrorText(), and m_errorMessage.

Referenced by ShowReport().

◆ GetErrorText()

wxString RC_ITEM::GetErrorText ( ) const
inline

Definition at line 145 of file rc_item.h.

146  {
147  return wxGetTranslation( m_errorTitle );
148  }
wxString m_errorTitle
The string describing the type of error.
Definition: rc_item.h:168

References m_errorTitle.

Referenced by CLEANUP_ITEM::CLEANUP_ITEM(), GetErrorMessage(), and PANEL_SETUP_SEVERITIES::PANEL_SETUP_SEVERITIES().

◆ GetMainItemID()

KIID RC_ITEM::GetMainItemID ( ) const
inline

Definition at line 120 of file rc_item.h.

120 { return m_ids.size() > 0 ? m_ids[0] : niluuid; }
KIIDS m_ids
Definition: rc_item.h:172
KIID niluuid(0)

References m_ids, and niluuid.

Referenced by ShowReport().

◆ GetParent()

MARKER_BASE* RC_ITEM::GetParent ( void  ) const
inline

Definition at line 126 of file rc_item.h.

126 { return m_parent; }
MARKER_BASE * m_parent
The marker this item belongs to, if any.
Definition: rc_item.h:170

References m_parent.

◆ GetSettingsKey()

wxString RC_ITEM::GetSettingsKey ( ) const
inline

Definition at line 150 of file rc_item.h.

151  {
152  return m_settingsKey;
153  }
wxString m_settingsKey
The key used to describe this type of error in settings.
Definition: rc_item.h:169

References m_settingsKey.

Referenced by ShowReport().

◆ GetViolatingRuleDesc()

virtual wxString RC_ITEM::GetViolatingRuleDesc ( ) const
inlinevirtual

Reimplemented in DRC_ITEM.

Definition at line 155 of file rc_item.h.

156  {
157  return wxEmptyString;
158  }

Referenced by ShowReport().

◆ SetErrorCode()

void RC_ITEM::SetErrorCode ( int  aCode)
inline

Definition at line 138 of file rc_item.h.

138 { m_errorCode = aCode; }
int m_errorCode
The error code's numeric value.
Definition: rc_item.h:166

References m_errorCode.

◆ SetErrorMessage()

void RC_ITEM::SetErrorMessage ( const wxString &  aMessage)
inline

Definition at line 97 of file rc_item.h.

97 { m_errorMessage = aMessage; }
wxString m_errorMessage
A message describing the details of this specific error.
Definition: rc_item.h:167

References m_errorMessage.

◆ SetItems() [1/3]

void RC_ITEM::SetItems ( const KIIDS aIds)
inline

Definition at line 99 of file rc_item.h.

100  {
101  m_ids = aIds;
102  }
KIIDS m_ids
Definition: rc_item.h:172

References m_ids.

◆ SetItems() [2/3]

void RC_ITEM::SetItems ( const EDA_ITEM aItem,
const EDA_ITEM bItem = nullptr,
const EDA_ITEM cItem = nullptr,
const EDA_ITEM dItem = nullptr 
)

Definition at line 61 of file rc_item.cpp.

63 {
64  m_ids.clear();
65 
66  m_ids.push_back( aItem->m_Uuid );
67 
68  if( bItem )
69  m_ids.push_back( bItem->m_Uuid );
70 
71  if( cItem )
72  m_ids.push_back( cItem->m_Uuid );
73 
74  if( dItem )
75  m_ids.push_back( dItem->m_Uuid );
76 }
KIIDS m_ids
Definition: rc_item.h:172
const KIID m_Uuid
Definition: eda_item.h:475

References m_ids, and EDA_ITEM::m_Uuid.

◆ SetItems() [3/3]

void RC_ITEM::SetItems ( const KIID aItem,
const KIID bItem = niluuid,
const KIID cItem = niluuid,
const KIID dItem = niluuid 
)
inline

Definition at line 109 of file rc_item.h.

111  {
112  m_ids.clear();
113 
114  m_ids.push_back( aItem );
115  m_ids.push_back( bItem );
116  m_ids.push_back( cItem );
117  m_ids.push_back( dItem );
118  }
KIIDS m_ids
Definition: rc_item.h:172

References m_ids.

◆ SetParent()

void RC_ITEM::SetParent ( MARKER_BASE aMarker)
inline

Definition at line 125 of file rc_item.h.

125 { m_parent = aMarker; }
MARKER_BASE * m_parent
The marker this item belongs to, if any.
Definition: rc_item.h:170

References m_parent.

◆ ShowCoord()

wxString RC_ITEM::ShowCoord ( EDA_UNITS  aUnits,
const wxPoint &  aPos 
)
static

Format a coordinate or position to text.

Definition at line 47 of file rc_item.cpp.

48 {
49  return wxString::Format( "@(%s, %s)",
50  MessageTextFromValue( aUnits, aPos.x ),
51  MessageTextFromValue( aUnits, aPos.y ) );
52 }
wxString MessageTextFromValue(EDA_UNITS aUnits, int aValue, bool aAddUnitLabel, EDA_DATA_TYPE aType)
Convert a value to a string using double notation.
Definition: base_units.cpp:104
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200

References Format(), and MessageTextFromValue().

Referenced by ShowReport().

◆ ShowReport()

wxString RC_ITEM::ShowReport ( EDA_UNITS  aUnits,
SEVERITY  aSeverity,
const std::map< KIID, EDA_ITEM * > &  aItemMap 
) const
virtual

Translate this object into a text string suitable for saving to disk in a report.

Returns
wxString - the simple multi-line report text.

Definition at line 79 of file rc_item.cpp.

81 {
82  wxString severity;
83 
84  switch( aSeverity )
85  {
86  case RPT_SEVERITY_ERROR: severity = wxT( "Severity: error" ); break;
87  case RPT_SEVERITY_WARNING: severity = wxT( "Severity: warning" ); break;
88  case RPT_SEVERITY_ACTION: severity = wxT( "Severity: action" ); break;
89  case RPT_SEVERITY_INFO: severity = wxT( "Severity: info" ); break;
90  default: ;
91  };
92 
93  if( m_parent && m_parent->IsExcluded() )
94  severity += wxT( " (excluded)" );
95 
96  EDA_ITEM* mainItem = nullptr;
97  EDA_ITEM* auxItem = nullptr;
98 
99  auto ii = aItemMap.find( GetMainItemID() );
100 
101  if( ii != aItemMap.end() )
102  mainItem = ii->second;
103 
104  ii = aItemMap.find( GetAuxItemID() );
105 
106  if( ii != aItemMap.end() )
107  auxItem = ii->second;
108 
109  // Note: some customers machine-process these. So:
110  // 1) don't translate
111  // 2) try not to re-order or change syntax
112  // 3) report settings key (which should be more stable) in addition to message
113 
114  if( mainItem && auxItem )
115  {
116  return wxString::Format( wxT( "[%s]: %s\n %s; %s\n %s: %s\n %s: %s\n" ),
117  GetSettingsKey(),
118  GetErrorMessage(),
120  severity,
121  ShowCoord( aUnits, mainItem->GetPosition() ),
122  mainItem->GetSelectMenuText( aUnits ),
123  ShowCoord( aUnits, auxItem->GetPosition() ),
124  auxItem->GetSelectMenuText( aUnits ) );
125  }
126  else if( mainItem )
127  {
128  return wxString::Format( wxT( "[%s]: %s\n %s; %s\n %s: %s\n" ),
129  GetSettingsKey(),
130  GetErrorMessage(),
132  severity,
133  ShowCoord( aUnits, mainItem->GetPosition() ),
134  mainItem->GetSelectMenuText( aUnits ) );
135  }
136  else
137  {
138  return wxString::Format( wxT( "[%s]: %s\n %s; %s\n" ),
139  GetSettingsKey(),
140  GetErrorMessage(),
142  severity );
143  }
144 }
virtual wxPoint GetPosition() const
Definition: eda_item.h:252
virtual wxString GetViolatingRuleDesc() const
Definition: rc_item.h:155
static wxString ShowCoord(EDA_UNITS aUnits, const wxPoint &aPos)
Format a coordinate or position to text.
Definition: rc_item.cpp:47
KIID GetAuxItemID() const
Definition: rc_item.h:121
bool IsExcluded() const
Definition: marker_base.h:94
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
MARKER_BASE * m_parent
The marker this item belongs to, if any.
Definition: rc_item.h:170
virtual wxString GetSelectMenuText(EDA_UNITS aUnits) const
Return the text to display to be used in the selection clarification context menu when multiple items...
Definition: eda_item.cpp:109
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:100
wxString GetSettingsKey() const
Definition: rc_item.h:150
KIID GetMainItemID() const
Definition: rc_item.h:120
virtual wxString GetErrorMessage() const
Return the error message of a RC_ITEM.
Definition: rc_item.cpp:38

References Format(), GetAuxItemID(), GetErrorMessage(), GetMainItemID(), EDA_ITEM::GetPosition(), EDA_ITEM::GetSelectMenuText(), GetSettingsKey(), GetViolatingRuleDesc(), MARKER_BASE::IsExcluded(), m_parent, RPT_SEVERITY_ACTION, RPT_SEVERITY_ERROR, RPT_SEVERITY_INFO, RPT_SEVERITY_WARNING, and ShowCoord().

Member Data Documentation

◆ m_errorCode

int RC_ITEM::m_errorCode
protected

◆ m_errorMessage

wxString RC_ITEM::m_errorMessage
protected

A message describing the details of this specific error.

Definition at line 167 of file rc_item.h.

Referenced by GetErrorMessage(), RC_ITEM(), and SetErrorMessage().

◆ m_errorTitle

wxString RC_ITEM::m_errorTitle
protected

The string describing the type of error.

Definition at line 168 of file rc_item.h.

Referenced by CLEANUP_ITEM::CLEANUP_ITEM(), DRC_ITEM::DRC_ITEM(), ERC_ITEM::ERC_ITEM(), GetErrorText(), and RC_ITEM().

◆ m_ids

KIIDS RC_ITEM::m_ids
protected

◆ m_parent

MARKER_BASE* RC_ITEM::m_parent
protected

The marker this item belongs to, if any.

Definition at line 170 of file rc_item.h.

Referenced by DRC_ITEM::DRC_ITEM(), GetParent(), RC_ITEM(), SetParent(), and ShowReport().

◆ m_settingsKey

wxString RC_ITEM::m_settingsKey
protected

The key used to describe this type of error in settings.

Definition at line 169 of file rc_item.h.

Referenced by DRC_ITEM::DRC_ITEM(), ERC_ITEM::ERC_ITEM(), GetSettingsKey(), and RC_ITEM().


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