KiCad PCB EDA Suite
COLLECTOR Class Reference

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
 Return the number of objects in the list. More...
 
void Empty ()
 Clear the list. More...
 
void Append (EDA_ITEM *item)
 Add an item to the end of the list. More...
 
void Remove (int aIndex)
 Remove the item at aIndex (first position is 0). More...
 
void Remove (const EDA_ITEM *aItem)
 Remove the item aItem (if exists in the collector). More...
 
bool HasAdditionalItems ()
 Test if the collector has heuristic backup items. More...
 
void Combine ()
 Re-combine the backup list into the main list of the collector. More...
 
void Transfer (int aIndex)
 Move the item at aIndex (first position is 0) to the backup list. More...
 
void Transfer (EDA_ITEM *aItem)
 Move aItem (if exists in the collector) to the backup list. More...
 
virtual EDA_ITEMoperator[] (int aIndex) const
 Used for read only access and returns the object at aIndex. More...
 
bool HasItem (const EDA_ITEM *aItem) const
 Tests if aItem has already been collected. More...
 
void SetScanTypes (const KICAD_T *scanTypes)
 Record 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)
 Count 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

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 48 of file collector.h.

Member Typedef Documentation

◆ CITER

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

Definition at line 72 of file collector.h.

◆ ITER

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

Definition at line 71 of file collector.h.

Constructor & Destructor Documentation

◆ COLLECTOR()

COLLECTOR::COLLECTOR ( )
inline

Definition at line 51 of file collector.h.

51  :
52  m_Threshold( 0 ),
53  m_MenuCancelled( false ),
54  m_scanTypes( nullptr ),
55  // Inspect() is virtual so calling it from a class common inspector preserves
56  // polymorphism.
57  m_inspector( [=]( EDA_ITEM* aItem, void* aTestData )
58  {
59  return this->Inspect( aItem, aTestData );
60  } )
61  {
62  }
int m_Threshold
Definition: collector.h:241
bool m_MenuCancelled
Definition: collector.h:244
INSPECTOR_FUNC m_inspector
Definition: collector.h:251
const KICAD_T * m_scanTypes
Definition: collector.h:250
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:100
virtual SEARCH_RESULT Inspect(EDA_ITEM *aItem, void *aTestData)
Definition: collector.h:66

References Inspect().

◆ ~COLLECTOR()

virtual COLLECTOR::~COLLECTOR ( )
inlinevirtual

Definition at line 64 of file collector.h.

64 {}

Member Function Documentation

◆ Append()

◆ begin() [1/2]

ITER COLLECTOR::begin ( )
inline

Definition at line 74 of file collector.h.

74 { return m_list.begin(); }
std::vector< EDA_ITEM * > m_list
Definition: collector.h:247

References m_list.

◆ begin() [2/2]

CITER COLLECTOR::begin ( ) const
inline

Definition at line 76 of file collector.h.

76 { return m_list.cbegin(); }
std::vector< EDA_ITEM * > m_list
Definition: collector.h:247

References m_list.

◆ Combine()

void COLLECTOR::Combine ( )
inline

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

Definition at line 141 of file collector.h.

142  {
143  std::copy( m_backupList.begin(), m_backupList.end(), std::back_inserter( m_list ) );
144  m_backupList.clear();
145  }
std::vector< EDA_ITEM * > m_list
Definition: collector.h:247
std::vector< EDA_ITEM * > m_backupList
Definition: collector.h:248

References m_backupList, and m_list.

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

◆ CountType()

int COLLECTOR::CountType ( KICAD_T  aType)
inline

Count the number of items matching aType.

Parameters
aTypetype we are interested in.
Returns
number of occurrences.

Definition at line 228 of file collector.h.

229  {
230  int cnt = 0;
231 
232  for( size_t i = 0; i < m_list.size(); i++ )
233  {
234  if( m_list[i]->Type() == aType )
235  cnt++;
236  }
237 
238  return cnt;
239  }
std::vector< EDA_ITEM * > m_list
Definition: collector.h:247

References m_list.

Referenced by ROUTER_TOOL::NeighboringSegmentFilter().

◆ Empty()

◆ end() [1/2]

ITER COLLECTOR::end ( )
inline

Definition at line 75 of file collector.h.

75 { return m_list.end(); }
std::vector< EDA_ITEM * > m_list
Definition: collector.h:247

References m_list.

◆ end() [2/2]

CITER COLLECTOR::end ( ) const
inline

Definition at line 77 of file collector.h.

77 { return m_list.cend(); }
std::vector< EDA_ITEM * > m_list
Definition: collector.h:247

References m_list.

◆ GetBoundingBox()

const EDA_RECT& COLLECTOR::GetBoundingBox ( ) const
inline

Definition at line 220 of file collector.h.

220 { return m_refBox; }
EDA_RECT m_refBox
Definition: collector.h:253

References m_refBox.

◆ GetCount()

int COLLECTOR::GetCount ( ) const
inline

Return the number of objects in the list.

Definition at line 82 of file collector.h.

83  {
84  return (int) m_list.size();
85  }
std::vector< EDA_ITEM * > m_list
Definition: collector.h:247

References m_list.

Referenced by BuildBoardPolygonOutlines(), BuildFootprintPolygonOutlines(), EDIT_TOOL::ChangeTrackWidth(), EE_SELECTION_TOOL::CollectHits(), connectedItemFilter(), EDIT_TOOL::copyToClipboard(), FOOTPRINT::CoverageRatio(), CONVERT_TOOL::CreateLines(), CONVERT_TOOL::CreatePolys(), SCH_EDIT_TOOL::DeleteItemCursor(), PCB_CONTROL::DeleteItemCursor(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), ALIGN_DISTRIBUTE_TOOL::DistributeHorizontally(), ALIGN_DISTRIBUTE_TOOL::DistributeVertically(), EDIT_TOOL::doMoveSelection(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), PCB_SELECTION_TOOL::doSelectionMenu(), EDIT_TOOL::Drag(), EDIT_TOOL::Duplicate(), PAD_TOOL::EnumeratePads(), EDIT_TOOL::FilletTracks(), PCB_SELECTION_TOOL::FilterCollectedItems(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), EDIT_TOOL::FootprintFilter(), DSN::SPECCTRA_DB::FromBOARD(), EE_SELECTION_TOOL::GetNode(), PANEL_SETUP_LAYERS::getNonRemovableLayers(), PANEL_SETUP_LAYERS::getRemovedLayersWithItems(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), GENDRILL_WRITER_BASE::getUniqueLayerPairs(), GROUP_TOOL::Group(), PL_SELECTION_TOOL::guessSelectionCandidates(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), EE_SELECTION_TOOL::GuessSelectionCandidates(), BOARD_INSPECTION_TOOL::highlightNet(), PCB_EDIT_FRAME::inferLegacyEdgeClearance(), EE_COLLECTOR::IsCorner(), EE_SELECTION_TOOL::Main(), DSN::SPECCTRA_DB::makeIMAGE(), EDIT_TOOL::MoveExact(), EE_SELECTION_TOOL::narrowSelection(), ROUTER_TOOL::NeighboringSegmentFilter(), GERBER_COLLECTOR::operator[](), EE_COLLECTOR::operator[](), operator[](), PCB_COLLECTOR::operator[](), EDIT_TOOL::PadFilter(), POSITION_RELATIVE_TOOL::PositionRelative(), CONVERT_TOOL::SegmentToArc(), PCB_SELECTION_TOOL::selectionContains(), PL_SELECTION_TOOL::SelectPoint(), GERBVIEW_SELECTION_TOOL::selectPoint(), EE_SELECTION_TOOL::selectPoint(), PCB_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 133 of file collector.h.

134  {
135  return !m_backupList.empty();
136  }
std::vector< EDA_ITEM * > m_backupList
Definition: collector.h:248

References m_backupList.

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

◆ HasItem()

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

Tests if aItem has already been collected.

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

Definition at line 196 of file collector.h.

197  {
198  for( size_t i = 0; i < m_list.size(); i++ )
199  {
200  if( m_list[i] == aItem )
201  return true;
202  }
203 
204  return false;
205  }
std::vector< EDA_ITEM * > m_list
Definition: collector.h:247

References m_list.

Referenced by EDIT_TOOL::copyToClipboard(), EDIT_TOOL::doMoveSelection(), EDIT_TOOL::Drag(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), and POSITION_RELATIVE_TOOL::PositionRelative().

◆ 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 66 of file collector.h.

67  {
68  return SEARCH_RESULT::QUIT;
69  };

References QUIT.

Referenced by COLLECTOR().

◆ operator[]()

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

Used for read only access and returns the object at aIndex.

Parameters
aIndexThe index into the list.
Returns
the object at aIndex something derived from it or NULL.

Reimplemented in PCB_COLLECTOR, EE_COLLECTOR, and GERBER_COLLECTOR.

Definition at line 182 of file collector.h.

183  {
184  if( (unsigned)aIndex < (unsigned)GetCount() ) // (unsigned) excludes aIndex<0 also
185  return m_list[ aIndex ];
186 
187  return nullptr;
188  }
std::vector< EDA_ITEM * > m_list
Definition: collector.h:247
int GetCount() const
Return the number of objects in the list.
Definition: collector.h:82

References GetCount(), and m_list.

◆ Remove() [1/2]

◆ Remove() [2/2]

void COLLECTOR::Remove ( const EDA_ITEM aItem)
inline

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

Parameters
aItemthe item to be removed.

Definition at line 120 of file collector.h.

121  {
122  alg::delete_if( m_list, [&aItem]( const EDA_ITEM* aCandidate )
123  {
124  return aCandidate == aItem;
125  } );
126  }
std::vector< EDA_ITEM * > m_list
Definition: collector.h:247
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:100
void delete_if(_Container &__c, _Function &&__f)
Deletes all values from __c for which __f returns true.
Definition: kicad_algo.h:173

References alg::delete_if(), and m_list.

◆ SetRefPos()

void COLLECTOR::SetRefPos ( const wxPoint &  aRefPos)
inline

Definition at line 218 of file collector.h.

218 { m_refPos = aRefPos; }
wxPoint m_refPos
Definition: collector.h:252

References m_refPos.

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

◆ SetScanTypes()

void COLLECTOR::SetScanTypes ( const KICAD_T scanTypes)
inline

Record 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 213 of file collector.h.

214  {
215  m_scanTypes = scanTypes;
216  }
const KICAD_T * m_scanTypes
Definition: collector.h:250

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

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

Parameters
aIndexThe index into the list.

Definition at line 152 of file collector.h.

153  {
154  m_backupList.push_back( m_list[aIndex] );
155  m_list.erase( m_list.begin() + aIndex );
156  }
std::vector< EDA_ITEM * > m_list
Definition: collector.h:247
std::vector< EDA_ITEM * > m_backupList
Definition: collector.h:248

References m_backupList, and m_list.

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

◆ Transfer() [2/2]

void COLLECTOR::Transfer ( EDA_ITEM aItem)
inline

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

Parameters
aItemthe item to be moved.

Definition at line 163 of file collector.h.

164  {
165  for( size_t i = 0; i < m_list.size(); i++ )
166  {
167  if( m_list[i] == aItem )
168  {
169  m_list.erase( m_list.begin() + i );
170  m_backupList.push_back( aItem );
171  return;
172  }
173  }
174  }
std::vector< EDA_ITEM * > m_list
Definition: collector.h:247
std::vector< EDA_ITEM * > m_backupList
Definition: collector.h:248

References m_backupList, and m_list.

Member Data Documentation

◆ m_backupList

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

Definition at line 248 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 253 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: