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 GetSeverities () const override
 
int GetCount (int aSeverity=-1) const override
 
std::shared_ptr< RC_ITEM > GetItem (int aIndex) const override
 Retrieve a RC_ITEM by index.
 
std::shared_ptr< CLEANUP_ITEM > GetCleanupItem (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 65 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 68 of file cleanup_item.h.

References m_sourceVector.

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
aIndexis the index of the item to delete.
aDeepIf true, the source item should be deleted as well as its entry in the list.

Implements RC_ITEMS_PROVIDER.

Definition at line 97 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 92 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 82 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 87 of file cleanup_item.h.

References m_sourceVector.

◆ GetSeverities()

int VECTOR_CLEANUP_ITEMS_PROVIDER::GetSeverities ( ) const
inlineoverridevirtual

Implements RC_ITEMS_PROVIDER.

Definition at line 77 of file cleanup_item.h.

◆ SetSeverities()

void VECTOR_CLEANUP_ITEMS_PROVIDER::SetSeverities ( int aSeverities)
inlineoverridevirtual

Implements RC_ITEMS_PROVIDER.

Definition at line 73 of file cleanup_item.h.

Member Data Documentation

◆ m_sourceVector

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

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