Collect all BOARD_ITEM objects on a given layer. More...

#include <collectors.h>

Inheritance diagram for PCB_LAYER_COLLECTOR:

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

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

Public Member Functions
	PCB_LAYER_COLLECTOR (PCB_LAYER_ID aLayerId=UNDEFINED_LAYER)

void	SetLayerId (PCB_LAYER_ID aLayerId)

INSPECT_RESULT	Inspect (EDA_ITEM testItem, void testData) override
	The examining function within the INSPECTOR which is passed to the iterate function.

void	Collect (BOARD_ITEM *aBoard, const std::vector< KICAD_T > &aTypes)
	Test a BOARD_ITEM using this class's Inspector method, which does the collection.

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

ITER	begin ()

CITER	begin () const

ITER	end ()

CITER	end () const

int	GetCount () const
	Return the number of objects in the list.

void	Empty ()
	Clear the list.

void	Append (EDA_ITEM *item)
	Add an item to the end of the list.

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

void	Remove (const EDA_ITEM *aItem)
	Remove the item aItem (if exists in the collector).

bool	HasAdditionalItems ()
	Test if the collector has heuristic backup items.

void	Combine ()
	Re-combine the backup list into the main list of the collector.

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

void	Transfer (EDA_ITEM *aItem)
	Move aItem (if exists in the collector) to the backup list.

bool	HasItem (const EDA_ITEM *aItem) const
	Tests if aItem has already been collected.

void	SetScanTypes (const std::vector< KICAD_T > &aTypes)
	Record the list of KICAD_T types to consider for collection by the Inspect() function.

void	SetRefPos (const VECTOR2I &aRefPos)

int	CountType (KICAD_T aType)
	Count the number of items matching aType.

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

std::vector< KICAD_T >	m_scanTypes

INSPECTOR_FUNC	m_inspector

VECTOR2I	m_refPos

Private Attributes
PCB_LAYER_ID	m_layer_id

Detailed Description

Collect all BOARD_ITEM objects on a given layer.

This only uses the primary object layer for comparison.

Definition at line 538 of file collectors.h.

Member Typedef Documentation

◆ CITER

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

inherited

Definition at line 71 of file collector.h.

◆ ITER

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

inherited

Definition at line 70 of file collector.h.

Constructor & Destructor Documentation

◆ PCB_LAYER_COLLECTOR()

PCB_LAYER_COLLECTOR::PCB_LAYER_COLLECTOR ( PCB_LAYER_ID aLayerId = UNDEFINED_LAYER )

inline

Definition at line 541 of file collectors.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 99 of file collector.h.

References COLLECTOR::m_list.

Referenced by GENERAL_COLLECTOR::Collect(), EE_SELECTION_TOOL::CollectHits(), SELECTION_TOOL::doSelectionMenu(), PCB_SELECTION_TOOL::FilterCollectorForFreePads(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), PCB_SELECTION_TOOL::FilterCollectorForTableCells(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), EE_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), GERBER_COLLECTOR::Inspect(), PCB_TYPE_COLLECTOR::Inspect(), Inspect(), ROUTER_TOOL::NeighboringSegmentFilter(), PCB_SELECTION_TOOL::RequestSelection(), PCB_SELECTION_TOOL::SelectAll(), PCB_SELECTION_TOOL::selectMultiple(), and PL_SELECTION_TOOL::SelectPoint().

◆ begin() [1/2]

ITER COLLECTOR::begin ( )

inlineinherited

Definition at line 73 of file collector.h.

References COLLECTOR::m_list.

◆ begin() [2/2]

CITER COLLECTOR::begin ( ) const

inlineinherited

Definition at line 75 of file collector.h.

References COLLECTOR::m_list.

◆ Collect()

void PCB_LAYER_COLLECTOR::Collect	(	BOARD_ITEM *	aBoard,
		const std::vector< KICAD_T > &	aTypes
	)

Test a BOARD_ITEM using this class's Inspector method, which does the collection.

Parameters

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

Definition at line 536 of file collectors.cpp.

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

Referenced by PANEL_SETUP_LAYERS::getNonRemovableLayers(), PANEL_SETUP_LAYERS::getRemovedLayersWithItems(), PCB_EDIT_FRAME::inferLegacyEdgeClearance(), and PANEL_SETUP_LAYERS::TransferDataFromWindow().

◆ Combine()

void COLLECTOR::Combine ( )

inlineinherited

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

Definition at line 140 of file collector.h.

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

Referenced by 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 221 of file collector.h.

References COLLECTOR::m_list.

Referenced by ROUTER_TOOL::NeighboringSegmentFilter().

◆ Empty()

void COLLECTOR::Empty ( )

inlineinherited

Clear the list.

Definition at line 89 of file collector.h.

References COLLECTOR::m_list.

Referenced by PCB_TYPE_COLLECTOR::Collect(), Collect(), GENERAL_COLLECTOR::Collect(), GERBER_COLLECTOR::Collect(), EE_COLLECTOR::Collect(), SELECTION_TOOL::doSelectionMenu(), PAD_TOOL::EnumeratePads(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), and ROUTER_TOOL::NeighboringSegmentFilter().

◆ end() [1/2]

ITER COLLECTOR::end ( )

inlineinherited

Definition at line 74 of file collector.h.

References COLLECTOR::m_list.

◆ end() [2/2]

CITER COLLECTOR::end ( ) const

inlineinherited

Definition at line 76 of file collector.h.

References COLLECTOR::m_list.

◆ GetCount()

int COLLECTOR::GetCount ( ) const

inlineinherited

Return the number of objects in the list.

Definition at line 81 of file collector.h.

References COLLECTOR::m_list.

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

References COLLECTOR::m_backupList.

Referenced by 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 195 of file collector.h.

References COLLECTOR::m_list.

Referenced by EE_SELECTION_TOOL::CollectHits(), PCB_SELECTION_TOOL::FilterCollectorForFreePads(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), and PCB_SELECTION_TOOL::FilterCollectorForTableCells().

◆ Inspect()

INSPECT_RESULT PCB_LAYER_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 525 of file collectors.cpp.

References COLLECTOR::Append(), BOARD_ITEM::IsOnLayer(), and m_layer_id.

◆ 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 183 of file collectors.h.

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

◆ Remove() [1/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 119 of file collector.h.

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

◆ Remove() [2/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 109 of file collector.h.

References COLLECTOR::m_list.

◆ SetLayerId()

void PCB_LAYER_COLLECTOR::SetLayerId ( PCB_LAYER_ID aLayerId )

inline

Definition at line 545 of file collectors.h.

References m_layer_id.

Referenced by PANEL_SETUP_LAYERS::getNonRemovableLayers(), PANEL_SETUP_LAYERS::getRemovedLayersWithItems(), PCB_EDIT_FRAME::inferLegacyEdgeClearance(), and PANEL_SETUP_LAYERS::TransferDataFromWindow().

◆ SetRefPos()

void COLLECTOR::SetRefPos ( const VECTOR2I & aRefPos )

inlineinherited

Definition at line 213 of file collector.h.

References COLLECTOR::m_refPos.

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

◆ SetScanTypes()

void COLLECTOR::SetScanTypes ( const std::vector< KICAD_T > & aTypes )

inlineinherited

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

Parameters

aScanTypes A list of KICAD_Ts.

Definition at line 211 of file collector.h.

References COLLECTOR::m_scanTypes.

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

◆ Transfer() [1/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 162 of file collector.h.

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

◆ Transfer() [2/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 151 of file collector.h.

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

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

Member Data Documentation

◆ m_backupList

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

protectedinherited

Definition at line 241 of file collector.h.

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

◆ m_inspector

INSPECTOR_FUNC COLLECTOR::m_inspector

protectedinherited

Definition at line 244 of file collector.h.

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

◆ m_layer_id

PCB_LAYER_ID PCB_LAYER_COLLECTOR::m_layer_id

private

Definition at line 565 of file collectors.h.

Referenced by Inspect(), and SetLayerId().

◆ m_list

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

protectedinherited

Definition at line 240 of file collector.h.

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

◆ m_MenuCancelled

bool COLLECTOR::m_MenuCancelled

inherited

Definition at line 237 of file collector.h.

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

◆ m_MenuTitle

wxString COLLECTOR::m_MenuTitle

inherited

Definition at line 236 of file collector.h.

Referenced by SELECTION_TOOL::doSelectionMenu().

◆ m_refPos

VECTOR2I COLLECTOR::m_refPos

protectedinherited

Definition at line 246 of file collector.h.

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

◆ m_scanTypes

std::vector<KICAD_T> COLLECTOR::m_scanTypes

protectedinherited

Definition at line 243 of file collector.h.

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

◆ m_Threshold

int COLLECTOR::m_Threshold

inherited

Definition at line 234 of file collector.h.

Referenced by EE_COLLECTOR::Collect(), EE_SELECTION_TOOL::CollectHits(), EE_SELECTION_TOOL::GetNode(), EE_SELECTION_TOOL::GuessSelectionCandidates(), EE_COLLECTOR::Inspect(), SCH_EDIT_TOOL::InteractiveDelete(), PCB_CONTROL::InteractiveDelete(), DRAWING_TOOL::PlaceTuningPattern(), EE_SELECTION_TOOL::selectPoint(), SCH_EDITOR_CONTROL::SimProbe(), and SCH_EDITOR_CONTROL::SimTune().

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

Public Types

Public Member Functions

Public Attributes

Protected Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

◆ CITER

◆ ITER

Constructor & Destructor Documentation

◆ PCB_LAYER_COLLECTOR()

Member Function Documentation

◆ Append()

◆ begin() [1/2]

◆ begin() [2/2]

◆ Collect()

◆ Combine()

◆ CountType()

◆ Empty()

◆ end() [1/2]

◆ end() [2/2]

◆ GetCount()

◆ HasAdditionalItems()

◆ HasItem()

◆ Inspect()

◆ operator[]()

◆ Remove() [1/2]

◆ Remove() [2/2]

◆ SetLayerId()

◆ SetRefPos()

◆ SetScanTypes()

◆ Transfer() [1/2]

◆ Transfer() [2/2]

Member Data Documentation

◆ m_backupList

◆ m_inspector

◆ m_layer_id

◆ m_list

◆ m_MenuCancelled

◆ m_MenuTitle

◆ m_refPos

◆ m_scanTypes

◆ m_Threshold