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

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 190 of file erc_settings.h.

Constructor & Destructor Documentation

SHEETLIST_ERC_ITEMS_PROVIDER()

SHEETLIST_ERC_ITEMS_PROVIDER::SHEETLIST_ERC_ITEMS_PROVIDER ( SCHEMATIC *  aSchematic )

inline

Definition at line 198 of file erc_settings.h.

 :
 m_schematic( aSchematic ),
 m_severities( 0 )
 { }

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

{
 SCH_MARKER* marker = m_filteredMarkers[ aIndex ];
 m_filteredMarkers.erase( m_filteredMarkers.begin() + aIndex );
 
 if( aDeep )
 {
 SCH_SCREENS screens( m_schematic->Root() );
 screens.DeleteMarker( marker );
 }
}

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

{
 if( aSeverity < 0 )
 return m_filteredMarkers.size();
 
 int count = 0;
 
 const ERC_SETTINGS& settings = m_schematic->ErcSettings();
 
 visitMarkers(
 [&]( SCH_MARKER* aMarker )
 {
 SEVERITY markerSeverity;
 
 if( aMarker->IsExcluded() )
 markerSeverity = RPT_SEVERITY_EXCLUSION;
 else
 markerSeverity = settings.GetSeverity( aMarker->GetRCItem()->GetErrorCode() );
 
 if( ( markerSeverity & aSeverity ) > 0 )
 count++;
 } );
 
 return count;
}

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

GetERCItem()

std::shared_ptr< ERC_ITEM > SHEETLIST_ERC_ITEMS_PROVIDER::GetERCItem

(

int

aIndex

)

const

Definition at line 365 of file erc_settings.cpp.

{
 SCH_MARKER* marker = m_filteredMarkers[ aIndex ];
 
 return marker ? std::static_pointer_cast<ERC_ITEM>( marker->GetRCItem() ) : nullptr;
}

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

{
 return GetERCItem( aIndex );
}

References GetERCItem().

SetSeverities()

void SHEETLIST_ERC_ITEMS_PROVIDER::SetSeverities ( int  aSeverities )

overridevirtual

Implements RC_ITEMS_PROVIDER.

Definition at line 314 of file erc_settings.cpp.

{
 m_severities = aSeverities;
 
 m_filteredMarkers.clear();
 
 ERC_SETTINGS& settings = m_schematic->ErcSettings();
 
 visitMarkers(
 [&]( SCH_MARKER* aMarker )
 {
 SEVERITY markerSeverity;
 
 if( aMarker->IsExcluded() )
 markerSeverity = RPT_SEVERITY_EXCLUSION;
 else
 markerSeverity = settings.GetSeverity( aMarker->GetRCItem()->GetErrorCode() );
 
 if( markerSeverity & m_severities )
 m_filteredMarkers.push_back( aMarker );
 } );
}

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

visitMarkers()

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

private

Definition at line 274 of file erc_settings.cpp.

{
 SCH_SHEET_LIST sheetList = m_schematic->GetSheets();
 
 std::set<SCH_SCREEN*> seenScreens;
 
 for( unsigned i = 0; i < sheetList.size(); i++ )
 {
 bool firstTime = seenScreens.count( sheetList[i].LastScreen() ) == 0;
 
 if( firstTime )
 seenScreens.insert( sheetList[i].LastScreen() );
 
 for( SCH_ITEM* item : sheetList[i].LastScreen()->Items().OfType( SCH_MARKER_T ) )
 {
 SCH_MARKER* marker = static_cast<SCH_MARKER*>( item );
 
 if( marker->GetMarkerType() != MARKER_BASE::MARKER_ERC )
 continue;
 
 std::shared_ptr<const ERC_ITEM> ercItem =
 std::static_pointer_cast<const ERC_ITEM>( marker->GetRCItem() );
 
 // Only show sheet-specific markers on the owning sheet
 if( ercItem->IsSheetSpecific() )
 {
 if( ercItem->GetSpecificSheetPath() != sheetList[i] )
 continue;
 }
 
 // Don't show non-specific markers more than once
 if( !firstTime && !ercItem->IsSheetSpecific() )
 continue;
 
 aVisitor( marker );
 }
 }
}

References MARKER_BASE::GetMarkerType(), MARKER_BASE::GetRCItem(), SCHEMATIC::GetSheets(), 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 195 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 193 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 194 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