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)
 
virtual KIID GetMainItemID () const
 
virtual KIID GetAuxItemID () const
 
virtual KIID GetAuxItem2ID () const
 
virtual KIID GetAuxItem3ID () const
 
std::vector< KIIDGetIDs () const
 
void SetParent (MARKER_BASE *aMarker)
 
MARKER_BASEGetParent () const
 
virtual wxString ShowReport (UNITS_PROVIDER *aUnitsProvider, 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
 
wxString GetErrorText () const
 
wxString GetSettingsKey () const
 
virtual wxString GetViolatingRuleDesc () const
 

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:165
MARKER_BASE * m_parent
The marker this item belongs to, if any.
Definition: rc_item.h:169

◆ 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 }
wxString m_settingsKey
The key used to describe this type of error in settings.
Definition: rc_item.h:168
KIIDS m_ids
Definition: rc_item.h:171
wxString m_errorMessage
A message describing the details of this specific error.
Definition: rc_item.h:166
wxString m_errorTitle
The string describing the type of error.
Definition: rc_item.h:167

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}
const KIID m_Uuid
Definition: eda_item.h:492

References m_ids, and EDA_ITEM::m_Uuid.

◆ GetAuxItem2ID()

virtual KIID RC_ITEM::GetAuxItem2ID ( ) const
inlinevirtual

Reimplemented in DRC_ITEM.

Definition at line 119 of file rc_item.h.

119{ return m_ids.size() > 2 ? m_ids[2] : niluuid; }
KIID niluuid(0)

References m_ids, and niluuid.

◆ GetAuxItem3ID()

virtual KIID RC_ITEM::GetAuxItem3ID ( ) const
inlinevirtual

Reimplemented in DRC_ITEM.

Definition at line 120 of file rc_item.h.

120{ return m_ids.size() > 3 ? m_ids[3] : niluuid; }

References m_ids, and niluuid.

◆ GetAuxItemID()

virtual KIID RC_ITEM::GetAuxItemID ( ) const
inlinevirtual

Definition at line 118 of file rc_item.h.

118{ return m_ids.size() > 1 ? m_ids[1] : niluuid; }

References m_ids, and niluuid.

Referenced by ShowReport().

◆ GetErrorCode()

◆ GetErrorMessage()

wxString RC_ITEM::GetErrorMessage ( ) const
virtual
Returns
the error message describing the specific details of a RC_ITEM. For instance, "Clearance violation (netclass '100ohm' clearance 0.4000mm; actual 0.3200mm)"

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:149

References GetErrorText(), and m_errorMessage.

Referenced by ShowReport().

◆ GetErrorText()

wxString RC_ITEM::GetErrorText ( ) const
inline
Returns
the error text for the class of error of this RC_ITEM represents. For instance, "Clearance violation".

Definition at line 149 of file rc_item.h.

150 {
151 return wxGetTranslation( m_errorTitle );
152 }

References m_errorTitle.

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

◆ GetIDs()

std::vector< KIID > RC_ITEM::GetIDs ( ) const
inline

Definition at line 122 of file rc_item.h.

122{ return m_ids; }

References m_ids.

◆ GetMainItemID()

virtual KIID RC_ITEM::GetMainItemID ( ) const
inlinevirtual

Definition at line 117 of file rc_item.h.

117{ return m_ids.size() > 0 ? m_ids[0] : niluuid; }

References m_ids, and niluuid.

Referenced by ShowReport().

◆ GetParent()

MARKER_BASE * RC_ITEM::GetParent ( void  ) const
inline

Definition at line 125 of file rc_item.h.

125{ return m_parent; }

References m_parent.

◆ GetSettingsKey()

wxString RC_ITEM::GetSettingsKey ( ) const
inline

Definition at line 154 of file rc_item.h.

155 {
156 return m_settingsKey;
157 }

References m_settingsKey.

Referenced by ShowReport().

◆ GetViolatingRuleDesc()

virtual wxString RC_ITEM::GetViolatingRuleDesc ( ) const
inlinevirtual

Reimplemented in DRC_ITEM.

Definition at line 159 of file rc_item.h.

160 {
161 return wxEmptyString;
162 }

Referenced by ShowReport().

◆ SetErrorCode()

void RC_ITEM::SetErrorCode ( int  aCode)
inline

Definition at line 137 of file rc_item.h.

137{ m_errorCode = aCode; }

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

References m_errorMessage.

◆ SetItems() [1/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}

References m_ids, and EDA_ITEM::m_Uuid.

◆ SetItems() [2/3]

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

Definition at line 106 of file rc_item.h.

108 {
109 m_ids.clear();
110
111 m_ids.push_back( aItem );
112 m_ids.push_back( bItem );
113 m_ids.push_back( cItem );
114 m_ids.push_back( dItem );
115 }

References m_ids.

◆ SetItems() [3/3]

void RC_ITEM::SetItems ( const KIIDS aIds)
inline

Definition at line 99 of file rc_item.h.

99{ m_ids = aIds; }

References m_ids.

◆ SetParent()

void RC_ITEM::SetParent ( MARKER_BASE aMarker)
inline

Definition at line 124 of file rc_item.h.

124{ m_parent = aMarker; }

References m_parent.

◆ ShowReport()

wxString RC_ITEM::ShowReport ( UNITS_PROVIDER aUnitsProvider,
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 case RPT_SEVERITY_EXCLUSION: severity = wxT( "Severity: exclusion" ); break;
91 case RPT_SEVERITY_DEBUG: severity = wxT( "Severity: debug" ); break;
92 default: ;
93 };
94
95 if( m_parent && m_parent->IsExcluded() )
96 severity += wxT( " (excluded)" );
97
98 EDA_ITEM* mainItem = nullptr;
99 EDA_ITEM* auxItem = nullptr;
100
101 auto ii = aItemMap.find( GetMainItemID() );
102
103 if( ii != aItemMap.end() )
104 mainItem = ii->second;
105
106 ii = aItemMap.find( GetAuxItemID() );
107
108 if( ii != aItemMap.end() )
109 auxItem = ii->second;
110
111 // Note: some customers machine-process these. So:
112 // 1) don't translate
113 // 2) try not to re-order or change syntax
114 // 3) report settings key (which should be more stable) in addition to message
115
116 if( mainItem && auxItem )
117 {
118 return wxString::Format( wxT( "[%s]: %s\n %s; %s\n %s: %s\n %s: %s\n" ),
122 severity,
123 showCoord( aUnitsProvider, mainItem->GetPosition()),
124 mainItem->GetSelectMenuText( aUnitsProvider ),
125 showCoord( aUnitsProvider, auxItem->GetPosition()),
126 auxItem->GetSelectMenuText( aUnitsProvider ) );
127 }
128 else if( mainItem )
129 {
130 return wxString::Format( wxT( "[%s]: %s\n %s; %s\n %s: %s\n" ),
134 severity,
135 showCoord( aUnitsProvider, mainItem->GetPosition()),
136 mainItem->GetSelectMenuText( aUnitsProvider ) );
137 }
138 else
139 {
140 return wxString::Format( wxT( "[%s]: %s\n %s; %s\n" ),
144 severity );
145 }
146}
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:85
virtual VECTOR2I GetPosition() const
Definition: eda_item.h:249
virtual wxString GetSelectMenuText(UNITS_PROVIDER *aUnitsProvider) const
Return the text to display to be used in the selection clarification context menu when multiple items...
Definition: eda_item.cpp:108
bool IsExcluded() const
Definition: marker_base.h:97
virtual KIID GetMainItemID() const
Definition: rc_item.h:117
virtual KIID GetAuxItemID() const
Definition: rc_item.h:118
virtual wxString GetErrorMessage() const
Definition: rc_item.cpp:38
wxString GetSettingsKey() const
Definition: rc_item.h:154
virtual wxString GetViolatingRuleDesc() const
Definition: rc_item.h:159
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
static wxString showCoord(UNITS_PROVIDER *aUnitsProvider, const VECTOR2I &aPos)
Definition: rc_item.cpp:47
@ RPT_SEVERITY_WARNING
@ RPT_SEVERITY_ERROR
@ RPT_SEVERITY_EXCLUSION
@ RPT_SEVERITY_DEBUG
@ RPT_SEVERITY_INFO
@ RPT_SEVERITY_ACTION

References Format(), GetAuxItemID(), GetErrorMessage(), GetMainItemID(), EDA_ITEM::GetPosition(), EDA_ITEM::GetSelectMenuText(), GetSettingsKey(), GetViolatingRuleDesc(), MARKER_BASE::IsExcluded(), m_parent, RPT_SEVERITY_ACTION, RPT_SEVERITY_DEBUG, RPT_SEVERITY_ERROR, RPT_SEVERITY_EXCLUSION, 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 166 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 167 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

◆ m_parent

MARKER_BASE* RC_ITEM::m_parent
protected

The marker this item belongs to, if any.

Definition at line 169 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 168 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: