SHEETLIST_ERC_ITEMS_PROVIDER Class Reference

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

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

Private Attributes
SCHEMATIC *	m_schematic
int	m_severities
std::vector< SCH_MARKER * >	m_filteredMarkers

Detailed Description

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

Definition at line 240 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 248 of file erc_settings.h.

SHEETLIST_ERC_ITEMS_PROVIDER() [2/2]

SHEETLIST_ERC_ITEMS_PROVIDER::SHEETLIST_ERC_ITEMS_PROVIDER ( const SHEETLIST_ERC_ITEMS_PROVIDER &  )

delete

Member Function Documentation

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 445 of file erc_settings.cpp.

References SCH_SCREENS::DeleteMarker(), m_filteredMarkers, m_schematic, and SCHEMATIC::Root().

GetCount()

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

overridevirtual

Implements RC_ITEMS_PROVIDER.

Definition at line 404 of file erc_settings.cpp.

References SCHEMATIC::ErcSettings(), MARKER_BASE::GetRCItem(), ERC_SETTINGS::GetSeverity(), MARKER_BASE::IsExcluded(), m_filteredMarkers, m_schematic, RPT_SEVERITY_EXCLUSION, and visitMarkers().

Referenced by BOOST_FIXTURE_TEST_CASE(), ERC_REPORT::GetTextReport(), and ERC_REPORT::WriteJsonReport().

GetERCItem()

std::shared_ptr< ERC_ITEM > SHEETLIST_ERC_ITEMS_PROVIDER::GetERCItem

(

int

aIndex

)

const

Definition at line 431 of file erc_settings.cpp.

References MARKER_BASE::GetRCItem(), and m_filteredMarkers.

Referenced by 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 439 of file erc_settings.cpp.

References GetERCItem().

Referenced by BOOST_FIXTURE_TEST_CASE(), ERC_REPORT::GetTextReport(), and ERC_REPORT::WriteJsonReport().

operator=()

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

delete

SetSeverities()

void SHEETLIST_ERC_ITEMS_PROVIDER::SetSeverities ( int  aSeverities )

overridevirtual

Implements RC_ITEMS_PROVIDER.

Definition at line 380 of file erc_settings.cpp.

References SCHEMATIC::ErcSettings(), MARKER_BASE::GetRCItem(), ERC_SETTINGS::GetSeverity(), MARKER_BASE::IsExcluded(), m_filteredMarkers, m_schematic, m_severities, RPT_SEVERITY_EXCLUSION, and visitMarkers().

Referenced by BOOST_FIXTURE_TEST_CASE(), ERC_REPORT::GetTextReport(), and ERC_REPORT::WriteJsonReport().

visitMarkers()

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

private

Definition at line 337 of file erc_settings.cpp.

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

Referenced by GetCount(), and SetSeverities().

Member Data Documentation

m_filteredMarkers

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

private

Definition at line 245 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 243 of file erc_settings.h.

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

m_severities

int SHEETLIST_ERC_ITEMS_PROVIDER::m_severities

private

Definition at line 244 of file erc_settings.h.

Referenced by SetSeverities().

---

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

• erc_settings.h
• erc_settings.cpp