KiCad PCB EDA Suite
RC_ITEMS_PROVIDER Class Referenceabstract

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

#include <rc_item.h>

Inheritance diagram for RC_ITEMS_PROVIDER:
BOARD_DRC_ITEMS_PROVIDER SHEETLIST_ERC_ITEMS_PROVIDER VECTOR_CLEANUP_ITEMS_PROVIDER VECTOR_DRC_ITEMS_PROVIDER RATSNEST_DRC_ITEMS_PROVIDER

Public Member Functions

virtual void SetSeverities (int aSeverities)=0
 
virtual int GetCount (int aSeverity=-1)=0
 
virtual RC_ITEMGetItem (int aIndex)=0
 Function GetItem retrieves a RC_ITEM by index. More...
 
virtual void DeleteItem (int aIndex, bool aDeep)=0
 Function DeleteItem removes (and optionally deletes) the indexed item from the list. More...
 
virtual void DeleteAllItems ()=0
 Function DeleteAllItems removes and deletes all the items in the list. More...
 
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 42 of file rc_item.h.

Constructor & Destructor Documentation

◆ ~RC_ITEMS_PROVIDER()

virtual RC_ITEMS_PROVIDER::~RC_ITEMS_PROVIDER ( )
inlinevirtual

Definition at line 68 of file rc_item.h.

68 { }

Member Function Documentation

◆ DeleteAllItems()

virtual void RC_ITEMS_PROVIDER::DeleteAllItems ( )
pure virtual

Function DeleteAllItems removes and deletes all the items in the list.

Implemented in VECTOR_DRC_ITEMS_PROVIDER, SHEETLIST_ERC_ITEMS_PROVIDER, BOARD_DRC_ITEMS_PROVIDER, and VECTOR_CLEANUP_ITEMS_PROVIDER.

Referenced by RC_TREE_MODEL::DeleteAllItems().

◆ DeleteItem()

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

Function DeleteItem removes (and optionally deletes) the indexed item from the list.

Parameters
aDeepIf true, the source item should be deleted as well as its entry in the list.

Implemented in VECTOR_DRC_ITEMS_PROVIDER, SHEETLIST_ERC_ITEMS_PROVIDER, BOARD_DRC_ITEMS_PROVIDER, and VECTOR_CLEANUP_ITEMS_PROVIDER.

Referenced by RC_TREE_MODEL::DeleteCurrentItem().

◆ GetCount()

◆ GetItem()

virtual RC_ITEM* RC_ITEMS_PROVIDER::GetItem ( int  aIndex)
pure virtual

◆ SetSeverities()

virtual void RC_ITEMS_PROVIDER::SetSeverities ( int  aSeverities)
pure virtual

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