DRC_ITEMS_PROVIDER Class Reference

#include <drc_item.h>

Inheritance diagram for DRC_ITEMS_PROVIDER:

Public Member Functions
	DRC_ITEMS_PROVIDER (BOARD *aBoard, MARKER_BASE::TYPEMARKER aMarkerType, MARKER_BASE::TYPEMARKER otherMarkerType=MARKER_BASE::MARKER_UNSPEC)
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...
void	DeleteItem (int aIndex, bool aDeep) override
	Remove (and optionally deletes) the indexed item from the list. More...

Private Attributes
BOARD *	m_board
std::vector< MARKER_BASE::TYPEMARKER >	m_markerTypes
int	m_severities
std::vector< PCB_MARKER * >	m_filteredMarkers

Detailed Description

Definition at line 216 of file drc_item.h.

Constructor & Destructor Documentation

DRC_ITEMS_PROVIDER()

DRC_ITEMS_PROVIDER::DRC_ITEMS_PROVIDER ( BOARD *  aBoard, MARKER_BASE::TYPEMARKER  aMarkerType, MARKER_BASE::TYPEMARKER  otherMarkerType = MARKER_BASE::MARKER_UNSPEC  )

inline

Definition at line 219 of file drc_item.h.

 :
 m_board( aBoard ),
 m_severities( 0 )
 {
 m_markerTypes.push_back( aMarkerType );
 
 if( otherMarkerType != MARKER_BASE::MARKER_UNSPEC )
 m_markerTypes.push_back( otherMarkerType );
 }

References m_markerTypes, and MARKER_BASE::MARKER_UNSPEC.

Member Function Documentation

DeleteItem()

void DRC_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 479 of file drc_item.cpp.

{
 PCB_MARKER* marker = m_filteredMarkers[ aIndex ];
 m_filteredMarkers.erase( m_filteredMarkers.begin() + aIndex );
 
 if( aDeep )
 m_board->Delete( marker );
}

References BOARD_ITEM_CONTAINER::Delete(), m_board, and m_filteredMarkers.

GetCount()

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

overridevirtual

Implements RC_ITEMS_PROVIDER.

Definition at line 451 of file drc_item.cpp.

{
 if( aSeverity < 0 )
 return m_filteredMarkers.size();
 
 int count = 0;
 
 for( PCB_MARKER* marker : m_board->Markers() )
 {
 if( alg::contains( m_markerTypes, marker->GetMarkerType() )
 && ( marker->GetSeverity() & aSeverity ) > 0 )
 {
 count++;
 }
 }
 
 return count;
}

References alg::contains(), m_board, m_filteredMarkers, m_markerTypes, and BOARD::Markers().

GetItem()

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

overridevirtual

Retrieve a RC_ITEM by index.

Implements RC_ITEMS_PROVIDER.

Definition at line 471 of file drc_item.cpp.

{
 PCB_MARKER* marker = m_filteredMarkers[ aIndex ];
 
 return marker ? marker->GetRCItem() : nullptr;
}

References MARKER_BASE::GetRCItem(), and m_filteredMarkers.

SetSeverities()

void DRC_ITEMS_PROVIDER::SetSeverities ( int  aSeverities )

overridevirtual

Implements RC_ITEMS_PROVIDER.

Definition at line 434 of file drc_item.cpp.

{
 m_severities = aSeverities;
 
 m_filteredMarkers.clear();
 
 for( PCB_MARKER* marker : m_board->Markers() )
 {
 if( alg::contains( m_markerTypes, marker->GetMarkerType() )
 && ( marker->GetSeverity() & m_severities ) > 0 )
 {
 m_filteredMarkers.push_back( marker );
 }
 }
}

References alg::contains(), m_board, m_filteredMarkers, m_markerTypes, m_severities, and BOARD::Markers().

Member Data Documentation

m_board

BOARD* DRC_ITEMS_PROVIDER::m_board

private

Definition at line 239 of file drc_item.h.

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

m_filteredMarkers

std::vector<PCB_MARKER*> DRC_ITEMS_PROVIDER::m_filteredMarkers

private

Definition at line 243 of file drc_item.h.

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

m_markerTypes

std::vector<MARKER_BASE::TYPEMARKER> DRC_ITEMS_PROVIDER::m_markerTypes

private

Definition at line 240 of file drc_item.h.

Referenced by DRC_ITEMS_PROVIDER(), GetCount(), and SetSeverities().

m_severities

int DRC_ITEMS_PROVIDER::m_severities

private

Definition at line 242 of file drc_item.h.

Referenced by SetSeverities().

---

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

• drc_item.h
• drc_item.cpp