KiCad PCB EDA Suite
DRC_ITEM_LIST Class Referenceabstract

Class DRC_ITEM_LIST provides an abstract interface of a DRC_ITEM* list manager. More...

#include <drc_stuff.h>

Inheritance diagram for DRC_ITEM_LIST:
DRC_LIST_MARKERS DRC_LIST_UNCONNECTED

Public Member Functions

virtual void DeleteAllItems ()=0
 Function DeleteAllItems removes and deletes all the items in the list. More...
 
virtual const DRC_ITEMGetItem (int aIndex)=0
 Function GetItem retrieves a DRC_ITEM by pointer. More...
 
virtual void DeleteItem (int aIndex)=0
 Function DeleteAllItems removes and deletes desired item from the list. More...
 
virtual int GetCount ()=0
 Function GetCount returns the number of items in the list. More...
 
virtual ~DRC_ITEM_LIST ()
 

Detailed Description

Class DRC_ITEM_LIST provides an abstract interface of a DRC_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 DRCLISTBOX class without it knowing the actual architecture of the list.

Definition at line 109 of file drc_stuff.h.

Constructor & Destructor Documentation

virtual DRC_ITEM_LIST::~DRC_ITEM_LIST ( )
inlinevirtual

Definition at line 142 of file drc_stuff.h.

142 { }

Member Function Documentation

virtual void DRC_ITEM_LIST::DeleteAllItems ( )
pure virtual

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

Implemented in DRC_LIST_UNCONNECTED, and DRC_LIST_MARKERS.

Referenced by DRCLISTBOX::DeleteAllItems().

virtual void DRC_ITEM_LIST::DeleteItem ( int  aIndex)
pure virtual

Function DeleteAllItems removes and deletes desired item from the list.

Parameters
aIndexThe 0 based index into the list of the desired item which is to be deleted.

Implemented in DRC_LIST_UNCONNECTED, and DRC_LIST_MARKERS.

Referenced by DRCLISTBOX::DeleteItem().

virtual int DRC_ITEM_LIST::GetCount ( )
pure virtual

Function GetCount returns the number of items in the list.

Implemented in DRC_LIST_UNCONNECTED, and DRC_LIST_MARKERS.

Referenced by DRCLISTBOX::DeleteItem(), and DRCLISTBOX::SetList().

virtual const DRC_ITEM* DRC_ITEM_LIST::GetItem ( int  aIndex)
pure virtual

Function GetItem retrieves a DRC_ITEM by pointer.

The actual item remains owned by the list container.

Parameters
aIndexThe 0 based index into the list of the desired item.
Returns
const DRC_ITEM* - the desired item or NULL if aIndex is out of range.

Implemented in DRC_LIST_UNCONNECTED, and DRC_LIST_MARKERS.

Referenced by DRCLISTBOX::GetItem(), and DRCLISTBOX::OnGetItem().


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