DRC_ITEM Class Reference

#include <drc_item.h>

Inheritance diagram for DRC_ITEM:

Public Types
typedef std::vector< KIID >	KIIDS

Public Member Functions
void	SetViolatingRule (DRC_RULE *aRule)
DRC_RULE *	GetViolatingRule () const
wxString	GetViolatingRuleDesc () const override
void	SetViolatingTest (DRC_TEST_PROVIDER *aProvider)
DRC_TEST_PROVIDER *	GetViolatingTest () const
KIID	GetAuxItem2ID () const override
KIID	GetAuxItem3ID () const override
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
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

Static Public Member Functions
static std::shared_ptr< DRC_ITEM >	Create (int aErrorCode)
	Constructs a DRC_ITEM for the given error code.
static std::shared_ptr< DRC_ITEM >	Create (const wxString &aErrorKey)
	Constructs a DRC item from a given error settings key.
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
	DRC_ITEM (int aErrorCode=0, const wxString &aTitle="", const wxString &aSettingsKey="")

Private Attributes
DRC_RULE *	m_violatingRule = nullptr
DRC_TEST_PROVIDER *	m_violatingTest = nullptr

Static Private Attributes
static std::vector< std::reference_wrapper< RC_ITEM > >	allItemTypes
	A list of all DRC_ITEM types which are valid error codes.
static DRC_ITEM	heading_electrical
static DRC_ITEM	heading_DFM
static DRC_ITEM	heading_schematic_parity
static DRC_ITEM	heading_signal_integrity
static DRC_ITEM	heading_readability
static DRC_ITEM	heading_misc
static DRC_ITEM	heading_internal
static DRC_ITEM	unconnectedItems
static DRC_ITEM	shortingItems
static DRC_ITEM	itemsNotAllowed
static DRC_ITEM	textOnEdgeCuts
static DRC_ITEM	clearance
static DRC_ITEM	creepage
static DRC_ITEM	tracksCrossing
static DRC_ITEM	edgeClearance
static DRC_ITEM	zonesIntersect
static DRC_ITEM	isolatedCopper
static DRC_ITEM	starvedThermal
static DRC_ITEM	viaDangling
static DRC_ITEM	trackDangling
static DRC_ITEM	holeNearHole
static DRC_ITEM	holesCoLocated
static DRC_ITEM	holeClearance
static DRC_ITEM	connectionWidth
static DRC_ITEM	trackWidth
static DRC_ITEM	trackAngle
static DRC_ITEM	trackSegmentLength
static DRC_ITEM	annularWidth
static DRC_ITEM	drillTooSmall
static DRC_ITEM	viaDiameter
static DRC_ITEM	padstack
static DRC_ITEM	padstackInvalid
static DRC_ITEM	microviaDrillTooSmall
static DRC_ITEM	courtyardsOverlap
static DRC_ITEM	missingCourtyard
static DRC_ITEM	malformedCourtyard
static DRC_ITEM	pthInsideCourtyard
static DRC_ITEM	npthInsideCourtyard
static DRC_ITEM	itemOnDisabledLayer
static DRC_ITEM	invalidOutline
static DRC_ITEM	duplicateFootprints
static DRC_ITEM	missingFootprint
static DRC_ITEM	extraFootprint
static DRC_ITEM	netConflict
static DRC_ITEM	schematicParity
static DRC_ITEM	footprintFilters
static DRC_ITEM	libFootprintIssues
static DRC_ITEM	libFootprintMismatch
static DRC_ITEM	unresolvedVariable
static DRC_ITEM	assertionFailure
static DRC_ITEM	genericWarning
static DRC_ITEM	genericError
static DRC_ITEM	copperSliver
static DRC_ITEM	silkClearance
static DRC_ITEM	silkEdgeClearance
static DRC_ITEM	solderMaskBridge
static DRC_ITEM	silkOverlaps
static DRC_ITEM	textHeightOutOfRange
static DRC_ITEM	textThicknessOutOfRange
static DRC_ITEM	lengthOutOfRange
static DRC_ITEM	skewOutOfRange
static DRC_ITEM	viaCountOutOfRange
static DRC_ITEM	diffPairGapOutOfRange
static DRC_ITEM	diffPairUncoupledLengthTooLong
static DRC_ITEM	footprint
static DRC_ITEM	footprintTypeMismatch
static DRC_ITEM	footprintTHPadhasNoHole
static DRC_ITEM	mirroredTextOnFrontLayer
static DRC_ITEM	nonMirroredTextOnBackLayer

Detailed Description

Definition at line 116 of file drc_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

DRC_ITEM()

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

inlineprivate

Definition at line 163 of file drc_item.h.

References RC_ITEM::m_errorCode, RC_ITEM::m_errorTitle, RC_ITEM::m_parent, 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.

Create() [1/2]

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

static

Constructs a DRC item from a given error settings key.

Parameters

aErrorKey

is a settings key for an error code (the untranslated string that is used to represent a given error code in settings files and for storing ignored DRC items)

Returns

the created item

Definition at line 455 of file drc_item.cpp.

References allItemTypes.

Create() [2/2]

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

static

Constructs a DRC_ITEM for the given error code.

See also

DRCE_T

Definition at line 382 of file drc_item.cpp.

References annularWidth, assertionFailure, clearance, connectionWidth, copperSliver, courtyardsOverlap, creepage, diffPairGapOutOfRange, diffPairUncoupledLengthTooLong, DRCE_ALLOWED_ITEMS, DRCE_ANNULAR_WIDTH, DRCE_ASSERTION_FAILURE, DRCE_CLEARANCE, DRCE_CONNECTION_WIDTH, DRCE_COPPER_SLIVER, DRCE_CREEPAGE, DRCE_DANGLING_TRACK, DRCE_DANGLING_VIA, DRCE_DIFF_PAIR_GAP_OUT_OF_RANGE, DRCE_DIFF_PAIR_UNCOUPLED_LENGTH_TOO_LONG, DRCE_DISABLED_LAYER_ITEM, DRCE_DRILL_OUT_OF_RANGE, DRCE_DRILLED_HOLES_COLOCATED, DRCE_DRILLED_HOLES_TOO_CLOSE, DRCE_DUPLICATE_FOOTPRINT, DRCE_EDGE_CLEARANCE, DRCE_EXTRA_FOOTPRINT, DRCE_FOOTPRINT, DRCE_FOOTPRINT_FILTERS, DRCE_FOOTPRINT_TYPE_MISMATCH, DRCE_GENERIC_ERROR, DRCE_GENERIC_WARNING, DRCE_HOLE_CLEARANCE, DRCE_INVALID_OUTLINE, DRCE_ISOLATED_COPPER, DRCE_LENGTH_OUT_OF_RANGE, DRCE_LIB_FOOTPRINT_ISSUES, DRCE_LIB_FOOTPRINT_MISMATCH, DRCE_MALFORMED_COURTYARD, DRCE_MICROVIA_DRILL_OUT_OF_RANGE, DRCE_MIRRORED_TEXT_ON_FRONT_LAYER, DRCE_MISSING_COURTYARD, DRCE_MISSING_FOOTPRINT, DRCE_NET_CONFLICT, DRCE_NONMIRRORED_TEXT_ON_BACK_LAYER, DRCE_NPTH_IN_COURTYARD, DRCE_OVERLAPPING_FOOTPRINTS, DRCE_OVERLAPPING_SILK, DRCE_PAD_TH_WITH_NO_HOLE, DRCE_PADSTACK, DRCE_PADSTACK_INVALID, DRCE_PTH_IN_COURTYARD, DRCE_SCHEMATIC_PARITY, DRCE_SHORTING_ITEMS, DRCE_SILK_CLEARANCE, DRCE_SILK_EDGE_CLEARANCE, DRCE_SKEW_OUT_OF_RANGE, DRCE_SOLDERMASK_BRIDGE, DRCE_STARVED_THERMAL, DRCE_TEXT_HEIGHT, DRCE_TEXT_ON_EDGECUTS, DRCE_TEXT_THICKNESS, DRCE_TRACK_ANGLE, DRCE_TRACK_SEGMENT_LENGTH, DRCE_TRACK_WIDTH, DRCE_TRACKS_CROSSING, DRCE_UNCONNECTED_ITEMS, DRCE_UNRESOLVED_VARIABLE, DRCE_VIA_COUNT_OUT_OF_RANGE, DRCE_VIA_DIAMETER, DRCE_ZONES_INTERSECT, drillTooSmall, duplicateFootprints, edgeClearance, extraFootprint, footprint, footprintFilters, footprintTHPadhasNoHole, footprintTypeMismatch, genericError, genericWarning, holeClearance, holeNearHole, holesCoLocated, invalidOutline, isolatedCopper, itemOnDisabledLayer, itemsNotAllowed, lengthOutOfRange, libFootprintIssues, libFootprintMismatch, malformedCourtyard, microviaDrillTooSmall, mirroredTextOnFrontLayer, missingCourtyard, missingFootprint, netConflict, nonMirroredTextOnBackLayer, npthInsideCourtyard, padstack, padstackInvalid, pthInsideCourtyard, schematicParity, shortingItems, silkClearance, silkEdgeClearance, silkOverlaps, skewOutOfRange, solderMaskBridge, starvedThermal, textHeightOutOfRange, textOnEdgeCuts, textThicknessOutOfRange, trackAngle, trackDangling, tracksCrossing, trackSegmentLength, trackWidth, unconnectedItems, unresolvedVariable, viaCountOutOfRange, viaDangling, viaDiameter, and zonesIntersect.

Referenced by DRC_TEST_PROVIDER_MATCHED_LENGTH::checkLengths(), DRC_TEST_PROVIDER_HOLE_SIZE::checkPadHole(), DRC_TEST_PROVIDER_MATCHED_LENGTH::checkSkews(), DRC_TEST_PROVIDER_MATCHED_LENGTH::checkViaCounts(), DRC_TEST_PROVIDER_HOLE_SIZE::checkViaHole(), PCB_MARKER::DeserializeFromString(), BOARD_DESIGN_SETTINGS::LoadFromFile(), DRC_TEST_PROVIDER_ANNULAR_WIDTH::Run(), DRC_TEST_PROVIDER_CONNECTION_WIDTH::Run(), DRC_TEST_PROVIDER_CONNECTIVITY::Run(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_DISALLOW::Run(), DRC_TEST_PROVIDER_FOOTPRINT_CHECKS::Run(), DRC_TEST_PROVIDER_LIBRARY_PARITY::Run(), DRC_TEST_PROVIDER_SLIVER_CHECKER::Run(), DRC_TEST_PROVIDER_TEXT_DIMS::Run(), DRC_TEST_PROVIDER_TEXT_MIRRORING::Run(), DRC_TEST_PROVIDER_TRACK_ANGLE::Run(), DRC_TEST_PROVIDER_TRACK_SEGMENT_LENGTH::Run(), DRC_TEST_PROVIDER_TRACK_WIDTH::Run(), DRC_TEST_PROVIDER_VIA_DIAMETER::Run(), DIALOG_FOOTPRINT_CHECKER::runChecks(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::testAgainstEdge(), DRC_TEST_PROVIDER_MISC::testAssertions(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testCourtyardClearances(), DRC_TEST_PROVIDER_CREEPAGE::testCreepage(), DRC_TEST_PROVIDER_MISC::testDisabledLayers(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE::testFootprintCourtyardDefinitions(), DRC_TEST_PROVIDER_HOLE_TO_HOLE::testHoleAgainstHole(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstItem(), DRC_TEST_PROVIDER_SOLDER_MASK::testItemAgainstItems(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstZones(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testKnockoutTextAgainstZone(), DRC_TEST_PROVIDER_SOLDER_MASK::testMaskItemAgainstZones(), DRC_TEST_PROVIDER_SCHEMATIC_PARITY::testNetlist(), DRC_TEST_PROVIDER_MISC::testOutline(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testShapeLineChain(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testSingleLayerItemAgainstItem(), DRC_TEST_PROVIDER_MISC::testTextVars(), DRC_TEST_PROVIDER_ZONE_CONNECTIONS::testZoneLayer(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testZoneLayer(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testZonesToZones().

GetAuxItem2ID()

KIID DRC_ITEM::GetAuxItem2ID ( ) const

overridevirtual

Reimplemented from RC_ITEM.

Definition at line 468 of file drc_item.cpp.

References DRCE_DIFF_PAIR_UNCOUPLED_LENGTH_TOO_LONG, RC_ITEM::m_errorCode, RC_ITEM::m_ids, and niluuid.

GetAuxItem3ID()

KIID DRC_ITEM::GetAuxItem3ID ( ) const

overridevirtual

Reimplemented from RC_ITEM.

Definition at line 480 of file drc_item.cpp.

References DRCE_DIFF_PAIR_UNCOUPLED_LENGTH_TOO_LONG, RC_ITEM::m_errorCode, 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().

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 > > DRC_ITEM::GetItemsWithSeverities ( )

inlinestatic

Definition at line 133 of file drc_item.h.

References allItemTypes, and heading_internal.

Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), and DIALOG_DRC::OnRunDRCClick().

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().

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().

GetViolatingRule()

DRC_RULE * DRC_ITEM::GetViolatingRule ( ) const

inline

Definition at line 152 of file drc_item.h.

References m_violatingRule.

Referenced by PCB_MARKER::GetSeverity(), and DIALOG_DRC::OnDRCItemRClick().

GetViolatingRuleDesc()

wxString DRC_ITEM::GetViolatingRuleDesc ( ) const

overridevirtual

Reimplemented from RC_ITEM.

Definition at line 492 of file drc_item.cpp.

References _, DRC_RULE::m_Name, and m_violatingRule.

GetViolatingTest()

DRC_TEST_PROVIDER * DRC_ITEM::GetViolatingTest ( ) const

inline

Definition at line 157 of file drc_item.h.

References m_violatingTest.

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.

SetParent()

void RC_ITEM::SetParent ( MARKER_BASE *  aMarker )

inlineinherited

Definition at line 128 of file rc_item.h.

References RC_ITEM::m_parent.

SetViolatingRule()

void DRC_ITEM::SetViolatingRule ( DRC_RULE *  aRule )

inline

Definition at line 151 of file drc_item.h.

References m_violatingRule.

SetViolatingTest()

void DRC_ITEM::SetViolatingTest ( DRC_TEST_PROVIDER *  aProvider )

inline

Definition at line 156 of file drc_item.h.

References m_violatingTest.

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 > > DRC_ITEM::allItemTypes

staticprivate

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

Definition at line 172 of file drc_item.h.

Referenced by Create(), and GetItemsWithSeverities().

annularWidth

DRC_ITEM DRC_ITEM::annularWidth

staticprivate

Definition at line 202 of file drc_item.h.

Referenced by Create().

assertionFailure

DRC_ITEM DRC_ITEM::assertionFailure

staticprivate

Definition at line 224 of file drc_item.h.

Referenced by Create().

clearance

DRC_ITEM DRC_ITEM::clearance

staticprivate

Definition at line 186 of file drc_item.h.

Referenced by Create().

connectionWidth

DRC_ITEM DRC_ITEM::connectionWidth

staticprivate

Definition at line 198 of file drc_item.h.

Referenced by Create().

copperSliver

DRC_ITEM DRC_ITEM::copperSliver

staticprivate

Definition at line 227 of file drc_item.h.

Referenced by Create().

courtyardsOverlap

DRC_ITEM DRC_ITEM::courtyardsOverlap

staticprivate

Definition at line 208 of file drc_item.h.

Referenced by Create().

creepage

DRC_ITEM DRC_ITEM::creepage

staticprivate

Definition at line 187 of file drc_item.h.

Referenced by Create().

diffPairGapOutOfRange

DRC_ITEM DRC_ITEM::diffPairGapOutOfRange

staticprivate

Definition at line 237 of file drc_item.h.

Referenced by Create().

diffPairUncoupledLengthTooLong

DRC_ITEM DRC_ITEM::diffPairUncoupledLengthTooLong

staticprivate

Definition at line 238 of file drc_item.h.

Referenced by Create().

drillTooSmall

DRC_ITEM DRC_ITEM::drillTooSmall

staticprivate

Definition at line 203 of file drc_item.h.

Referenced by Create().

duplicateFootprints

DRC_ITEM DRC_ITEM::duplicateFootprints

staticprivate

Definition at line 215 of file drc_item.h.

Referenced by Create().

edgeClearance

DRC_ITEM DRC_ITEM::edgeClearance

staticprivate

Definition at line 189 of file drc_item.h.

Referenced by Create().

extraFootprint

DRC_ITEM DRC_ITEM::extraFootprint

staticprivate

Definition at line 217 of file drc_item.h.

Referenced by Create().

footprint

DRC_ITEM DRC_ITEM::footprint

staticprivate

Definition at line 239 of file drc_item.h.

Referenced by Create().

footprintFilters

DRC_ITEM DRC_ITEM::footprintFilters

staticprivate

Definition at line 220 of file drc_item.h.

Referenced by Create().

footprintTHPadhasNoHole

DRC_ITEM DRC_ITEM::footprintTHPadhasNoHole

staticprivate

Definition at line 241 of file drc_item.h.

Referenced by Create().

footprintTypeMismatch

DRC_ITEM DRC_ITEM::footprintTypeMismatch

staticprivate

Definition at line 240 of file drc_item.h.

Referenced by Create().

genericError

DRC_ITEM DRC_ITEM::genericError

staticprivate

Definition at line 226 of file drc_item.h.

Referenced by Create().

genericWarning

DRC_ITEM DRC_ITEM::genericWarning

staticprivate

Definition at line 225 of file drc_item.h.

Referenced by Create().

heading_DFM

DRC_ITEM DRC_ITEM::heading_DFM

staticprivate

Definition at line 175 of file drc_item.h.

heading_electrical

DRC_ITEM DRC_ITEM::heading_electrical

staticprivate

Definition at line 174 of file drc_item.h.

heading_internal

DRC_ITEM DRC_ITEM::heading_internal

staticprivate

Definition at line 180 of file drc_item.h.

Referenced by GetItemsWithSeverities().

heading_misc

DRC_ITEM DRC_ITEM::heading_misc

staticprivate

Definition at line 179 of file drc_item.h.

heading_readability

DRC_ITEM DRC_ITEM::heading_readability

staticprivate

Definition at line 178 of file drc_item.h.

heading_schematic_parity

DRC_ITEM DRC_ITEM::heading_schematic_parity

staticprivate

Definition at line 176 of file drc_item.h.

heading_signal_integrity

DRC_ITEM DRC_ITEM::heading_signal_integrity

staticprivate

Definition at line 177 of file drc_item.h.

holeClearance

DRC_ITEM DRC_ITEM::holeClearance

staticprivate

Definition at line 197 of file drc_item.h.

Referenced by Create().

holeNearHole

DRC_ITEM DRC_ITEM::holeNearHole

staticprivate

Definition at line 195 of file drc_item.h.

Referenced by Create().

holesCoLocated

DRC_ITEM DRC_ITEM::holesCoLocated

staticprivate

Definition at line 196 of file drc_item.h.

Referenced by Create().

invalidOutline

DRC_ITEM DRC_ITEM::invalidOutline

staticprivate

Definition at line 214 of file drc_item.h.

Referenced by Create().

isolatedCopper

DRC_ITEM DRC_ITEM::isolatedCopper

staticprivate

Definition at line 191 of file drc_item.h.

Referenced by Create().

itemOnDisabledLayer

DRC_ITEM DRC_ITEM::itemOnDisabledLayer

staticprivate

Definition at line 213 of file drc_item.h.

Referenced by Create().

itemsNotAllowed

DRC_ITEM DRC_ITEM::itemsNotAllowed

staticprivate

Definition at line 184 of file drc_item.h.

Referenced by Create().

lengthOutOfRange

DRC_ITEM DRC_ITEM::lengthOutOfRange

staticprivate

Definition at line 234 of file drc_item.h.

Referenced by Create().

libFootprintIssues

DRC_ITEM DRC_ITEM::libFootprintIssues

staticprivate

Definition at line 221 of file drc_item.h.

Referenced by Create().

libFootprintMismatch

DRC_ITEM DRC_ITEM::libFootprintMismatch

staticprivate

Definition at line 222 of file drc_item.h.

Referenced by Create().

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(), ERC_ITEM::ERC_ITEM(), GetAuxItem2ID(), 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(), ERC_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(), GetAuxItem2ID(), RC_ITEM::GetAuxItem3ID(), GetAuxItem3ID(), RC_ITEM::GetAuxItemID(), RC_ITEM::GetIDs(), RC_ITEM::GetMainItemID(), RC_ITEM::RC_ITEM(), and RC_ITEM::SetItems().

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(), 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(), ERC_ITEM::ERC_ITEM(), RC_ITEM::GetSettingsKey(), and RC_ITEM::RC_ITEM().

m_violatingRule

DRC_RULE* DRC_ITEM::m_violatingRule = nullptr

private

Definition at line 246 of file drc_item.h.

Referenced by GetViolatingRule(), GetViolatingRuleDesc(), and SetViolatingRule().

m_violatingTest

DRC_TEST_PROVIDER* DRC_ITEM::m_violatingTest = nullptr

private

Definition at line 247 of file drc_item.h.

Referenced by GetViolatingTest(), and SetViolatingTest().

malformedCourtyard

DRC_ITEM DRC_ITEM::malformedCourtyard

staticprivate

Definition at line 210 of file drc_item.h.

Referenced by Create().

microviaDrillTooSmall

DRC_ITEM DRC_ITEM::microviaDrillTooSmall

staticprivate

Definition at line 207 of file drc_item.h.

Referenced by Create().

mirroredTextOnFrontLayer

DRC_ITEM DRC_ITEM::mirroredTextOnFrontLayer

staticprivate

Definition at line 242 of file drc_item.h.

Referenced by Create().

missingCourtyard

DRC_ITEM DRC_ITEM::missingCourtyard

staticprivate

Definition at line 209 of file drc_item.h.

Referenced by Create().

missingFootprint

DRC_ITEM DRC_ITEM::missingFootprint

staticprivate

Definition at line 216 of file drc_item.h.

Referenced by Create().

netConflict

DRC_ITEM DRC_ITEM::netConflict

staticprivate

Definition at line 218 of file drc_item.h.

Referenced by Create().

nonMirroredTextOnBackLayer

DRC_ITEM DRC_ITEM::nonMirroredTextOnBackLayer

staticprivate

Definition at line 243 of file drc_item.h.

Referenced by Create().

npthInsideCourtyard

DRC_ITEM DRC_ITEM::npthInsideCourtyard

staticprivate

Definition at line 212 of file drc_item.h.

Referenced by Create().

padstack

DRC_ITEM DRC_ITEM::padstack

staticprivate

Definition at line 205 of file drc_item.h.

Referenced by Create().

padstackInvalid

DRC_ITEM DRC_ITEM::padstackInvalid

staticprivate

Definition at line 206 of file drc_item.h.

Referenced by Create().

pthInsideCourtyard

DRC_ITEM DRC_ITEM::pthInsideCourtyard

staticprivate

Definition at line 211 of file drc_item.h.

Referenced by Create().

schematicParity

DRC_ITEM DRC_ITEM::schematicParity

staticprivate

Definition at line 219 of file drc_item.h.

Referenced by Create().

shortingItems

DRC_ITEM DRC_ITEM::shortingItems

staticprivate

Definition at line 183 of file drc_item.h.

Referenced by Create().

silkClearance

DRC_ITEM DRC_ITEM::silkClearance

staticprivate

Definition at line 228 of file drc_item.h.

Referenced by Create().

silkEdgeClearance

DRC_ITEM DRC_ITEM::silkEdgeClearance

staticprivate

Definition at line 229 of file drc_item.h.

Referenced by Create().

silkOverlaps

DRC_ITEM DRC_ITEM::silkOverlaps

staticprivate

Definition at line 231 of file drc_item.h.

Referenced by Create().

skewOutOfRange

DRC_ITEM DRC_ITEM::skewOutOfRange

staticprivate

Definition at line 235 of file drc_item.h.

Referenced by Create().

solderMaskBridge

DRC_ITEM DRC_ITEM::solderMaskBridge

staticprivate

Definition at line 230 of file drc_item.h.

Referenced by Create().

starvedThermal

DRC_ITEM DRC_ITEM::starvedThermal

staticprivate

Definition at line 192 of file drc_item.h.

Referenced by Create().

textHeightOutOfRange

DRC_ITEM DRC_ITEM::textHeightOutOfRange

staticprivate

Definition at line 232 of file drc_item.h.

Referenced by Create().

textOnEdgeCuts

DRC_ITEM DRC_ITEM::textOnEdgeCuts

staticprivate

Definition at line 185 of file drc_item.h.

Referenced by Create().

textThicknessOutOfRange

DRC_ITEM DRC_ITEM::textThicknessOutOfRange

staticprivate

Definition at line 233 of file drc_item.h.

Referenced by Create().

trackAngle

DRC_ITEM DRC_ITEM::trackAngle

staticprivate

Definition at line 200 of file drc_item.h.

Referenced by Create().

trackDangling

DRC_ITEM DRC_ITEM::trackDangling

staticprivate

Definition at line 194 of file drc_item.h.

Referenced by Create().

tracksCrossing

DRC_ITEM DRC_ITEM::tracksCrossing

staticprivate

Definition at line 188 of file drc_item.h.

Referenced by Create().

trackSegmentLength

DRC_ITEM DRC_ITEM::trackSegmentLength

staticprivate

Definition at line 201 of file drc_item.h.

Referenced by Create().

trackWidth

DRC_ITEM DRC_ITEM::trackWidth

staticprivate

Definition at line 199 of file drc_item.h.

Referenced by Create().

unconnectedItems

DRC_ITEM DRC_ITEM::unconnectedItems

staticprivate

Definition at line 182 of file drc_item.h.

Referenced by Create().

unresolvedVariable

DRC_ITEM DRC_ITEM::unresolvedVariable

staticprivate

Definition at line 223 of file drc_item.h.

Referenced by Create().

viaCountOutOfRange

DRC_ITEM DRC_ITEM::viaCountOutOfRange

staticprivate

Definition at line 236 of file drc_item.h.

Referenced by Create().

viaDangling

DRC_ITEM DRC_ITEM::viaDangling

staticprivate

Definition at line 193 of file drc_item.h.

Referenced by Create().

viaDiameter

DRC_ITEM DRC_ITEM::viaDiameter

staticprivate

Definition at line 204 of file drc_item.h.

Referenced by Create().

zonesIntersect

DRC_ITEM DRC_ITEM::zonesIntersect

staticprivate

Definition at line 190 of file drc_item.h.

Referenced by Create().

---

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

• drc_item.h
• drc_item.cpp