KiCad PCB EDA Suite
Loading...
Searching...
No Matches
VECTOR_CLEANUP_ITEMS_PROVIDER Class Reference

An implementation of the interface named RC_ITEMS_PROVIDER which uses a vector of pointers to CLEANUP_ITEMs to fulfill the interface. More...

#include <cleanup_item.h>

Inheritance diagram for VECTOR_CLEANUP_ITEMS_PROVIDER:
RC_ITEMS_PROVIDER

Public Member Functions

 VECTOR_CLEANUP_ITEMS_PROVIDER (std::vector< std::shared_ptr< CLEANUP_ITEM > > *aList)
 
void SetSeverities (int aSeverities) override
 
int GetCount (int aSeverity=-1) const override
 
std::shared_ptr< RC_ITEMGetItem (int aIndex) const override
 Retrieve a RC_ITEM by index.
 
std::shared_ptr< CLEANUP_ITEMGetCleanupItem (int aIndex)
 
void DeleteItem (int aIndex, bool aDeep) override
 Remove (and optionally deletes) the indexed item from the list.
 

Private Attributes

std::vector< std::shared_ptr< CLEANUP_ITEM > > * m_sourceVector
 

Detailed Description

An implementation of the interface named RC_ITEMS_PROVIDER which uses a vector of pointers to CLEANUP_ITEMs to fulfill the interface.

No ownership is taken of the vector.

Definition at line 69 of file cleanup_item.h.

Constructor & Destructor Documentation

◆ VECTOR_CLEANUP_ITEMS_PROVIDER()

VECTOR_CLEANUP_ITEMS_PROVIDER::VECTOR_CLEANUP_ITEMS_PROVIDER ( std::vector< std::shared_ptr< CLEANUP_ITEM > > *  aList)
inline

Definition at line 72 of file cleanup_item.h.

Member Function Documentation

◆ DeleteItem()

void VECTOR_CLEANUP_ITEMS_PROVIDER::DeleteItem ( int  aIndex,
bool  aDeep 
)
inlineoverridevirtual

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.

Implements RC_ITEMS_PROVIDER.

Definition at line 96 of file cleanup_item.h.

References m_sourceVector.

◆ GetCleanupItem()

std::shared_ptr< CLEANUP_ITEM > VECTOR_CLEANUP_ITEMS_PROVIDER::GetCleanupItem ( int  aIndex)
inline

Definition at line 91 of file cleanup_item.h.

References m_sourceVector.

◆ GetCount()

int VECTOR_CLEANUP_ITEMS_PROVIDER::GetCount ( int  aSeverity = -1) const
inlineoverridevirtual

Implements RC_ITEMS_PROVIDER.

Definition at line 81 of file cleanup_item.h.

References m_sourceVector.

◆ GetItem()

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

Retrieve a RC_ITEM by index.

Implements RC_ITEMS_PROVIDER.

Definition at line 86 of file cleanup_item.h.

References m_sourceVector.

◆ SetSeverities()

void VECTOR_CLEANUP_ITEMS_PROVIDER::SetSeverities ( int  aSeverities)
inlineoverridevirtual

Implements RC_ITEMS_PROVIDER.

Definition at line 77 of file cleanup_item.h.

Member Data Documentation

◆ m_sourceVector

std::vector<std::shared_ptr<CLEANUP_ITEM> >* VECTOR_CLEANUP_ITEMS_PROVIDER::m_sourceVector
private

Definition at line 106 of file cleanup_item.h.

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


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