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:

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_ITEM *	operator[] (int aIndex) const
	Function operator[int] is used for read only access and returns the object at aIndex. 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_RECT &	GetBoundingBox () 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_T *	m_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 54 of file collector.h.

Member Typedef Documentation

◆ CITER

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

Definition at line 93 of file collector.h.

◆ ITER

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

Definition at line 92 of file collector.h.

Constructor & Destructor Documentation

◆ COLLECTOR()

COLLECTOR::COLLECTOR ( )

inline

Definition at line 72 of file collector.h.

                 :
             m_scanTypes( 0 ),
             // Inspect() is virtual so calling it from a class common inspector preserves
             // polymorphism.
             m_inspector( [=]( EDA_ITEM* aItem, void* aTestData )
                          {
                              return this->Inspect( aItem, aTestData );
                          } ),
             m_Threshold( 0 ),
             m_MenuCancelled( false )
     {
     }

References Inspect().

◆ ~COLLECTOR()

virtual COLLECTOR::~COLLECTOR ( )

inlinevirtual

Definition at line 85 of file collector.h.

85 {}

Member Function Documentation

◆ Append()

void COLLECTOR::Append ( EDA_ITEM * item )

inline

Function Append adds an item to the end of the list.

Parameters

item	An EDA_ITEM* to add.

Definition at line 123 of file collector.h.

     {
         m_list.push_back( item );
     }

References m_list.

Referenced by GENERAL_COLLECTOR::Collect(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), SELECTION_TOOL::doSelectionMenu(), EditToolSelectionFilter(), SELECTION_TOOL::FilterCollectorForGroups(), SELECTION_TOOL::GuessSelectionCandidates(), EE_COLLECTOR::Inspect(), GERBER_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), PCB_TYPE_COLLECTOR::Inspect(), PCB_LAYER_COLLECTOR::Inspect(), ROUTER_TOOL::NeighboringSegmentFilter(), SELECTION_TOOL::RequestSelection(), SELECTION_TOOL::selectMultiple(), PL_SELECTION_TOOL::SelectPoint(), and GERBVIEW_SELECTION_TOOL::selectPoint().

◆ begin() [1/2]

ITER COLLECTOR::begin ( )

inline

Definition at line 95 of file collector.h.

95 { return m_list.begin(); }

COLLECTOR::m_list

std::vector< EDA_ITEM * > m_list

Definition: collector.h:57

References m_list.

◆ begin() [2/2]

CITER COLLECTOR::begin ( ) const

inline

Definition at line 97 of file collector.h.

97 { return m_list.cbegin(); }

COLLECTOR::m_list

std::vector< EDA_ITEM * > m_list

Definition: collector.h:57

References m_list.

◆ Combine()

void COLLECTOR::Combine ( )

inline

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

Definition at line 165 of file collector.h.

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

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

aType type we are interested in

Returns: number of occurences

Definition at line 252 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 m_list.

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

◆ Empty()

void COLLECTOR::Empty ( )

inline

Function Empty sets the list to empty.

Definition at line 113 of file collector.h.

     {
         m_list.clear();
     }

References m_list.

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

◆ end() [1/2]

ITER COLLECTOR::end ( )

inline

Definition at line 96 of file collector.h.

96 { return m_list.end(); }

COLLECTOR::m_list

std::vector< EDA_ITEM * > m_list

Definition: collector.h:57

References m_list.

◆ end() [2/2]

CITER COLLECTOR::end ( ) const

inline

Definition at line 98 of file collector.h.

98 { return m_list.cend(); }

COLLECTOR::m_list

std::vector< EDA_ITEM * > m_list

Definition: collector.h:57

References m_list.

◆ GetBoundingBox()

const EDA_RECT& COLLECTOR::GetBoundingBox ( ) const

inline

Definition at line 244 of file collector.h.

244 { return m_refBox; }

COLLECTOR::m_refBox

EDA_RECT m_refBox

Definition: collector.h:63

References m_refBox.

◆ GetCount()

int COLLECTOR::GetCount ( ) const

inline

Function GetCount returns the number of objects in the list.

Definition at line 104 of file collector.h.

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

References m_list.

Referenced by BuildBoardPolygonOutlines(), BuildFootprintPolygonOutlines(), calcMaxArea(), EE_SELECTION_TOOL::collectHits(), connectedItemFilter(), FOOTPRINT::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(), SELECTION_TOOL::FilterCollectorForGroups(), 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(), CONVERT_TOOL::LinesToPoly(), EE_SELECTION_TOOL::Main(), DSN::SPECCTRA_DB::makeIMAGE(), EE_SELECTION_TOOL::narrowSelection(), ROUTER_TOOL::NeighboringSegmentFilter(), EE_COLLECTOR::operator[](), GERBER_COLLECTOR::operator[](), operator[](), PCB_COLLECTOR::operator[](), EDIT_TOOL::PadFilter(), SELECTION_TOOL::pickSmallestComponent(), CONVERT_TOOL::PolyToLines(), CONVERT_TOOL::SegmentToArc(), 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 157 of file collector.h.

     {
         return !m_backupList.empty();
     }

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

aItem The EDA_ITEM* to be tested.

Returns: True if aItem is already collected.

Definition at line 219 of file collector.h.

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

References m_list.

Referenced by EditToolSelectionFilter(), and SELECTION_TOOL::FilterCollectorForGroups().

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

     {
         return SEARCH_RESULT::QUIT;
     };

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

aIndex The 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 204 of file collector.h.

     {
         if( (unsigned)aIndex < (unsigned)GetCount() )  // (unsigned) excludes aIndex<0 also
             return m_list[ aIndex ];
 
         return NULL;
     }

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

aIndex The index into the list.

Definition at line 133 of file collector.h.

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

References m_list.

Referenced by connectedItemFilter(), PCBNEW_CONTROL::DeleteItemCursor(), EditToolSelectionFilter(), SELECTION_TOOL::FilterCollectorForGroups(), EDIT_TOOL::FootprintFilter(), PCB_INSPECTION_TOOL::highlightNet(), CONVERT_TOOL::LinesToPoly(), EE_SELECTION_TOOL::narrowSelection(), EDIT_TOOL::PadFilter(), CONVERT_TOOL::PolyToLines(), CONVERT_TOOL::SegmentToArc(), GERBVIEW_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

aItem the item to be removed.

Definition at line 143 of file collector.h.

     {
         m_list.erase( std::remove_if( m_list.begin(), m_list.end(),
                                       [&aItem]( const EDA_ITEM* aCandidate )
                                       {
                                           return aCandidate == aItem;
                                       } ),
                       m_list.end() );
     }

References m_list.

◆ SetRefPos()

void COLLECTOR::SetRefPos ( const wxPoint & aRefPos )

inline

Definition at line 242 of file collector.h.

242 { m_refPos = aRefPos; }

COLLECTOR::m_refPos

wxPoint m_refPos

Definition: collector.h:62

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

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

     {
         m_scanTypes = scanTypes;
     }

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

aIndex The index into the list.

Definition at line 175 of file collector.h.

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

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

aItem the item to be moved.

Definition at line 185 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 m_backupList, and m_list.

Member Data Documentation

◆ m_backupList

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

protected

Definition at line 58 of file collector.h.

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

◆ m_inspector

INSPECTOR_FUNC COLLECTOR::m_inspector

protected

Definition at line 61 of file collector.h.

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

◆ m_list

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

protected

Definition at line 57 of file collector.h.

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

◆ m_MenuCancelled

bool COLLECTOR::m_MenuCancelled

Definition at line 69 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

Definition at line 68 of file collector.h.

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

◆ m_refBox

EDA_RECT COLLECTOR::m_refBox

protected

Definition at line 63 of file collector.h.

Referenced by GetBoundingBox().

◆ m_refPos

wxPoint COLLECTOR::m_refPos

protected

Definition at line 62 of file collector.h.

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

◆ m_scanTypes

const KICAD_T* COLLECTOR::m_scanTypes

protected

Definition at line 60 of file collector.h.

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

◆ m_Threshold

int COLLECTOR::m_Threshold

Definition at line 66 of file collector.h.

Referenced by EE_SELECTION_TOOL::collectHits(), LIB_EDIT_TOOL::DeleteItemCursor(), SCH_EDIT_TOOL::DeleteItemCursor(), PCBNEW_CONTROL::DeleteItemCursor(), EE_SELECTION_TOOL::GetNode(), EE_COLLECTOR::Inspect(), and EE_SELECTION_TOOL::narrowSelection().

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

collector.h

Public Types

Public Member Functions

Public Attributes

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ CITER

◆ ITER

Constructor & Destructor Documentation

◆ COLLECTOR()

◆ ~COLLECTOR()

Member Function Documentation

◆ Append()

◆ begin() [1/2]

◆ begin() [2/2]

◆ 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