Use when the right click button is pressed or when the select tool is in effect. More...

#include <gerber_collectors.h>

Inheritance diagram for GERBER_COLLECTOR:

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

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

Public Member Functions
	GERBER_COLLECTOR ()

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

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

void	Collect (EDA_ITEM *aItem, const std::vector< KICAD_T > &aScanTypes, const VECTOR2I &aRefPos)
	Scan an EDA_ITEM using this class's Inspector method, which does the collection.

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

Detailed Description

Use when the right click button is pressed or when the select tool is in effect.

Definition at line 28 of file gerber_collectors.h.

Member Typedef Documentation

◆ CITER

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

inherited

Definition at line 73 of file collector.h.

◆ ITER

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

inherited

Definition at line 72 of file collector.h.

Constructor & Destructor Documentation

◆ GERBER_COLLECTOR()

GERBER_COLLECTOR::GERBER_COLLECTOR ( )

inline

Definition at line 31 of file gerber_collectors.h.

References GERBER_DRAW_ITEM_T, GERBER_IMAGE_T, GERBER_LAYOUT_T, and COLLECTOR::SetScanTypes().

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

References m_list.

◆ begin() [1/2]

ITER COLLECTOR::begin ( )

inlineinherited

Definition at line 75 of file collector.h.

References m_list.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), PCB_SELECTION_TOOL::SelectMultiple(), and SCH_SELECTION_TOOL::SelectMultiple().

◆ begin() [2/2]

CITER COLLECTOR::begin ( ) const

inlineinherited

Definition at line 77 of file collector.h.

References m_list.

◆ Collect()

void GERBER_COLLECTOR::Collect	(	EDA_ITEM *	aItem,
		const std::vector< KICAD_T > &	aScanTypes,
		const VECTOR2I &	aRefPos )

Scan an EDA_ITEM using this class's Inspector method, which does the collection.

Parameters

aItem	An EDA_ITEM to scan
aScanTypes	A list of KICAD_Ts that specs what is to be collected and the priority order of the resultant collection in "m_list".
aRefPos	A VECTOR2I to use in hit-testing.

Definition at line 39 of file gerber_collectors.cpp.

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

Referenced by GERBVIEW_SELECTION_TOOL::selectPoint().

◆ Combine()

void COLLECTOR::Combine ( )

inlineinherited

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

Definition at line 142 of file collector.h.

References m_backupList, and m_list.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and 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 223 of file collector.h.

References m_list.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and ROUTER_TOOL::NeighboringSegmentFilter().

◆ Empty()

void COLLECTOR::Empty ( )

inlineinherited

Clear the list.

Definition at line 91 of file collector.h.

References m_list.

Referenced by BOOST_AUTO_TEST_CASE(), GENERAL_COLLECTOR::Collect(), GERBER_COLLECTOR::Collect(), PCB_LAYER_COLLECTOR::Collect(), PCB_TYPE_COLLECTOR::Collect(), SCH_COLLECTOR::Collect(), SCH_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 76 of file collector.h.

References m_list.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), PCB_SELECTION_TOOL::SelectMultiple(), and SCH_SELECTION_TOOL::SelectMultiple().

◆ end() [2/2]

CITER COLLECTOR::end ( ) const

inlineinherited

Definition at line 78 of file collector.h.

References m_list.

◆ GetCount()

int COLLECTOR::GetCount ( ) const

inlineinherited

Return the number of objects in the list.

Definition at line 83 of file collector.h.

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

References m_backupList.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and 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 197 of file collector.h.

References m_list.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), SCH_SELECTION_TOOL::CollectHits(), PCB_SELECTION_TOOL::FilterCollectorForFreePads(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), SCH_SELECTION_TOOL::filterCollectorForHierarchy(), and PCB_SELECTION_TOOL::FilterCollectorForTableCells().

◆ Inspect()

INSPECT_RESULT GERBER_COLLECTOR::Inspect	(	EDA_ITEM *	testItem,
		void *	testData )

overridevirtual

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

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.

Parameters

testItem	is an EDA_ITEM to examine.
testData	is not used here.

Returns: SEARCH_QUIT if the iterator is to stop the scan, else SCAN_CONTINUE.

Reimplemented from COLLECTOR.

Definition at line 30 of file gerber_collectors.cpp.

References COLLECTOR::Append(), CONTINUE, EDA_ITEM::HitTest(), and COLLECTOR::m_refPos.

◆ operator[]()

EDA_ITEM * GERBER_COLLECTOR::operator[] ( int ndx ) const

inlineoverridevirtual

Overload the [](int) operator to return a EDA_ITEM* instead of an EDA_ITEM* type.

Parameters

ndx	The index into the list.

Returns: the item collected or NULL.

Reimplemented from COLLECTOR.

Definition at line 42 of file gerber_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 121 of file collector.h.

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

References m_list.

◆ SetRefPos()

void COLLECTOR::SetRefPos ( const VECTOR2I & aRefPos )

inlineinherited

Definition at line 215 of file collector.h.

References m_refPos.

Referenced by BOOST_AUTO_TEST_CASE(), GENERAL_COLLECTOR::Collect(), GERBER_COLLECTOR::Collect(), SCH_COLLECTOR::Collect(), and SCH_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 213 of file collector.h.

References m_scanTypes.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), GENERAL_COLLECTOR::Collect(), GERBER_COLLECTOR::Collect(), SCH_COLLECTOR::Collect(), SCH_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 164 of file collector.h.

References m_backupList, and 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 153 of file collector.h.

References m_backupList, and m_list.

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

Member Data Documentation

◆ m_backupList

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

protectedinherited

Definition at line 243 of file collector.h.

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

◆ m_inspector

INSPECTOR_FUNC COLLECTOR::m_inspector

protectedinherited

Definition at line 246 of file collector.h.

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

◆ m_list

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

protectedinherited

Definition at line 242 of file collector.h.

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

◆ m_MenuCancelled

bool COLLECTOR::m_MenuCancelled

inherited

Definition at line 239 of file collector.h.

Referenced by BOOST_AUTO_TEST_CASE(), COLLECTOR(), SELECTION_TOOL::SelectionMenu(), PL_SELECTION_TOOL::SelectPoint(), GERBVIEW_SELECTION_TOOL::selectPoint(), and SCH_SELECTION_TOOL::selectPoint().

◆ m_MenuTitle

wxString COLLECTOR::m_MenuTitle

inherited

Definition at line 238 of file collector.h.

Referenced by SELECTION_TOOL::doSelectionMenu().

◆ m_refPos

VECTOR2I COLLECTOR::m_refPos

protectedinherited

Definition at line 248 of file collector.h.

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

◆ m_scanTypes

std::vector<KICAD_T> COLLECTOR::m_scanTypes

protectedinherited

Definition at line 245 of file collector.h.

Referenced by GENERAL_COLLECTOR::Collect(), GERBER_COLLECTOR::Collect(), SCH_COLLECTOR::Collect(), SCH_COLLECTOR::Collect(), COLLECTOR(), TEST_COLLECTOR::Inspect(), and SetScanTypes().

◆ m_Threshold

int COLLECTOR::m_Threshold

inherited

Definition at line 236 of file collector.h.

Referenced by BOOST_AUTO_TEST_CASE(), SCH_COLLECTOR::Collect(), SCH_SELECTION_TOOL::CollectHits(), COLLECTOR(), SCH_SELECTION_TOOL::GetNode(), SCH_SELECTION_TOOL::GuessSelectionCandidates(), SCH_COLLECTOR::Inspect(), PCB_CONTROL::InteractiveDelete(), DRAWING_TOOL::PlaceTuningPattern(), SCH_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

Detailed Description

Member Typedef Documentation

◆ CITER

◆ ITER

Constructor & Destructor Documentation

◆ GERBER_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]

◆ SetRefPos()

◆ SetScanTypes()

◆ Transfer() [1/2]

◆ Transfer() [2/2]

Member Data Documentation

◆ m_backupList

◆ m_inspector

◆ m_list

◆ m_MenuCancelled

◆ m_MenuTitle

◆ m_refPos

◆ m_scanTypes

◆ m_Threshold