KiCad PCB EDA Suite
Loading...
Searching...
No Matches
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:
DRC_ITEMS_PROVIDER SHEETLIST_ERC_ITEMS_PROVIDER VECTOR_CLEANUP_ITEMS_PROVIDER

Public Member Functions

virtual void SetSeverities (int aSeverities)=0
 
virtual int GetCount (int aSeverity=-1) const =0
 
virtual std::shared_ptr< RC_ITEMGetItem (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 ~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 51 of file rc_item.h.

Constructor & Destructor Documentation

◆ ~RC_ITEMS_PROVIDER()

virtual RC_ITEMS_PROVIDER::~RC_ITEMS_PROVIDER ( )
inlinevirtual

Definition at line 69 of file rc_item.h.

Member Function Documentation

◆ DeleteItem()

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

Remove (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 SHEETLIST_ERC_ITEMS_PROVIDER, VECTOR_CLEANUP_ITEMS_PROVIDER, and DRC_ITEMS_PROVIDER.

◆ GetCount()

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

◆ GetItem()

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

◆ SetSeverities()

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

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