KiCad PCB EDA Suite: SHEETLIST_ERC_ITEMS_PROVIDER Class Reference

KiCad PCB EDA Suite

Loading...

Searching...

No Matches

An implementation of the RC_ITEM_LIST interface which uses the global SHEETLIST to fulfill the contract. More...

#include <erc_settings.h>

Inheritance diagram for SHEETLIST_ERC_ITEMS_PROVIDER:

Public Member Functions
	SHEETLIST_ERC_ITEMS_PROVIDER (SCHEMATIC *aSchematic)

	SHEETLIST_ERC_ITEMS_PROVIDER (const SHEETLIST_ERC_ITEMS_PROVIDER &)=delete

SHEETLIST_ERC_ITEMS_PROVIDER &	operator= (const SHEETLIST_ERC_ITEMS_PROVIDER &)=delete

void	SetSeverities (int aSeverities) override

int	GetSeverities () const override

int	GetCount (int aSeverity=-1) const override

std::shared_ptr< RC_ITEM >	GetItem (int aIndex) const override
	Retrieve a RC_ITEM by index.

std::shared_ptr< ERC_ITEM >	GetERCItem (int aIndex) const

void	DeleteItem (int aIndex, bool aDeep) override
	Remove (and optionally deletes) the indexed item from the list.

void	SetMarkerExcluded (SCH_MARKER *aMarker, bool aExcluded, const wxString &aComment=wxEmptyString)
	Set the exclusion state of a marker while keeping the cached severity counts in sync.

Private Member Functions
void	visitMarkers (std::function< void(SCH_MARKER *)> aVisitor) const

SEVERITY	markerSeverity (SCH_MARKER *aMarker) const

void	adjustCount (SEVERITY aSeverity, int aDelta)

Private Attributes
SCHEMATIC *	m_schematic

int	m_severities

std::vector< SCH_MARKER * >	m_filteredMarkers

int	m_errorCount

int	m_warningCount

int	m_exclusionCount

Detailed Description

An implementation of the RC_ITEM_LIST interface which uses the global SHEETLIST to fulfill the contract.

Definition at line 250 of file erc_settings.h.

Constructor & Destructor Documentation

◆ SHEETLIST_ERC_ITEMS_PROVIDER() [1/2]

SHEETLIST_ERC_ITEMS_PROVIDER::SHEETLIST_ERC_ITEMS_PROVIDER ( SCHEMATIC * aSchematic )

inline

Definition at line 262 of file erc_settings.h.

References m_errorCount, m_exclusionCount, m_schematic, m_severities, and m_warningCount.

Referenced by operator=(), and SHEETLIST_ERC_ITEMS_PROVIDER().

◆ SHEETLIST_ERC_ITEMS_PROVIDER() [2/2]

SHEETLIST_ERC_ITEMS_PROVIDER::SHEETLIST_ERC_ITEMS_PROVIDER ( const SHEETLIST_ERC_ITEMS_PROVIDER & )

delete

References SHEETLIST_ERC_ITEMS_PROVIDER().

Member Function Documentation

◆ adjustCount()

void SHEETLIST_ERC_ITEMS_PROVIDER::adjustCount	(	SEVERITY	aSeverity,
		int	aDelta )

private

Definition at line 402 of file erc_settings.cpp.

References m_errorCount, m_exclusionCount, m_warningCount, RPT_SEVERITY_ERROR, RPT_SEVERITY_EXCLUSION, and RPT_SEVERITY_WARNING.

Referenced by DeleteItem(), SetMarkerExcluded(), and SetSeverities().

◆ DeleteItem()

void SHEETLIST_ERC_ITEMS_PROVIDER::DeleteItem	(	int	aIndex,
		bool	aDeep )

overridevirtual

Remove (and optionally deletes) the indexed item from the list.

Parameters

aDeep If true, the source item should be deleted as well as its entry in the list.

Implements RC_ITEMS_PROVIDER.

Definition at line 501 of file erc_settings.cpp.

References adjustCount(), SCH_SCREENS::DeleteMarker(), m_filteredMarkers, m_schematic, and markerSeverity().

◆ GetCount()

int SHEETLIST_ERC_ITEMS_PROVIDER::GetCount ( int aSeverity = -1 ) const

overridevirtual

Implements RC_ITEMS_PROVIDER.

Definition at line 449 of file erc_settings.cpp.

References m_errorCount, m_exclusionCount, m_filteredMarkers, m_warningCount, RPT_SEVERITY_ERROR, RPT_SEVERITY_EXCLUSION, and RPT_SEVERITY_WARNING.

Referenced by BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), and CountErrorCode().

◆ GetERCItem()

std::shared_ptr< ERC_ITEM > SHEETLIST_ERC_ITEMS_PROVIDER::GetERCItem ( int aIndex ) const

Definition at line 469 of file erc_settings.cpp.

References MARKER_BASE::GetRCItem(), and m_filteredMarkers.

Referenced by BOOST_FIXTURE_TEST_CASE(), and GetItem().

◆ GetItem()

std::shared_ptr< RC_ITEM > SHEETLIST_ERC_ITEMS_PROVIDER::GetItem ( int aIndex ) const

overridevirtual

Retrieve a RC_ITEM by index.

Implements RC_ITEMS_PROVIDER.

Definition at line 477 of file erc_settings.cpp.

References GetERCItem().

Referenced by BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), and CountErrorCode().

◆ GetSeverities()

int SHEETLIST_ERC_ITEMS_PROVIDER::GetSeverities ( ) const

overridevirtual

Implements RC_ITEMS_PROVIDER.

Definition at line 443 of file erc_settings.cpp.

References m_severities.

◆ markerSeverity()

SEVERITY SHEETLIST_ERC_ITEMS_PROVIDER::markerSeverity ( SCH_MARKER * aMarker ) const

private

Definition at line 393 of file erc_settings.cpp.

References RC_ITEM::GetErrorCode(), MARKER_BASE::GetRCItem(), MARKER_BASE::IsExcluded(), m_schematic, and RPT_SEVERITY_EXCLUSION.

Referenced by DeleteItem(), SetMarkerExcluded(), and SetSeverities().

◆ operator=()

SHEETLIST_ERC_ITEMS_PROVIDER & SHEETLIST_ERC_ITEMS_PROVIDER::operator= ( const SHEETLIST_ERC_ITEMS_PROVIDER & )

delete

References SHEETLIST_ERC_ITEMS_PROVIDER().

◆ SetMarkerExcluded()

void SHEETLIST_ERC_ITEMS_PROVIDER::SetMarkerExcluded	(	SCH_MARKER *	aMarker,
		bool	aExcluded,
		const wxString &	aComment = wxEmptyString )

Set the exclusion state of a marker while keeping the cached severity counts in sync.

Parameters

aExcluded	true to exclude the marker, false to restore it.
aComment	optional exclusion comment.

Definition at line 483 of file erc_settings.cpp.

References adjustCount(), MARKER_BASE::IsExcluded(), markerSeverity(), and MARKER_BASE::SetExcluded().

Referenced by BOOST_FIXTURE_TEST_CASE(), and setMarkerExcluded().

◆ SetSeverities()

void SHEETLIST_ERC_ITEMS_PROVIDER::SetSeverities ( int aSeverities )

overridevirtual

Implements RC_ITEMS_PROVIDER.

Definition at line 414 of file erc_settings.cpp.

References adjustCount(), m_errorCount, m_exclusionCount, m_filteredMarkers, m_severities, m_warningCount, markerSeverity(), and visitMarkers().

Referenced by BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), and BOOST_FIXTURE_TEST_CASE().

◆ visitMarkers()

void SHEETLIST_ERC_ITEMS_PROVIDER::visitMarkers ( std::function< void(SCH_MARKER *)> aVisitor ) const

private

Definition at line 350 of file erc_settings.cpp.

References MARKER_BASE::GetMarkerType(), MARKER_BASE::GetRCItem(), m_schematic, MARKER_BASE::MARKER_ERC, and SCH_MARKER_T.

Referenced by SetSeverities().

Member Data Documentation

◆ m_errorCount

int SHEETLIST_ERC_ITEMS_PROVIDER::m_errorCount

private

Definition at line 257 of file erc_settings.h.

Referenced by adjustCount(), GetCount(), SetSeverities(), and SHEETLIST_ERC_ITEMS_PROVIDER().

◆ m_exclusionCount

int SHEETLIST_ERC_ITEMS_PROVIDER::m_exclusionCount

private

Definition at line 259 of file erc_settings.h.

Referenced by adjustCount(), GetCount(), SetSeverities(), and SHEETLIST_ERC_ITEMS_PROVIDER().

◆ m_filteredMarkers

std::vector<SCH_MARKER*> SHEETLIST_ERC_ITEMS_PROVIDER::m_filteredMarkers

private

Definition at line 255 of file erc_settings.h.

Referenced by DeleteItem(), GetCount(), GetERCItem(), and SetSeverities().

◆ m_schematic

SCHEMATIC* SHEETLIST_ERC_ITEMS_PROVIDER::m_schematic

private

Definition at line 253 of file erc_settings.h.

Referenced by DeleteItem(), markerSeverity(), SHEETLIST_ERC_ITEMS_PROVIDER(), and visitMarkers().

◆ m_severities

int SHEETLIST_ERC_ITEMS_PROVIDER::m_severities

private

Definition at line 254 of file erc_settings.h.

Referenced by GetSeverities(), SetSeverities(), and SHEETLIST_ERC_ITEMS_PROVIDER().

◆ m_warningCount

int SHEETLIST_ERC_ITEMS_PROVIDER::m_warningCount

private

Definition at line 258 of file erc_settings.h.

Referenced by adjustCount(), GetCount(), SetSeverities(), and SHEETLIST_ERC_ITEMS_PROVIDER().

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

SHEETLIST_ERC_ITEMS_PROVIDER
Generated on Tue Jul 7 2026 00:07:58 for KiCad PCB EDA Suite by 1.13.2