Collect all BOARD_ITEM objects of a given set of KICAD_T type(s). More...

#include <collectors.h>

Inheritance diagram for PCB_TYPE_COLLECTOR:

Public Types
using	ITER = std::vector< EDA_ITEM * >::iterator

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

Public Member Functions
SEARCH_RESULT	Inspect (EDA_ITEM testItem, void testData) override
	The examining function within the INSPECTOR which is passed to the Iterate function. More...

void	Collect (BOARD_ITEM *aBoard, const KICAD_T aScanList[])
	Collect BOARD_ITEM objects using this class's Inspector method, which does the collection. More...

BOARD_ITEM *	operator[] (int ndx) const override
	Overload the COLLECTOR::operator[](int) to return a BOARD_ITEM instead of an EDA_ITEM. More...

ITER	begin ()

CITER	begin () const

ITER	end ()

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...

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_RECT &	GetBoundingBox () 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_T *	m_scanTypes

INSPECTOR_FUNC	m_inspector

wxPoint	m_refPos

EDA_RECT	m_refBox

Detailed Description

Collect all BOARD_ITEM objects of a given set of KICAD_T type(s).

See also: class COLLECTOR

Definition at line 614 of file collectors.h.

Member Typedef Documentation

◆ CITER

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

inherited

Definition at line 72 of file collector.h.

◆ ITER

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

inherited

Definition at line 71 of file collector.h.

Member Function Documentation

◆ Append()

void COLLECTOR::Append ( EDA_ITEM * item )

inlineinherited

Add an item to the end of the list.

Parameters

item	An EDA_ITEM* to add.

Definition at line 100 of file collector.h.

  {
  m_list.push_back( item );
  }

References COLLECTOR::m_list.

Referenced by GENERAL_COLLECTOR::Collect(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), PCB_SELECTION_TOOL::doSelectionMenu(), PCB_SELECTION_TOOL::FilterCollectorForFreePads(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), EE_COLLECTOR::Inspect(), GERBER_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), Inspect(), PCB_LAYER_COLLECTOR::Inspect(), ROUTER_TOOL::NeighboringSegmentFilter(), POSITION_RELATIVE_TOOL::PositionRelative(), PCB_SELECTION_TOOL::RequestSelection(), PCB_SELECTION_TOOL::SelectAll(), PCB_SELECTION_TOOL::selectMultiple(), PL_SELECTION_TOOL::SelectPoint(), and GERBVIEW_SELECTION_TOOL::selectPoint().

◆ begin() [1/2]

ITER COLLECTOR::begin ( )

inlineinherited

Definition at line 74 of file collector.h.

74 { return m_list.begin(); }

COLLECTOR::m_list

std::vector< EDA_ITEM * > m_list

Definition: collector.h:247

References COLLECTOR::m_list.

◆ begin() [2/2]

CITER COLLECTOR::begin ( ) const

inlineinherited

Definition at line 76 of file collector.h.

76 { return m_list.cbegin(); }

COLLECTOR::m_list

std::vector< EDA_ITEM * > m_list

Definition: collector.h:247

References COLLECTOR::m_list.

◆ Collect()

void PCB_TYPE_COLLECTOR::Collect	(	BOARD_ITEM *	aBoard,
		const KICAD_T	aScanList[]
	)

Collect BOARD_ITEM objects using this class's Inspector method, which does the collection.

Parameters

aBoard	The BOARD_ITEM to scan.
aScanList	The KICAD_Ts to gather up.

Definition at line 609 of file collectors.cpp.

 {
  Empty(); // empty any existing collection
 
  aBoard->Visit( m_inspector, nullptr, aScanList );
 }

References COLLECTOR::Empty(), COLLECTOR::m_inspector, and EDA_ITEM::Visit().

Referenced by BuildBoardPolygonOutlines(), BuildFootprintPolygonOutlines(), DSN::SPECCTRA_DB::FromBOARD(), GENDRILL_WRITER_BASE::getUniqueLayerPairs(), and DSN::SPECCTRA_DB::makeIMAGE().

◆ Combine()

void COLLECTOR::Combine ( )

inlineinherited

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

Definition at line 141 of file collector.h.

  {
  std::copy( m_backupList.begin(), m_backupList.end(), std::back_inserter( m_list ) );
  m_backupList.clear();
  }

References COLLECTOR::m_backupList, and COLLECTOR::m_list.

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

◆ CountType()

int COLLECTOR::CountType ( KICAD_T aType )

inlineinherited

Count the number of items matching aType.

Parameters

aType type we are interested in.

Returns: number of occurrences.

Definition at line 228 of file collector.h.

  {
  int cnt = 0;
 
  for( size_t i = 0; i < m_list.size(); i++ )
  {
  if( m_list[i]->Type() == aType )
  cnt++;
  }
 
  return cnt;
  }

References COLLECTOR::m_list.

Referenced by ROUTER_TOOL::NeighboringSegmentFilter().

◆ Empty()

void COLLECTOR::Empty ( )

inlineinherited

Clear the list.

Definition at line 90 of file collector.h.

  {
  m_list.clear();
  }

References COLLECTOR::m_list.

Referenced by EE_COLLECTOR::Collect(), GERBER_COLLECTOR::Collect(), GENERAL_COLLECTOR::Collect(), Collect(), PCB_LAYER_COLLECTOR::Collect(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), PCB_SELECTION_TOOL::doSelectionMenu(), PAD_TOOL::EnumeratePads(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), ROUTER_TOOL::NeighboringSegmentFilter(), and GERBVIEW_SELECTION_TOOL::selectPoint().

◆ end() [1/2]

ITER COLLECTOR::end ( )

inlineinherited

Definition at line 75 of file collector.h.

75 { return m_list.end(); }

COLLECTOR::m_list

std::vector< EDA_ITEM * > m_list

Definition: collector.h:247

References COLLECTOR::m_list.

◆ end() [2/2]

CITER COLLECTOR::end ( ) const

inlineinherited

Definition at line 77 of file collector.h.

77 { return m_list.cend(); }

COLLECTOR::m_list

std::vector< EDA_ITEM * > m_list

Definition: collector.h:247

References COLLECTOR::m_list.

◆ GetBoundingBox()

const EDA_RECT& COLLECTOR::GetBoundingBox ( ) const

inlineinherited

Definition at line 220 of file collector.h.

220 { return m_refBox; }

COLLECTOR::m_refBox

EDA_RECT m_refBox

Definition: collector.h:253

References COLLECTOR::m_refBox.

◆ GetCount()

int COLLECTOR::GetCount ( ) const

inlineinherited

Return the number of objects in the list.

Definition at line 82 of file collector.h.

  {
  return (int) m_list.size();
  }

References COLLECTOR::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(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), PCB_SELECTION_TOOL::doSelectionMenu(), EDIT_TOOL::Drag(), PAD_TOOL::EnumeratePads(), EDIT_TOOL::FilletTracks(), PCB_SELECTION_TOOL::FilterCollectedItems(), PCB_SELECTION_TOOL::FilterCollectorForFreePads(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), PCB_SELECTION_TOOL::FilterCollectorForMarkers(), 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(), EE_SELECTION_TOOL::narrowSelection(), ROUTER_TOOL::NeighboringSegmentFilter(), GERBER_COLLECTOR::operator[](), EE_COLLECTOR::operator[](), COLLECTOR::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 ( )

inlineinherited

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.

  {
  return !m_backupList.empty();
  }

References COLLECTOR::m_backupList.

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

◆ HasItem()

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

inlineinherited

Tests if aItem has already been collected.

Parameters

aItem The EDA_ITEM* to be tested.

Returns: True if aItem is already collected.

Definition at line 196 of file collector.h.

  {
  for( size_t i = 0; i < m_list.size(); i++ )
  {
  if( m_list[i] == aItem )
  return true;
  }
 
  return false;
  }

References COLLECTOR::m_list.

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

◆ Inspect()

SEARCH_RESULT PCB_TYPE_COLLECTOR::Inspect	(	EDA_ITEM *	testItem,
		void *	testData
	)

overridevirtual

The examining function within the INSPECTOR which is passed to the Iterate function.

Parameters

testItem	An EDA_ITEM to examine.
testData	is not used in this class.

Returns: SEARCH_QUIT if the Iterator is to stop the scan, else SCAN_CONTINUE;

Reimplemented from COLLECTOR.

Definition at line 599 of file collectors.cpp.

 {
  // The Visit() function only visits the testItem if its type was in the
  // the scanList, so therefore we can collect anything given to us here.
  Append( testItem );
 
  return SEARCH_RESULT::CONTINUE; // always when collecting
 }

References COLLECTOR::Append(), and CONTINUE.

◆ operator[]()

BOARD_ITEM* PCB_COLLECTOR::operator[] ( int ndx ) const

inlineoverridevirtualinherited

Overload the COLLECTOR::operator[](int) to return a BOARD_ITEM instead of an EDA_ITEM.

Parameters

ndx	The index into the list.

Returns: a board item or NULL.

Reimplemented from COLLECTOR.

Definition at line 221 of file collectors.h.

  {
  if( (unsigned)ndx < (unsigned)GetCount() )
  return (BOARD_ITEM*) m_list[ ndx ];
 
  return nullptr;
  }

References COLLECTOR::GetCount(), and COLLECTOR::m_list.

◆ Remove() [1/2]

void COLLECTOR::Remove ( int aIndex )

inlineinherited

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

Parameters

aIndex The index into the list.

Definition at line 110 of file collector.h.

  {
  m_list.erase( m_list.begin() + aIndex );
  }

References COLLECTOR::m_list.

Referenced by EDIT_TOOL::ChangeTrackWidth(), connectedItemFilter(), EDIT_TOOL::copyToClipboard(), CONVERT_TOOL::CreateLines(), CONVERT_TOOL::CreatePolys(), PCB_CONTROL::DeleteItemCursor(), ALIGN_DISTRIBUTE_TOOL::DistributeHorizontally(), ALIGN_DISTRIBUTE_TOOL::DistributeVertically(), EDIT_TOOL::Drag(), EDIT_TOOL::FilletTracks(), PCB_SELECTION_TOOL::FilterCollectorForFreePads(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), PCB_SELECTION_TOOL::FilterCollectorForMarkers(), EDIT_TOOL::FootprintFilter(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), GROUP_TOOL::Group(), BOARD_INSPECTION_TOOL::highlightNet(), EE_SELECTION_TOOL::narrowSelection(), EDIT_TOOL::PadFilter(), POSITION_RELATIVE_TOOL::PositionRelative(), CONVERT_TOOL::SegmentToArc(), GERBVIEW_SELECTION_TOOL::selectPoint(), and PCB_SELECTION_TOOL::selectPoint().

◆ Remove() [2/2]

void COLLECTOR::Remove ( const EDA_ITEM * aItem )

inlineinherited

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

Parameters

aItem the item to be removed.

Definition at line 120 of file collector.h.

  {
  alg::delete_if( m_list, [&aItem]( const EDA_ITEM* aCandidate )
  {
  return aCandidate == aItem;
  } );
  }

References alg::delete_if(), and COLLECTOR::m_list.

◆ SetRefPos()

void COLLECTOR::SetRefPos ( const wxPoint & aRefPos )

inlineinherited

Definition at line 218 of file collector.h.

218 { m_refPos = aRefPos; }

COLLECTOR::m_refPos

wxPoint m_refPos

Definition: collector.h:252

References COLLECTOR::m_refPos.

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

◆ SetScanTypes()

void COLLECTOR::SetScanTypes ( const KICAD_T * scanTypes )

inlineinherited

Record the list of KICAD_T types to consider for collection by the Inspect() function.

Parameters

scanTypes An 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.

  {
  m_scanTypes = scanTypes;
  }

References COLLECTOR::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 )

inlineinherited

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

Parameters

aIndex The index into the list.

Definition at line 152 of file collector.h.

  {
  m_backupList.push_back( m_list[aIndex] );
  m_list.erase( m_list.begin() + aIndex );
  }

References COLLECTOR::m_backupList, and COLLECTOR::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 )

inlineinherited

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

Parameters

aItem the item to be moved.

Definition at line 163 of file collector.h.

  {
  for( size_t i = 0; i < m_list.size(); i++ )
  {
  if( m_list[i] == aItem )
  {
  m_list.erase( m_list.begin() + i );
  m_backupList.push_back( aItem );
  return;
  }
  }
  }

References COLLECTOR::m_backupList, and COLLECTOR::m_list.

Member Data Documentation

◆ m_backupList

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

protectedinherited

Definition at line 248 of file collector.h.

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

◆ m_inspector

INSPECTOR_FUNC COLLECTOR::m_inspector

protectedinherited

Definition at line 251 of file collector.h.

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

◆ m_list

std::vector<EDA_ITEM*> COLLECTOR::m_list

protectedinherited

Definition at line 247 of file collector.h.

Referenced by COLLECTOR::Append(), COLLECTOR::begin(), GERBER_COLLECTOR::Collect(), GENERAL_COLLECTOR::Collect(), COLLECTOR::Combine(), COLLECTOR::CountType(), COLLECTOR::Empty(), COLLECTOR::end(), COLLECTOR::GetCount(), COLLECTOR::HasItem(), EE_COLLECTOR::IsCorner(), GERBER_COLLECTOR::operator[](), EE_COLLECTOR::operator[](), COLLECTOR::operator[](), PCB_COLLECTOR::operator[](), COLLECTOR::Remove(), and COLLECTOR::Transfer().

◆ m_MenuCancelled

bool COLLECTOR::m_MenuCancelled

inherited

Definition at line 244 of file collector.h.

Referenced by PL_SELECTION_TOOL::SelectionMenu(), EE_SELECTION_TOOL::SelectionMenu(), PL_SELECTION_TOOL::SelectPoint(), and EE_SELECTION_TOOL::selectPoint().

◆ m_MenuTitle

wxString COLLECTOR::m_MenuTitle

inherited

Definition at line 243 of file collector.h.

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), and PCB_SELECTION_TOOL::doSelectionMenu().

◆ m_refBox

EDA_RECT COLLECTOR::m_refBox

protectedinherited

Definition at line 253 of file collector.h.

Referenced by COLLECTOR::GetBoundingBox().

◆ m_refPos

wxPoint COLLECTOR::m_refPos

protectedinherited

Definition at line 252 of file collector.h.

Referenced by EE_COLLECTOR::Inspect(), GERBER_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), and COLLECTOR::SetRefPos().

◆ m_scanTypes

const KICAD_T* COLLECTOR::m_scanTypes

protectedinherited

Definition at line 250 of file collector.h.

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

◆ m_Threshold

int COLLECTOR::m_Threshold

inherited

Definition at line 241 of file collector.h.

Referenced by EE_COLLECTOR::Collect(), EE_SELECTION_TOOL::CollectHits(), SCH_EDIT_TOOL::DeleteItemCursor(), PCB_CONTROL::DeleteItemCursor(), EE_SELECTION_TOOL::GetNode(), EE_COLLECTOR::Inspect(), and EE_SELECTION_TOOL::narrowSelection().

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

Public Types

Public Member Functions

Public Attributes

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ CITER

◆ ITER

Member Function Documentation

◆ Append()

◆ begin() [1/2]

◆ begin() [2/2]

◆ Collect()

◆ Combine()

◆ CountType()

◆ Empty()

◆ end() [1/2]

◆ end() [2/2]

◆ GetBoundingBox()

◆ GetCount()

◆ HasAdditionalItems()

◆ HasItem()

◆ Inspect()

◆ operator[]()

◆ Remove() [1/2]

◆ Remove() [2/2]

◆ SetRefPos()

◆ SetScanTypes()

◆ Transfer() [1/2]

◆ Transfer() [2/2]

Member Data Documentation

◆ m_backupList

◆ m_inspector

◆ m_list

◆ m_MenuCancelled

◆ m_MenuTitle

◆ m_refBox

◆ m_refPos

◆ m_scanTypes

◆ m_Threshold