ERC_ITEM Class Reference

#include <erc_item.h>

Inheritance diagram for ERC_ITEM:

Public Types
typedef std::vector< KIID >	KIIDS

Public Member Functions
bool	IsSheetSpecific () const
	Determines whether the ERC item is bound to a specific sheet, or is common across multiple sheets (e.g.
void	SetSheetSpecificPath (const SCH_SHEET_PATH &aSpecificSheet)
	Sets the SCH_SHEET_PATH this ERC item is bound to.
const SCH_SHEET_PATH &	GetSpecificSheetPath () const
	Gets the SCH_SHEET_PATH this ERC item is bound to.
void	SetItemsSheetPaths (const SCH_SHEET_PATH &mainItemSheet)
	Sets the SCH_SHEET_PATH of the main item causing this ERC violation to (e.g.
void	SetItemsSheetPaths (const SCH_SHEET_PATH &mainItemSheet, const SCH_SHEET_PATH &auxItemSheet)
	Set the SCH_SHEET PATHs of the main and auxiliary items causing this ERC violation to (e.g.
SCH_SHEET_PATH &	GetMainItemSheetPath ()
	Gets the SCH_SHEET_PATH of the main item causing this ERC violation.
SCH_SHEET_PATH &	GetAuxItemSheetPath ()
	Gets the SCH_SHEET_PATH of the auxiliary item causing this ERC violation.
bool	MainItemHasSheetPath ()
	Determines whether the main item causing this ERC violation has a specific SCH_SHEET_PATH binding.
bool	AuxItemHasSheetPath ()
	Determines whether the auxiliary item causing this ERC violation has a specific SCH_SHEET_PATH binding.
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.
virtual void	GetJsonViolation (RC_JSON::VIOLATION &aViolation, UNITS_PROVIDER *aUnitsProvider, SEVERITY aSeverity, const std::map< KIID, EDA_ITEM * > &aItemMap) const
	Translate this object into an RC_JSON::VIOLATION object.
int	GetErrorCode () const
void	SetErrorCode (int aCode)
virtual wxString	GetErrorMessage () const
wxString	GetErrorText () const
wxString	GetSettingsKey () const
virtual wxString	GetViolatingRuleDesc () const

Static Public Member Functions
static std::shared_ptr< ERC_ITEM >	Create (int aErrorCode)
	Constructs an ERC_ITEM for the given error code.
static std::shared_ptr< ERC_ITEM >	Create (const wxString &aErrorKey)
static std::vector< std::reference_wrapper< RC_ITEM > >	GetItemsWithSeverities ()

Static Protected Member Functions
static wxString	getSeverityString (SEVERITY aSeverity)

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

Private Member Functions
	ERC_ITEM (int aErrorCode=0, const wxString &aTitle="", const wxString &aSettingsKey="")

Private Attributes
std::optional< SCH_SHEET_PATH >	m_mainItemSheet
std::optional< SCH_SHEET_PATH >	m_auxItemSheet
std::optional< SCH_SHEET_PATH >	m_sheetSpecificPath
	True if this item is specific to a sheet instance (as opposed to applying to all instances)

Static Private Attributes
static std::vector< std::reference_wrapper< RC_ITEM > >	allItemTypes
	A list of all ERC_ITEM types which are valid error codes.
static ERC_ITEM	heading_connections
static ERC_ITEM	heading_conflicts
static ERC_ITEM	heading_misc
static ERC_ITEM	heading_internal
static ERC_ITEM	duplicateSheetName
static ERC_ITEM	endpointOffGrid
static ERC_ITEM	pinNotConnected
static ERC_ITEM	pinNotDriven
static ERC_ITEM	powerpinNotDriven
static ERC_ITEM	duplicatePinError
static ERC_ITEM	pinTableWarning
static ERC_ITEM	pinTableError
static ERC_ITEM	genericWarning
static ERC_ITEM	genericError
static ERC_ITEM	hierLabelMismatch
static ERC_ITEM	noConnectConnected
static ERC_ITEM	fourWayJunction
static ERC_ITEM	labelMultipleWires
static ERC_ITEM	noConnectDangling
static ERC_ITEM	labelDangling
static ERC_ITEM	globalLabelDangling
static ERC_ITEM	singleGlobalLabel
static ERC_ITEM	sameLocalGlobalLabel
static ERC_ITEM	similarLabels
static ERC_ITEM	similarPower
static ERC_ITEM	similarLabelAndPower
static ERC_ITEM	differentUnitFootprint
static ERC_ITEM	differentUnitNet
static ERC_ITEM	busDefinitionConflict
static ERC_ITEM	multipleNetNames
static ERC_ITEM	netNotBusMember
static ERC_ITEM	busToBusConflict
static ERC_ITEM	busToNetConflict
static ERC_ITEM	unresolvedVariable
static ERC_ITEM	undefinedNetclass
static ERC_ITEM	simulationModelIssues
static ERC_ITEM	wireDangling
static ERC_ITEM	libSymbolIssues
static ERC_ITEM	libSymbolMismatch
static ERC_ITEM	footprintLinkIssues
static ERC_ITEM	footprintFilters
static ERC_ITEM	unannotated
static ERC_ITEM	extraUnits
static ERC_ITEM	missingUnits
static ERC_ITEM	missingInputPin
static ERC_ITEM	missingBidiPin
static ERC_ITEM	missingPowerInputPin
static ERC_ITEM	differentUnitValue
static ERC_ITEM	duplicateReference
static ERC_ITEM	busEntryNeeded
static ERC_ITEM	unconnectedWireEndpoint

Detailed Description

Definition at line 56 of file erc_item.h.

Member Typedef Documentation

KIIDS

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

inherited

Definition at line 81 of file rc_item.h.

Constructor & Destructor Documentation

ERC_ITEM()

ERC_ITEM::ERC_ITEM ( int  aErrorCode = 0, const wxString &  aTitle = "", const wxString &  aSettingsKey = ""  )

inlineprivate

Definition at line 182 of file erc_item.h.

References RC_ITEM::m_errorCode, RC_ITEM::m_errorTitle, and RC_ITEM::m_settingsKey.

Member Function Documentation

AddItem()

void RC_ITEM::AddItem ( EDA_ITEM *  aItem )

inherited

Definition at line 56 of file rc_item.cpp.

References RC_ITEM::m_ids, and EDA_ITEM::m_Uuid.

AuxItemHasSheetPath()

bool ERC_ITEM::AuxItemHasSheetPath ( )

inline

Determines whether the auxiliary item causing this ERC violation has a specific SCH_SHEET_PATH binding.

Returns

true if the item ERC violation is specific to a sheet, false otherwise

Definition at line 179 of file erc_item.h.

References m_auxItemSheet.

Referenced by GetAuxItemSheetPath().

Create() [1/2]

static std::shared_ptr< ERC_ITEM > ERC_ITEM::Create ( const wxString &  aErrorKey )

inlinestatic

Definition at line 65 of file erc_item.h.

References allItemTypes.

Create() [2/2]

std::shared_ptr< ERC_ITEM > ERC_ITEM::Create ( int  aErrorCode )

static

Constructs an ERC_ITEM for the given error code.

See also

ERCE_T

Definition at line 299 of file erc_item.cpp.

References busDefinitionConflict, busEntryNeeded, busToBusConflict, busToNetConflict, differentUnitFootprint, differentUnitNet, differentUnitValue, duplicatePinError, duplicateReference, duplicateSheetName, endpointOffGrid, ERCE_BUS_ALIAS_CONFLICT, ERCE_BUS_ENTRY_CONFLICT, ERCE_BUS_ENTRY_NEEDED, ERCE_BUS_TO_BUS_CONFLICT, ERCE_BUS_TO_NET_CONFLICT, ERCE_DIFFERENT_UNIT_FP, ERCE_DIFFERENT_UNIT_NET, ERCE_DIFFERENT_UNIT_VALUE, ERCE_DRIVER_CONFLICT, ERCE_DUPLICATE_PIN_ERROR, ERCE_DUPLICATE_REFERENCE, ERCE_DUPLICATE_SHEET_NAME, ERCE_ENDPOINT_OFF_GRID, ERCE_EXTRA_UNITS, ERCE_FOOTPRINT_FILTERS, ERCE_FOOTPRINT_LINK_ISSUES, ERCE_FOUR_WAY_JUNCTION, ERCE_GENERIC_ERROR, ERCE_GENERIC_WARNING, ERCE_GLOBLABEL_DANGLING, ERCE_HIERACHICAL_LABEL, ERCE_LABEL_MULTIPLE_WIRES, ERCE_LABEL_NOT_CONNECTED, ERCE_LIB_SYMBOL_ISSUES, ERCE_LIB_SYMBOL_MISMATCH, ERCE_MISSING_BIDI_PIN, ERCE_MISSING_INPUT_PIN, ERCE_MISSING_POWER_INPUT_PIN, ERCE_MISSING_UNIT, ERCE_NOCONNECT_CONNECTED, ERCE_NOCONNECT_NOT_CONNECTED, ERCE_PIN_NOT_CONNECTED, ERCE_PIN_NOT_DRIVEN, ERCE_PIN_TO_PIN_ERROR, ERCE_PIN_TO_PIN_WARNING, ERCE_POWERPIN_NOT_DRIVEN, ERCE_SAME_LOCAL_GLOBAL_LABEL, ERCE_SIMILAR_LABEL_AND_POWER, ERCE_SIMILAR_LABELS, ERCE_SIMILAR_POWER, ERCE_SIMULATION_MODEL, ERCE_SINGLE_GLOBAL_LABEL, ERCE_UNANNOTATED, ERCE_UNCONNECTED_WIRE_ENDPOINT, ERCE_UNDEFINED_NETCLASS, ERCE_UNRESOLVED_VARIABLE, ERCE_UNSPECIFIED, ERCE_WIRE_DANGLING, extraUnits, footprintFilters, footprintLinkIssues, fourWayJunction, genericError, genericWarning, globalLabelDangling, hierLabelMismatch, labelDangling, labelMultipleWires, libSymbolIssues, libSymbolMismatch, missingBidiPin, missingInputPin, missingPowerInputPin, missingUnits, multipleNetNames, netNotBusMember, noConnectConnected, noConnectDangling, pinNotConnected, pinNotDriven, pinTableError, pinTableWarning, powerpinNotDriven, sameLocalGlobalLabel, similarLabelAndPower, similarLabels, similarPower, simulationModelIssues, singleGlobalLabel, unannotated, unconnectedWireEndpoint, undefinedNetclass, unresolvedVariable, and wireDangling.

Referenced by SCH_IO_EAGLE::addBusEntries(), SCH_MARKER::DeserializeFromString(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), CONNECTION_GRAPH::ercCheckBusToBusConflicts(), CONNECTION_GRAPH::ercCheckBusToBusEntryConflicts(), CONNECTION_GRAPH::ercCheckBusToNetConflicts(), CONNECTION_GRAPH::ercCheckDanglingWireEndpoints(), CONNECTION_GRAPH::ercCheckDirectiveLabels(), CONNECTION_GRAPH::ercCheckFloatingWires(), CONNECTION_GRAPH::ercCheckHierSheets(), CONNECTION_GRAPH::ercCheckLabels(), CONNECTION_GRAPH::ercCheckMultipleDrivers(), CONNECTION_GRAPH::ercCheckNoConnects(), CONNECTION_GRAPH::ercCheckSingleGlobalLabel(), DIALOG_ERC::OnRunERCClick(), ERC_TESTER::TestConflictingBusAliases(), ERC_TESTER::TestDuplicateSheetNames(), ERC_TESTER::TestFootprintFilters(), ERC_TESTER::TestFootprintLinkIssues(), ERC_TESTER::TestFourWayJunction(), ERC_TESTER::TestLabelMultipleWires(), ERC_TESTER::TestLibSymbolIssues(), ERC_TESTER::TestMissingNetclasses(), ERC_TESTER::TestMissingUnits(), ERC_TESTER::TestMultiunitFootprints(), ERC_TESTER::TestMultUnitPinConflicts(), ERC_TESTER::TestNoConnectPins(), ERC_TESTER::TestOffGridEndpoints(), ERC_TESTER::TestPinToPin(), ERC_TESTER::TestSameLocalGlobalLabel(), ERC_TESTER::TestSimilarLabels(), ERC_TESTER::TestSimModelIssues(), and ERC_TESTER::TestTextVars().

GetAuxItem2ID()

virtual KIID RC_ITEM::GetAuxItem2ID ( ) const

inlinevirtualinherited

Reimplemented in DRC_ITEM.

Definition at line 123 of file rc_item.h.

References RC_ITEM::m_ids, and niluuid.

GetAuxItem3ID()

virtual KIID RC_ITEM::GetAuxItem3ID ( ) const

inlinevirtualinherited

Reimplemented in DRC_ITEM.

Definition at line 124 of file rc_item.h.

References RC_ITEM::m_ids, and niluuid.

GetAuxItemID()

virtual KIID RC_ITEM::GetAuxItemID ( ) const

inlinevirtualinherited

Definition at line 122 of file rc_item.h.

References RC_ITEM::m_ids, and niluuid.

Referenced by RC_ITEM::GetJsonViolation(), and RC_ITEM::ShowReport().

GetAuxItemSheetPath()

SCH_SHEET_PATH & ERC_ITEM::GetAuxItemSheetPath ( )

inline

Gets the SCH_SHEET_PATH of the auxiliary item causing this ERC violation.

Returns

SCH_SHEET_PATH containing the auxiliary item

Definition at line 161 of file erc_item.h.

References AuxItemHasSheetPath(), and m_auxItemSheet.

GetErrorCode()

int RC_ITEM::GetErrorCode ( ) const

inlineinherited

Definition at line 153 of file rc_item.h.

References RC_ITEM::m_errorCode.

Referenced by SCH_MARKER::GetSeverity(), PCB_MARKER::GetSeverity(), ERC_REPORT::GetTextReport(), PANEL_SETUP_SEVERITIES::ImportSettingsFrom(), PANEL_SETUP_SEVERITIES::PANEL_SETUP_SEVERITIES(), PANEL_SETUP_SEVERITIES::TransferDataFromWindow(), PANEL_SETUP_SEVERITIES::TransferDataToWindow(), and ERC_REPORT::WriteJsonReport().

GetErrorMessage()

wxString RC_ITEM::GetErrorMessage ( ) const

virtualinherited

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 39 of file rc_item.cpp.

References RC_ITEM::GetErrorText(), and RC_ITEM::m_errorMessage.

Referenced by RC_ITEM::GetJsonViolation(), and RC_ITEM::ShowReport().

GetErrorText()

wxString RC_ITEM::GetErrorText ( ) const

inlineinherited

Returns

the error text for the class of error of this RC_ITEM represents. For instance, "Clearance violation".

Definition at line 166 of file rc_item.h.

References RC_ITEM::m_errorTitle.

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

GetIDs()

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

inlineinherited

Definition at line 126 of file rc_item.h.

References RC_ITEM::m_ids.

GetItemsWithSeverities()

static std::vector< std::reference_wrapper< RC_ITEM > > ERC_ITEM::GetItemsWithSeverities ( )

inlinestatic

Definition at line 76 of file erc_item.h.

References allItemTypes, and heading_internal.

Referenced by DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), ERC_SETTINGS::ERC_SETTINGS(), and DIALOG_ERC::OnRunERCClick().

GetJsonViolation()

void RC_ITEM::GetJsonViolation ( RC_JSON::VIOLATION &  aViolation, UNITS_PROVIDER *  aUnitsProvider, SEVERITY  aSeverity, const std::map< KIID, EDA_ITEM * > &  aItemMap  ) const

virtualinherited

Translate this object into an RC_JSON::VIOLATION object.

Parameters

aViolation	is the violation to be populated by info from this item
aUnitsProvider	is the units provider that will be used to output coordinates
aSeverity	is the severity of this item
aItemMap	is a map allowing the lookup of items from KIIDs

Returns

None

Definition at line 166 of file rc_item.cpp.

References KIID::AsString(), RC_JSON::AFFECTED_ITEM::description, RC_JSON::VIOLATION::description, RC_JSON::VIOLATION::excluded, RC_ITEM::GetAuxItemID(), RC_ITEM::GetErrorMessage(), EDA_ITEM::GetItemDescription(), UNITS_PROVIDER::GetIuScale(), RC_ITEM::GetMainItemID(), EDA_ITEM::GetPosition(), RC_ITEM::GetSettingsKey(), RC_ITEM::getSeverityString(), UNITS_PROVIDER::GetUserUnits(), MARKER_BASE::IsExcluded(), RC_JSON::VIOLATION::items, RC_ITEM::m_parent, EDA_ITEM::m_Uuid, RC_JSON::AFFECTED_ITEM::pos, RC_JSON::VIOLATION::severity, EDA_UNIT_UTILS::UI::ToUserUnit(), RC_JSON::VIOLATION::type, RC_JSON::AFFECTED_ITEM::uuid, RC_JSON::COORDINATE::x, VECTOR2< T >::x, RC_JSON::COORDINATE::y, and VECTOR2< T >::y.

GetMainItemID()

virtual KIID RC_ITEM::GetMainItemID ( ) const

inlinevirtualinherited

Definition at line 121 of file rc_item.h.

References RC_ITEM::m_ids, and niluuid.

Referenced by RC_ITEM::GetJsonViolation(), and RC_ITEM::ShowReport().

GetMainItemSheetPath()

SCH_SHEET_PATH & ERC_ITEM::GetMainItemSheetPath ( )

inline

Gets the SCH_SHEET_PATH of the main item causing this ERC violation.

Returns

SCH_SHEET_PATH containing the main item

Definition at line 151 of file erc_item.h.

References m_mainItemSheet, and MainItemHasSheetPath().

GetParent()

MARKER_BASE * RC_ITEM::GetParent ( ) const

inlineinherited

Definition at line 129 of file rc_item.h.

References RC_ITEM::m_parent.

GetSettingsKey()

wxString RC_ITEM::GetSettingsKey ( ) const

inlineinherited

Definition at line 171 of file rc_item.h.

References RC_ITEM::m_settingsKey.

Referenced by RC_ITEM::GetJsonViolation(), and RC_ITEM::ShowReport().

getSeverityString()

wxString RC_ITEM::getSeverityString ( SEVERITY  aSeverity )

staticprotectedinherited

Definition at line 81 of file rc_item.cpp.

References RPT_SEVERITY_ACTION, RPT_SEVERITY_DEBUG, RPT_SEVERITY_ERROR, RPT_SEVERITY_EXCLUSION, RPT_SEVERITY_INFO, and RPT_SEVERITY_WARNING.

Referenced by RC_ITEM::GetJsonViolation(), and RC_ITEM::ShowReport().

GetSpecificSheetPath()

const SCH_SHEET_PATH & ERC_ITEM::GetSpecificSheetPath ( ) const

inline

Gets the SCH_SHEET_PATH this ERC item is bound to.

Throws std::bad_optional_access if there is no specific sheet path binding

Returns

the SCH_SHEET_PATH containing the ERC violation

Definition at line 116 of file erc_item.h.

References m_sheetSpecificPath.

GetViolatingRuleDesc()

virtual wxString RC_ITEM::GetViolatingRuleDesc ( ) const

inlinevirtualinherited

Reimplemented in DRC_ITEM.

Definition at line 176 of file rc_item.h.

Referenced by RC_ITEM::ShowReport().

IsSheetSpecific()

bool ERC_ITEM::IsSheetSpecific ( ) const

inline

Determines whether the ERC item is bound to a specific sheet, or is common across multiple sheets (e.g.

whether the error is internal to a hierarchical sheet, or is due to an enclosing context interacting with the hierarchical sheet)

Returns

true if ERC applies to a specific sheet, otherwise false

Definition at line 100 of file erc_item.h.

References m_sheetSpecificPath.

MainItemHasSheetPath()

bool ERC_ITEM::MainItemHasSheetPath ( )

inline

Determines whether the main item causing this ERC violation has a specific SCH_SHEET_PATH binding.

Returns

true if the item ERC violation is specific to a sheet, false otherwise

Definition at line 172 of file erc_item.h.

References m_mainItemSheet.

Referenced by GetMainItemSheetPath().

SetErrorCode()

void RC_ITEM::SetErrorCode ( int  aCode )

inlineinherited

Definition at line 154 of file rc_item.h.

References RC_ITEM::m_errorCode.

SetErrorMessage()

void RC_ITEM::SetErrorMessage ( const wxString &  aMessage )

inlineinherited

Definition at line 101 of file rc_item.h.

References RC_ITEM::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  )

inherited

Definition at line 62 of file rc_item.cpp.

References RC_ITEM::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  )

inlineinherited

Definition at line 110 of file rc_item.h.

References RC_ITEM::m_ids.

SetItems() [3/3]

void RC_ITEM::SetItems ( const KIIDS &  aIds )

inlineinherited

Definition at line 103 of file rc_item.h.

References RC_ITEM::m_ids.

SetItemsSheetPaths() [1/2]

void ERC_ITEM::SetItemsSheetPaths ( const SCH_SHEET_PATH &  mainItemSheet )

inline

Sets the SCH_SHEET_PATH of the main item causing this ERC violation to (e.g.

a schematic pin). This allows violations to be specific to particular uses of shared hierarchical schematics.

Parameters

mainItemSheet

the SCH_SHEET_PATH of the item causing the ERC violation

Definition at line 128 of file erc_item.h.

References m_mainItemSheet.

SetItemsSheetPaths() [2/2]

void ERC_ITEM::SetItemsSheetPaths ( const SCH_SHEET_PATH &  mainItemSheet, const SCH_SHEET_PATH &  auxItemSheet  )

inline

Set the SCH_SHEET PATHs of the main and auxiliary items causing this ERC violation to (e.g.

two schematic pins which have a mutual connection violation). This allows violations to be specific to particular uses of shared hierarchical schematics.

Parameters

mainItemSheet	the SCH_SHEET_PATH of the first item causing the ERC violation
auxItemSheet	the SCH_SHEET_PATH of the second item causing the ERC violation

Definition at line 140 of file erc_item.h.

References m_auxItemSheet, and m_mainItemSheet.

SetParent()

void RC_ITEM::SetParent ( MARKER_BASE *  aMarker )

inlineinherited

Definition at line 128 of file rc_item.h.

References RC_ITEM::m_parent.

SetSheetSpecificPath()

void ERC_ITEM::SetSheetSpecificPath ( const SCH_SHEET_PATH &  aSpecificSheet )

inline

Sets the SCH_SHEET_PATH this ERC item is bound to.

Parameters

aSpecificSheet

The SCH_SHEET_PATH containing the ERC violation

Definition at line 106 of file erc_item.h.

References m_sheetSpecificPath.

ShowReport()

wxString RC_ITEM::ShowReport ( UNITS_PROVIDER *  aUnitsProvider, SEVERITY  aSeverity, const std::map< KIID, EDA_ITEM * > &  aItemMap  ) const

virtualinherited

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 100 of file rc_item.cpp.

References RC_ITEM::GetAuxItemID(), MARKER_BASE::GetComment(), RC_ITEM::GetErrorMessage(), EDA_ITEM::GetItemDescription(), RC_ITEM::GetMainItemID(), EDA_ITEM::GetPosition(), RC_ITEM::GetSettingsKey(), RC_ITEM::getSeverityString(), RC_ITEM::GetViolatingRuleDesc(), MARKER_BASE::IsExcluded(), RC_ITEM::m_parent, and showCoord().

Member Data Documentation

allItemTypes

std::vector< std::reference_wrapper< RC_ITEM > > ERC_ITEM::allItemTypes

staticprivate

A list of all ERC_ITEM types which are valid error codes.

Definition at line 193 of file erc_item.h.

Referenced by Create(), and GetItemsWithSeverities().

busDefinitionConflict

ERC_ITEM ERC_ITEM::busDefinitionConflict

staticprivate

Definition at line 224 of file erc_item.h.

Referenced by Create().

busEntryNeeded

ERC_ITEM ERC_ITEM::busEntryNeeded

staticprivate

Definition at line 245 of file erc_item.h.

Referenced by Create().

busToBusConflict

ERC_ITEM ERC_ITEM::busToBusConflict

staticprivate

Definition at line 227 of file erc_item.h.

Referenced by Create().

busToNetConflict

ERC_ITEM ERC_ITEM::busToNetConflict

staticprivate

Definition at line 228 of file erc_item.h.

Referenced by Create().

differentUnitFootprint

ERC_ITEM ERC_ITEM::differentUnitFootprint

staticprivate

Definition at line 222 of file erc_item.h.

Referenced by Create().

differentUnitNet

ERC_ITEM ERC_ITEM::differentUnitNet

staticprivate

Definition at line 223 of file erc_item.h.

Referenced by Create().

differentUnitValue

ERC_ITEM ERC_ITEM::differentUnitValue

staticprivate

Definition at line 243 of file erc_item.h.

Referenced by Create().

duplicatePinError

ERC_ITEM ERC_ITEM::duplicatePinError

staticprivate

Definition at line 205 of file erc_item.h.

Referenced by Create().

duplicateReference

ERC_ITEM ERC_ITEM::duplicateReference

staticprivate

Definition at line 244 of file erc_item.h.

Referenced by Create().

duplicateSheetName

ERC_ITEM ERC_ITEM::duplicateSheetName

staticprivate

Definition at line 200 of file erc_item.h.

Referenced by Create().

endpointOffGrid

ERC_ITEM ERC_ITEM::endpointOffGrid

staticprivate

Definition at line 201 of file erc_item.h.

Referenced by Create().

extraUnits

ERC_ITEM ERC_ITEM::extraUnits

staticprivate

Definition at line 238 of file erc_item.h.

Referenced by Create().

footprintFilters

ERC_ITEM ERC_ITEM::footprintFilters

staticprivate

Definition at line 236 of file erc_item.h.

Referenced by Create().

footprintLinkIssues

ERC_ITEM ERC_ITEM::footprintLinkIssues

staticprivate

Definition at line 235 of file erc_item.h.

Referenced by Create().

fourWayJunction

ERC_ITEM ERC_ITEM::fourWayJunction

staticprivate

Definition at line 212 of file erc_item.h.

Referenced by Create().

genericError

ERC_ITEM ERC_ITEM::genericError

staticprivate

Definition at line 209 of file erc_item.h.

Referenced by Create().

genericWarning

ERC_ITEM ERC_ITEM::genericWarning

staticprivate

Definition at line 208 of file erc_item.h.

Referenced by Create().

globalLabelDangling

ERC_ITEM ERC_ITEM::globalLabelDangling

staticprivate

Definition at line 216 of file erc_item.h.

Referenced by Create().

heading_conflicts

ERC_ITEM ERC_ITEM::heading_conflicts

staticprivate

Definition at line 196 of file erc_item.h.

heading_connections

ERC_ITEM ERC_ITEM::heading_connections

staticprivate

Definition at line 195 of file erc_item.h.

heading_internal

ERC_ITEM ERC_ITEM::heading_internal

staticprivate

Definition at line 198 of file erc_item.h.

Referenced by GetItemsWithSeverities().

heading_misc

ERC_ITEM ERC_ITEM::heading_misc

staticprivate

Definition at line 197 of file erc_item.h.

hierLabelMismatch

ERC_ITEM ERC_ITEM::hierLabelMismatch

staticprivate

Definition at line 210 of file erc_item.h.

Referenced by Create().

labelDangling

ERC_ITEM ERC_ITEM::labelDangling

staticprivate

Definition at line 215 of file erc_item.h.

Referenced by Create().

labelMultipleWires

ERC_ITEM ERC_ITEM::labelMultipleWires

staticprivate

Definition at line 213 of file erc_item.h.

Referenced by Create().

libSymbolIssues

ERC_ITEM ERC_ITEM::libSymbolIssues

staticprivate

Definition at line 233 of file erc_item.h.

Referenced by Create().

libSymbolMismatch

ERC_ITEM ERC_ITEM::libSymbolMismatch

staticprivate

Definition at line 234 of file erc_item.h.

Referenced by Create().

m_auxItemSheet

std::optional<SCH_SHEET_PATH> ERC_ITEM::m_auxItemSheet

private

Definition at line 190 of file erc_item.h.

Referenced by AuxItemHasSheetPath(), GetAuxItemSheetPath(), and SetItemsSheetPaths().

m_errorCode

int RC_ITEM::m_errorCode

protectedinherited

The error code's numeric value.

Definition at line 184 of file rc_item.h.

Referenced by CLEANUP_ITEM::CLEANUP_ITEM(), DRC_ITEM::DRC_ITEM(), ERC_ITEM(), DRC_ITEM::GetAuxItem2ID(), DRC_ITEM::GetAuxItem3ID(), RC_ITEM::GetErrorCode(), CLEANUP_ITEM::GetErrorText(), RC_ITEM::RC_ITEM(), and RC_ITEM::SetErrorCode().

m_errorMessage

wxString RC_ITEM::m_errorMessage

protectedinherited

A message describing the details of this specific error.

Definition at line 185 of file rc_item.h.

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

m_errorTitle

wxString RC_ITEM::m_errorTitle

protectedinherited

The string describing the type of error.

Definition at line 186 of file rc_item.h.

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

m_ids

KIIDS RC_ITEM::m_ids

protectedinherited

Definition at line 190 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().

m_mainItemSheet

std::optional<SCH_SHEET_PATH> ERC_ITEM::m_mainItemSheet

private

Definition at line 189 of file erc_item.h.

Referenced by GetMainItemSheetPath(), MainItemHasSheetPath(), and SetItemsSheetPaths().

m_parent

MARKER_BASE* RC_ITEM::m_parent

protectedinherited

The marker this item belongs to, if any.

Definition at line 188 of file rc_item.h.

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

m_settingsKey

wxString RC_ITEM::m_settingsKey

protectedinherited

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

Definition at line 187 of file rc_item.h.

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

m_sheetSpecificPath

std::optional<SCH_SHEET_PATH> ERC_ITEM::m_sheetSpecificPath

private

True if this item is specific to a sheet instance (as opposed to applying to all instances)

Definition at line 249 of file erc_item.h.

Referenced by GetSpecificSheetPath(), IsSheetSpecific(), and SetSheetSpecificPath().

missingBidiPin

ERC_ITEM ERC_ITEM::missingBidiPin

staticprivate

Definition at line 241 of file erc_item.h.

Referenced by Create().

missingInputPin

ERC_ITEM ERC_ITEM::missingInputPin

staticprivate

Definition at line 240 of file erc_item.h.

Referenced by Create().

missingPowerInputPin

ERC_ITEM ERC_ITEM::missingPowerInputPin

staticprivate

Definition at line 242 of file erc_item.h.

Referenced by Create().

missingUnits

ERC_ITEM ERC_ITEM::missingUnits

staticprivate

Definition at line 239 of file erc_item.h.

Referenced by Create().

multipleNetNames

ERC_ITEM ERC_ITEM::multipleNetNames

staticprivate

Definition at line 225 of file erc_item.h.

Referenced by Create().

netNotBusMember

ERC_ITEM ERC_ITEM::netNotBusMember

staticprivate

Definition at line 226 of file erc_item.h.

Referenced by Create().

noConnectConnected

ERC_ITEM ERC_ITEM::noConnectConnected

staticprivate

Definition at line 211 of file erc_item.h.

Referenced by Create().

noConnectDangling

ERC_ITEM ERC_ITEM::noConnectDangling

staticprivate

Definition at line 214 of file erc_item.h.

Referenced by Create().

pinNotConnected

ERC_ITEM ERC_ITEM::pinNotConnected

staticprivate

Definition at line 202 of file erc_item.h.

Referenced by Create().

pinNotDriven

ERC_ITEM ERC_ITEM::pinNotDriven

staticprivate

Definition at line 203 of file erc_item.h.

Referenced by Create().

pinTableError

ERC_ITEM ERC_ITEM::pinTableError

staticprivate

Definition at line 207 of file erc_item.h.

Referenced by Create().

pinTableWarning

ERC_ITEM ERC_ITEM::pinTableWarning

staticprivate

Definition at line 206 of file erc_item.h.

Referenced by Create().

powerpinNotDriven

ERC_ITEM ERC_ITEM::powerpinNotDriven

staticprivate

Definition at line 204 of file erc_item.h.

Referenced by Create().

sameLocalGlobalLabel

ERC_ITEM ERC_ITEM::sameLocalGlobalLabel

staticprivate

Definition at line 218 of file erc_item.h.

Referenced by Create().

similarLabelAndPower

ERC_ITEM ERC_ITEM::similarLabelAndPower

staticprivate

Definition at line 221 of file erc_item.h.

Referenced by Create().

similarLabels

ERC_ITEM ERC_ITEM::similarLabels

staticprivate

Definition at line 219 of file erc_item.h.

Referenced by Create().

similarPower

ERC_ITEM ERC_ITEM::similarPower

staticprivate

Definition at line 220 of file erc_item.h.

Referenced by Create().

simulationModelIssues

ERC_ITEM ERC_ITEM::simulationModelIssues

staticprivate

Definition at line 231 of file erc_item.h.

Referenced by Create().

singleGlobalLabel

ERC_ITEM ERC_ITEM::singleGlobalLabel

staticprivate

Definition at line 217 of file erc_item.h.

Referenced by Create().

unannotated

ERC_ITEM ERC_ITEM::unannotated

staticprivate

Definition at line 237 of file erc_item.h.

Referenced by Create().

unconnectedWireEndpoint

ERC_ITEM ERC_ITEM::unconnectedWireEndpoint

staticprivate

Definition at line 246 of file erc_item.h.

Referenced by Create().

undefinedNetclass

ERC_ITEM ERC_ITEM::undefinedNetclass

staticprivate

Definition at line 230 of file erc_item.h.

Referenced by Create().

unresolvedVariable

ERC_ITEM ERC_ITEM::unresolvedVariable

staticprivate

Definition at line 229 of file erc_item.h.

Referenced by Create().

wireDangling

ERC_ITEM ERC_ITEM::wireDangling

staticprivate

Definition at line 232 of file erc_item.h.

Referenced by Create().

---

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

• erc_item.h
• erc_item.cpp