KiCad PCB EDA Suite
|
#include <cleanup_item.h>
Public Types | |
typedef std::vector< KIID > | KIIDS |
Public Member Functions | |
CLEANUP_ITEM (int aErrorCode) | |
wxString | GetErrorText (int aErrorCode=-1, bool aTranslate=true) const |
Return the string form of a drc error code. More... | |
void | SetErrorMessage (const wxString &aMessage) |
void | SetItems (const KIIDS &aIds) |
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) |
void | AddItem (EDA_ITEM *aItem) |
virtual KIID | GetMainItemID () const |
virtual KIID | GetAuxItemID () const |
virtual KIID | GetAuxItem2ID () const |
virtual KIID | GetAuxItem3ID () const |
std::vector< KIID > | GetIDs () const |
void | SetParent (MARKER_BASE *aMarker) |
MARKER_BASE * | GetParent () 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_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_BASE * | m_parent |
The marker this item belongs to, if any. More... | |
KIIDS | m_ids |
Private Attributes | |
wxString | m_errorMessage |
Definition at line 49 of file cleanup_item.h.
|
inherited |
CLEANUP_ITEM::CLEANUP_ITEM | ( | int | aErrorCode | ) |
Definition at line 29 of file cleanup_item.cpp.
References RC_ITEM::GetErrorText(), RC_ITEM::m_errorCode, and RC_ITEM::m_errorTitle.
|
inherited |
|
inlinevirtualinherited |
|
inlinevirtualinherited |
|
inlinevirtualinherited |
Definition at line 118 of file rc_item.h.
References RC_ITEM::m_ids, and niluuid.
Referenced by RC_ITEM::ShowReport().
|
inlineinherited |
Definition at line 136 of file rc_item.h.
References RC_ITEM::m_errorCode.
Referenced by SCH_MARKER::GetSeverity(), PCB_MARKER::GetSeverity(), PANEL_SETUP_SEVERITIES::ImportSettingsFrom(), PANEL_SETUP_SEVERITIES::PANEL_SETUP_SEVERITIES(), PANEL_SETUP_SEVERITIES::TransferDataFromWindow(), PANEL_SETUP_SEVERITIES::TransferDataToWindow(), and DIALOG_ERC::writeReport().
|
virtualinherited |
Definition at line 38 of file rc_item.cpp.
References RC_ITEM::GetErrorText(), and RC_ITEM::m_errorMessage.
Referenced by RC_ITEM::ShowReport().
|
inlineinherited |
Definition at line 149 of file rc_item.h.
References RC_ITEM::m_errorTitle.
Referenced by CLEANUP_ITEM(), RC_ITEM::GetErrorMessage(), and PANEL_SETUP_SEVERITIES::PANEL_SETUP_SEVERITIES().
wxString CLEANUP_ITEM::GetErrorText | ( | int | aErrorCode = -1 , |
bool | aTranslate = true |
||
) | const |
Return the string form of a drc error code.
Definition at line 36 of file cleanup_item.cpp.
References _HKI, CLEANUP_DANGLING_TRACK, CLEANUP_DANGLING_VIA, CLEANUP_DUPLICATE_GRAPHIC, CLEANUP_DUPLICATE_TRACK, CLEANUP_LINES_TO_RECT, CLEANUP_MERGE_PAD, CLEANUP_MERGE_TRACKS, CLEANUP_NULL_GRAPHIC, CLEANUP_REDUNDANT_VIA, CLEANUP_SHORTING_TRACK, CLEANUP_SHORTING_VIA, CLEANUP_TRACK_IN_PAD, CLEANUP_ZERO_LENGTH_TRACK, and RC_ITEM::m_errorCode.
|
inlineinherited |
|
inlinevirtualinherited |
Definition at line 117 of file rc_item.h.
References RC_ITEM::m_ids, and niluuid.
Referenced by RC_ITEM::ShowReport().
|
inlineinherited |
Definition at line 125 of file rc_item.h.
References RC_ITEM::m_parent.
|
inlineinherited |
Definition at line 154 of file rc_item.h.
References RC_ITEM::m_settingsKey.
Referenced by RC_ITEM::ShowReport().
|
inlinevirtualinherited |
Reimplemented in DRC_ITEM.
Definition at line 159 of file rc_item.h.
Referenced by RC_ITEM::ShowReport().
|
inlineinherited |
Definition at line 137 of file rc_item.h.
References RC_ITEM::m_errorCode.
|
inlineinherited |
Definition at line 97 of file rc_item.h.
References RC_ITEM::m_errorMessage.
|
inherited |
Definition at line 61 of file rc_item.cpp.
References RC_ITEM::m_ids, and EDA_ITEM::m_Uuid.
|
inlineinherited |
|
inlineinherited |
|
virtualinherited |
Translate this object into a text string suitable for saving to disk in a report.
Definition at line 79 of file rc_item.cpp.
References Format(), RC_ITEM::GetAuxItemID(), RC_ITEM::GetErrorMessage(), EDA_ITEM::GetItemDescription(), RC_ITEM::GetMainItemID(), EDA_ITEM::GetPosition(), RC_ITEM::GetSettingsKey(), RC_ITEM::GetViolatingRuleDesc(), MARKER_BASE::IsExcluded(), RC_ITEM::m_parent, RPT_SEVERITY_ACTION, RPT_SEVERITY_DEBUG, RPT_SEVERITY_ERROR, RPT_SEVERITY_EXCLUSION, RPT_SEVERITY_INFO, RPT_SEVERITY_WARNING, and showCoord().
|
protectedinherited |
The error code's numeric value.
Definition at line 165 of file rc_item.h.
Referenced by CLEANUP_ITEM(), DRC_ITEM::DRC_ITEM(), ERC_ITEM::ERC_ITEM(), DRC_ITEM::GetAuxItem2ID(), DRC_ITEM::GetAuxItem3ID(), RC_ITEM::GetErrorCode(), GetErrorText(), RC_ITEM::RC_ITEM(), and RC_ITEM::SetErrorCode().
|
private |
Definition at line 60 of file cleanup_item.h.
|
protectedinherited |
The string describing the type of error.
Definition at line 167 of file rc_item.h.
Referenced by CLEANUP_ITEM(), DRC_ITEM::DRC_ITEM(), ERC_ITEM::ERC_ITEM(), RC_ITEM::GetErrorText(), and RC_ITEM::RC_ITEM().
|
protectedinherited |
Definition at line 171 of file rc_item.h.
Referenced by RC_ITEM::AddItem(), RC_ITEM::GetAuxItem2ID(), DRC_ITEM::GetAuxItem2ID(), RC_ITEM::GetAuxItem3ID(), DRC_ITEM::GetAuxItem3ID(), RC_ITEM::GetAuxItemID(), RC_ITEM::GetIDs(), RC_ITEM::GetMainItemID(), RC_ITEM::RC_ITEM(), and RC_ITEM::SetItems().
|
protectedinherited |
The marker this item belongs to, if any.
Definition at line 169 of file rc_item.h.
Referenced by DRC_ITEM::DRC_ITEM(), RC_ITEM::GetParent(), RC_ITEM::RC_ITEM(), RC_ITEM::SetParent(), and RC_ITEM::ShowReport().
|
protectedinherited |
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(), RC_ITEM::GetSettingsKey(), and RC_ITEM::RC_ITEM().