KiCad PCB EDA Suite
COLLECTOR Class Reference

COLLECTOR is an abstract class that will find and hold all the objects according to an inspection done by the Inspect() function which must be implemented by any derived class. More...

#include <collector.h>

Inheritance diagram for COLLECTOR:
EE_COLLECTOR GERBER_COLLECTOR PCB_COLLECTOR GENERAL_COLLECTOR PCB_LAYER_COLLECTOR PCB_TYPE_COLLECTOR

Public Types

using ITER = std::vector< EDA_ITEM * >::iterator
 
using CITER = std::vector< EDA_ITEM * >::const_iterator
 

Public Member Functions

 COLLECTOR ()
 
virtual ~COLLECTOR ()
 
virtual SEARCH_RESULT Inspect (EDA_ITEM *aItem, void *aTestData)
 
ITER begin ()
 
ITER end ()
 
CITER begin () const
 
CITER end () const
 
int GetCount () const
 Function GetCount returns the number of objects in the list. More...
 
void Empty ()
 Function Empty sets the list to empty. More...
 
void Append (EDA_ITEM *item)
 Function Append adds an item to the end of the list. More...
 
void Remove (int aIndex)
 Function Remove removes the item at aIndex (first position is 0);. More...
 
void Remove (const EDA_ITEM *aItem)
 Function Remove removes the item aItem (if exists in the collector). More...
 
bool HasAdditionalItems ()
 Test if the collector has heuristic backup items. More...
 
void Combine ()
 Re-combines the backup list into the main list of the collector. More...
 
void Transfer (int aIndex)
 Moves the item at aIndex (first position is 0) to the backup list. More...
 
void Transfer (EDA_ITEM *aItem)
 Moves the item aItem (if exists in the collector) to the backup list. More...
 
virtual EDA_ITEMoperator[] (int aIndex) const
 Function operator[int] is used for read only access and returns the object at aIndex. More...
 
EDA_ITEM *const * BasePtr () const
 Function BasePtr returns the address of the first element in the array. More...
 
bool HasItem (const EDA_ITEM *aItem) const
 Function HasItem tests if aItem has already been collected. More...
 
void SetScanTypes (const KICAD_T *scanTypes)
 Function SetScanTypes records the list of KICAD_T types to consider for collection by the Inspect() function. More...
 
void SetRefPos (const wxPoint &aRefPos)
 
const EDA_RECTGetBoundingBox () const
 
int CountType (KICAD_T aType)
 Function CountType counts the number of items matching aType. More...
 

Public Attributes

int m_Threshold
 
wxString m_MenuTitle
 
bool m_MenuCancelled
 

Protected Attributes

std::vector< EDA_ITEM * > m_List
 
std::vector< EDA_ITEM * > m_BackupList
 
const KICAD_Tm_ScanTypes
 
INSPECTOR_FUNC m_inspector
 
wxPoint m_RefPos
 
EDA_RECT m_RefBox
 

Detailed Description

COLLECTOR is an abstract class that will find and hold all the objects according to an inspection done by the Inspect() function which must be implemented by any derived class.

When Inspect() finds an object that it wants to collect, i.e. one that it "likes", then it only has to do an Append( testItem ) on it to add it to its collection, but in all cases for the scan to continue, Inspect() must return SEARCH_CONTINUE.

Later, after collection, the user can iterate through all the objects in the remembered collection using GetCount() and the [int] operator.

Definition at line 55 of file collector.h.

Member Typedef Documentation

◆ CITER

using COLLECTOR::CITER = std::vector<EDA_ITEM*>::const_iterator

Definition at line 90 of file collector.h.

◆ ITER

using COLLECTOR::ITER = std::vector<EDA_ITEM*>::iterator

Definition at line 89 of file collector.h.

Constructor & Destructor Documentation

◆ COLLECTOR()

COLLECTOR::COLLECTOR ( )
inline

Definition at line 73 of file collector.h.

73  :
74  m_ScanTypes( 0 ),
75  // Inspect() is virtual so calling it from a class common inspector preserves polymorphism.
76  m_inspector( [=] ( EDA_ITEM* aItem, void* aTestData ) { return this->Inspect( aItem, aTestData ); } ),
77  m_Threshold( 0 ),
78  m_MenuCancelled( false )
79  {
80  }
int m_Threshold
Definition: collector.h:67
bool m_MenuCancelled
Definition: collector.h:70
INSPECTOR_FUNC m_inspector
Definition: collector.h:62
EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boards.
Definition: base_struct.h:159
virtual SEARCH_RESULT Inspect(EDA_ITEM *aItem, void *aTestData)
Definition: collector.h:84
const KICAD_T * m_ScanTypes
Definition: collector.h:61

References Inspect().

◆ ~COLLECTOR()

virtual COLLECTOR::~COLLECTOR ( )
inlinevirtual

Definition at line 82 of file collector.h.

82 {}

Member Function Documentation

◆ Append()

◆ BasePtr()

EDA_ITEM* const* COLLECTOR::BasePtr ( ) const
inline

Function BasePtr returns the address of the first element in the array.

Only call this if there is at least one element in the vector m_List, otherwise a C++ exception should get thrown.

Definition at line 217 of file collector.h.

218  {
219  return &m_List[0];
220  }
std::vector< EDA_ITEM * > m_List
Definition: collector.h:58

References m_List.

◆ begin() [1/2]

ITER COLLECTOR::begin ( )
inline

Definition at line 92 of file collector.h.

92 { return m_List.begin(); }
std::vector< EDA_ITEM * > m_List
Definition: collector.h:58

References m_List.

◆ begin() [2/2]

CITER COLLECTOR::begin ( ) const
inline

Definition at line 94 of file collector.h.

94 { return m_List.cbegin(); }
std::vector< EDA_ITEM * > m_List
Definition: collector.h:58

References m_List.

◆ Combine()

void COLLECTOR::Combine ( )
inline

Re-combines the backup list into the main list of the collector.

Definition at line 164 of file collector.h.

165  {
166  std::copy( m_BackupList.begin(), m_BackupList.end(), std::back_inserter( m_List ) );
167  m_BackupList.clear();
168  }
std::vector< EDA_ITEM * > m_BackupList
Definition: collector.h:59
std::vector< EDA_ITEM * > m_List
Definition: collector.h:58

References m_BackupList, and m_List.

Referenced by EE_SELECTION_TOOL::doSelectionMenu(), and SELECTION_TOOL::doSelectionMenu().

◆ CountType()

int COLLECTOR::CountType ( KICAD_T  aType)
inline

Function CountType counts the number of items matching aType.

Parameters
aTypetype we are interested in
Returns
number of occurences

Definition at line 262 of file collector.h.

263  {
264  int cnt = 0;
265  for( size_t i = 0; i < m_List.size(); i++ )
266  {
267  if( m_List[i]->Type() == aType )
268  cnt++;
269  }
270  return cnt;
271  }
std::vector< EDA_ITEM * > m_List
Definition: collector.h:58

References m_List.

Referenced by SELECTION_TOOL::GuessSelectionCandidates(), and ROUTER_TOOL::NeighboringSegmentFilter().

◆ Empty()

◆ end() [1/2]

ITER COLLECTOR::end ( )
inline

Definition at line 93 of file collector.h.

93 { return m_List.end(); }
std::vector< EDA_ITEM * > m_List
Definition: collector.h:58

References m_List.

◆ end() [2/2]

CITER COLLECTOR::end ( ) const
inline

Definition at line 95 of file collector.h.

95 { return m_List.cend(); }
std::vector< EDA_ITEM * > m_List
Definition: collector.h:58

References m_List.

◆ GetBoundingBox()

const EDA_RECT& COLLECTOR::GetBoundingBox ( ) const
inline

Definition at line 254 of file collector.h.

254 { return m_RefBox; }
EDA_RECT m_RefBox
Definition: collector.h:64

References m_RefBox.

◆ GetCount()

int COLLECTOR::GetCount ( ) const
inline

Function GetCount returns the number of objects in the list.

Definition at line 101 of file collector.h.

102  {
103  return (int) m_List.size();
104  }
std::vector< EDA_ITEM * > m_List
Definition: collector.h:58

References m_List.

Referenced by BuildBoardPolygonOutlines(), calcMaxArea(), connectedItemFilter(), MODULE::CoverageRatio(), SCH_EDIT_TOOL::DeleteItemCursor(), PCBNEW_CONTROL::DeleteItemCursor(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), SELECTION_TOOL::doSelectionMenu(), EditToolSelectionFilter(), PAD_TOOL::EnumeratePads(), SELECTION_TOOL::filterCollectedItems(), EDIT_TOOL::FootprintFilter(), DSN::SPECCTRA_DB::FromBOARD(), EE_SELECTION_TOOL::GetNode(), PANEL_SETUP_LAYERS::getNonRemovableLayers(), PANEL_SETUP_LAYERS::getRemovedLayersWithItems(), GENDRILL_WRITER_BASE::getUniqueLayerPairs(), PL_SELECTION_TOOL::guessSelectionCandidates(), SELECTION_TOOL::GuessSelectionCandidates(), EE_SELECTION_TOOL::GuessSelectionCandidates(), PCB_INSPECTION_TOOL::highlightNet(), PCB_EDIT_FRAME::inferLegacyEdgeClearance(), EE_COLLECTOR::IsCorner(), DSN::SPECCTRA_DB::makeIMAGE(), ROUTER_TOOL::NeighboringSegmentFilter(), EE_COLLECTOR::operator[](), GERBER_COLLECTOR::operator[](), operator[](), PCB_COLLECTOR::operator[](), EDIT_TOOL::PadFilter(), SELECTION_TOOL::pickSmallestComponent(), PL_SELECTION_TOOL::SelectPoint(), GERBVIEW_SELECTION_TOOL::selectPoint(), EE_SELECTION_TOOL::SelectPoint(), SELECTION_TOOL::selectPoint(), and PANEL_SETUP_LAYERS::TransferDataFromWindow().

◆ HasAdditionalItems()

bool COLLECTOR::HasAdditionalItems ( )
inline

Test if the collector has heuristic backup items.

Returns
true if Combine() can run to bring secondary items into the list

Definition at line 156 of file collector.h.

157  {
158  return !m_BackupList.empty();
159  }
std::vector< EDA_ITEM * > m_BackupList
Definition: collector.h:59

References m_BackupList.

Referenced by EE_SELECTION_TOOL::doSelectionMenu(), and SELECTION_TOOL::doSelectionMenu().

◆ HasItem()

bool COLLECTOR::HasItem ( const EDA_ITEM aItem) const
inline

Function HasItem tests if aItem has already been collected.

Parameters
aItemThe EDA_ITEM* to be tested.
Returns
True if aItem is already collected.

Definition at line 229 of file collector.h.

230  {
231  for( size_t i = 0; i < m_List.size(); i++ )
232  {
233  if( m_List[i] == aItem )
234  return true;
235  }
236 
237  return false;
238  }
std::vector< EDA_ITEM * > m_List
Definition: collector.h:58

References m_List.

Referenced by EditToolSelectionFilter().

◆ Inspect()

virtual SEARCH_RESULT COLLECTOR::Inspect ( EDA_ITEM aItem,
void *  aTestData 
)
inlinevirtual

Reimplemented in PCB_LAYER_COLLECTOR, PCB_TYPE_COLLECTOR, GENERAL_COLLECTOR, GERBER_COLLECTOR, and EE_COLLECTOR.

Definition at line 84 of file collector.h.

85  {
86  return SEARCH_RESULT::QUIT;
87  };

References QUIT.

Referenced by COLLECTOR().

◆ operator[]()

virtual EDA_ITEM* COLLECTOR::operator[] ( int  aIndex) const
inlinevirtual

Function operator[int] is used for read only access and returns the object at aIndex.

Parameters
aIndexThe index into the list.
Returns
EDA_ITEM* - or something derived from it, or NULL.

Reimplemented in PCB_COLLECTOR, GERBER_COLLECTOR, and EE_COLLECTOR.

Definition at line 203 of file collector.h.

204  {
205  if( (unsigned)aIndex < (unsigned)GetCount() ) // (unsigned) excludes aIndex<0 also
206  return m_List[ aIndex ];
207 
208  return NULL;
209  }
int GetCount() const
Function GetCount returns the number of objects in the list.
Definition: collector.h:101
#define NULL
std::vector< EDA_ITEM * > m_List
Definition: collector.h:58

References GetCount(), m_List, and NULL.

◆ Remove() [1/2]

void COLLECTOR::Remove ( int  aIndex)
inline

Function Remove removes the item at aIndex (first position is 0);.

Parameters
aIndexThe index into the list.

Definition at line 130 of file collector.h.

131  {
132  m_List.erase( m_List.begin() + aIndex );
133  }
std::vector< EDA_ITEM * > m_List
Definition: collector.h:58

References m_List.

Referenced by connectedItemFilter(), PCBNEW_CONTROL::DeleteItemCursor(), EditToolSelectionFilter(), EDIT_TOOL::FootprintFilter(), PCB_INSPECTION_TOOL::highlightNet(), EDIT_TOOL::PadFilter(), GERBVIEW_SELECTION_TOOL::selectPoint(), EE_SELECTION_TOOL::SelectPoint(), and SELECTION_TOOL::selectPoint().

◆ Remove() [2/2]

void COLLECTOR::Remove ( const EDA_ITEM aItem)
inline

Function Remove removes the item aItem (if exists in the collector).

Parameters
aItemthe item to be removed.

Definition at line 140 of file collector.h.

141  {
142  for( size_t i = 0; i < m_List.size(); i++ )
143  {
144  if( m_List[i] == aItem )
145  {
146  m_List.erase( m_List.begin() + i);
147  return;
148  }
149  }
150  }
std::vector< EDA_ITEM * > m_List
Definition: collector.h:58

References m_List.

◆ SetRefPos()

void COLLECTOR::SetRefPos ( const wxPoint aRefPos)
inline

Definition at line 252 of file collector.h.

252 { m_RefPos = aRefPos; }
wxPoint m_RefPos
Definition: collector.h:63

References m_RefPos.

Referenced by EE_COLLECTOR::Collect(), GERBER_COLLECTOR::Collect(), and GENERAL_COLLECTOR::Collect().

◆ SetScanTypes()

void COLLECTOR::SetScanTypes ( const KICAD_T scanTypes)
inline

Function SetScanTypes records the list of KICAD_T types to consider for collection by the Inspect() function.

Parameters
scanTypesAn array of KICAD_T, terminated by EOT. No copy is is made of this array (so cannot come from caller's stack).

Definition at line 247 of file collector.h.

248  {
249  m_ScanTypes = scanTypes;
250  }
const KICAD_T * m_ScanTypes
Definition: collector.h:61

References m_ScanTypes.

Referenced by EE_COLLECTOR::Collect(), GERBER_COLLECTOR::Collect(), GENERAL_COLLECTOR::Collect(), EE_COLLECTOR::EE_COLLECTOR(), GENERAL_COLLECTOR::GENERAL_COLLECTOR(), and GERBER_COLLECTOR::GERBER_COLLECTOR().

◆ Transfer() [1/2]

void COLLECTOR::Transfer ( int  aIndex)
inline

Moves the item at aIndex (first position is 0) to the backup list.

Parameters
aIndexThe index into the list.

Definition at line 174 of file collector.h.

175  {
176  m_BackupList.push_back( m_List[aIndex] );
177  m_List.erase( m_List.begin() + aIndex );
178  }
std::vector< EDA_ITEM * > m_BackupList
Definition: collector.h:59
std::vector< EDA_ITEM * > m_List
Definition: collector.h:58

References m_BackupList, and m_List.

Referenced by PL_SELECTION_TOOL::guessSelectionCandidates(), SELECTION_TOOL::GuessSelectionCandidates(), and EE_SELECTION_TOOL::GuessSelectionCandidates().

◆ Transfer() [2/2]

void COLLECTOR::Transfer ( EDA_ITEM aItem)
inline

Moves the item aItem (if exists in the collector) to the backup list.

Parameters
aItemthe item to be moved.

Definition at line 184 of file collector.h.

185  {
186  for( size_t i = 0; i < m_List.size(); i++ )
187  {
188  if( m_List[i] == aItem )
189  {
190  m_List.erase( m_List.begin() + i );
191  m_BackupList.push_back( aItem );
192  return;
193  }
194  }
195  }
std::vector< EDA_ITEM * > m_BackupList
Definition: collector.h:59
std::vector< EDA_ITEM * > m_List
Definition: collector.h:58

References m_BackupList, and m_List.

Member Data Documentation

◆ m_BackupList

std::vector<EDA_ITEM*> COLLECTOR::m_BackupList
protected

Definition at line 59 of file collector.h.

Referenced by Combine(), HasAdditionalItems(), and Transfer().

◆ m_inspector

◆ m_List

◆ m_MenuCancelled

◆ m_MenuTitle

◆ m_RefBox

EDA_RECT COLLECTOR::m_RefBox
protected

Definition at line 64 of file collector.h.

Referenced by GetBoundingBox().

◆ m_RefPos

wxPoint COLLECTOR::m_RefPos
protected

◆ m_ScanTypes

const KICAD_T* COLLECTOR::m_ScanTypes
protected

◆ m_Threshold


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