RC_ITEMS_PROVIDER Class Reference

Provide an abstract interface of a RC_ITEM* list manager. More...

#include <rc_item.h>

Inheritance diagram for RC_ITEMS_PROVIDER:

Public Member Functions
virtual void	SetSeverities (int aSeverities)=0
virtual int	GetCount (int aSeverity=-1) const =0
virtual std::shared_ptr< RC_ITEM >	GetItem (int aIndex) const =0
	Retrieve a RC_ITEM by index. More...
virtual void	DeleteItem (int aIndex, bool aDeep)=0
	Remove (and optionally deletes) the indexed item from the list. More...
virtual void	DeleteAllItems (bool aIncludeExclusions, bool aDeep)=0
virtual	~RC_ITEMS_PROVIDER ()

Detailed Description

Provide an abstract interface of a RC_ITEM* list manager.

The details of the actual list architecture are hidden from the caller. Any class that implements this interface can then be used by a RC_TREE_MODEL class without it knowing the actual architecture of the list.

Definition at line 43 of file rc_item.h.

Constructor & Destructor Documentation

~RC_ITEMS_PROVIDER()

virtual RC_ITEMS_PROVIDER::~RC_ITEMS_PROVIDER ( )

inlinevirtual

Definition at line 63 of file rc_item.h.

{ }

Member Function Documentation

DeleteAllItems()

virtual void RC_ITEMS_PROVIDER::DeleteAllItems ( bool  aIncludeExclusions, bool  aDeep  )

pure virtual

Implemented in VECTOR_DRC_ITEMS_PROVIDER, SHEETLIST_ERC_ITEMS_PROVIDER, BOARD_DRC_ITEMS_PROVIDER, and VECTOR_CLEANUP_ITEMS_PROVIDER.

Referenced by RC_TREE_MODEL::DeleteItems().

DeleteItem()

virtual void RC_ITEMS_PROVIDER::DeleteItem ( int  aIndex, bool  aDeep  )

pure virtual

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.

Implemented in SHEETLIST_ERC_ITEMS_PROVIDER, VECTOR_DRC_ITEMS_PROVIDER, BOARD_DRC_ITEMS_PROVIDER, and VECTOR_CLEANUP_ITEMS_PROVIDER.

Referenced by RC_TREE_MODEL::DeleteItems().

GetCount()

virtual int RC_ITEMS_PROVIDER::GetCount ( int  aSeverity = -1 ) const

pure virtual

Implemented in SHEETLIST_ERC_ITEMS_PROVIDER, VECTOR_DRC_ITEMS_PROVIDER, VECTOR_CLEANUP_ITEMS_PROVIDER, and BOARD_DRC_ITEMS_PROVIDER.

Referenced by RC_TREE_MODEL::DeleteItems(), DIALOG_DRC::OnDeleteAllClick(), DIALOG_ERC::OnEraseDrcMarkersClick(), RC_TREE_MODEL::rebuildModel(), DIALOG_FOOTPRINT_CHECKER::updateDisplayedCounts(), DIALOG_DRC::updateDisplayedCounts(), DIALOG_ERC::updateDisplayedCounts(), and DIALOG_DRC::writeReport().

GetItem()

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

pure virtual

Retrieve a RC_ITEM by index.

Implemented in SHEETLIST_ERC_ITEMS_PROVIDER, VECTOR_DRC_ITEMS_PROVIDER, BOARD_DRC_ITEMS_PROVIDER, and VECTOR_CLEANUP_ITEMS_PROVIDER.

Referenced by RC_TREE_MODEL::DeleteItems(), RC_TREE_MODEL::rebuildModel(), and DIALOG_DRC::writeReport().

SetSeverities()

virtual void RC_ITEMS_PROVIDER::SetSeverities ( int  aSeverities )

pure virtual

Implemented in SHEETLIST_ERC_ITEMS_PROVIDER, VECTOR_DRC_ITEMS_PROVIDER, VECTOR_CLEANUP_ITEMS_PROVIDER, and BOARD_DRC_ITEMS_PROVIDER.

Referenced by RC_TREE_MODEL::rebuildModel().

---

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

• rc_item.h