KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Public Attributes | Protected Attributes | Private Attributes | List of all members
TEST_COLLECTOR Class Reference
Inheritance diagram for TEST_COLLECTOR:
COLLECTOR

Public Types

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

Public Member Functions

 TEST_COLLECTOR ()
 
INSPECT_RESULT Inspect (EDA_ITEM *aTestItem, void *aTestData) override
 
int GetInspectCalls () const
 
void SetShouldCollect (bool aShouldCollect)
 
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.
 
virtual EDA_ITEM * operator[] (int aIndex) const
 Used for read only access and returns the object at aIndex.
 
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

int m_inspectCalls
 
bool m_shouldCollect
 

Detailed Description

Definition at line 39 of file test_collector.cpp.

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

◆ TEST_COLLECTOR()

TEST_COLLECTOR::TEST_COLLECTOR ( )
inline

Definition at line 42 of file test_collector.cpp.

Member Function Documentation

◆ Append()

void COLLECTOR::Append ( EDA_ITEM *  item)
inlineinherited

Add an item to the end of the list.

Parameters
itemAn EDA_ITEM* to add.

Definition at line 101 of file collector.h.

References COLLECTOR::m_list.

Referenced by BOOST_AUTO_TEST_CASE(), GENERAL_COLLECTOR::Collect(), SCH_SELECTION_TOOL::CollectHits(), SELECTION_TOOL::doSelectionMenu(), PCB_SELECTION_TOOL::FilterCollectorForFreePads(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), SCH_SELECTION_TOOL::filterCollectorForHierarchy(), PCB_SELECTION_TOOL::FilterCollectorForTableCells(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), SCH_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), Inspect(), GERBER_COLLECTOR::Inspect(), PCB_TYPE_COLLECTOR::Inspect(), PCB_LAYER_COLLECTOR::Inspect(), ROUTER_TOOL::NeighboringSegmentFilter(), PCB_SELECTION_TOOL::RequestSelection(), SCH_SELECTION_TOOL::SelectAll(), SCH_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::SelectMultiple(), and PL_SELECTION_TOOL::SelectPoint().

◆ begin() [1/2]

ITER COLLECTOR::begin ( )
inlineinherited

Definition at line 75 of file collector.h.

References COLLECTOR::m_list.

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

◆ begin() [2/2]

CITER COLLECTOR::begin ( ) const
inlineinherited

Definition at line 77 of file collector.h.

References COLLECTOR::m_list.

◆ 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 COLLECTOR::m_backupList, and COLLECTOR::m_list.

Referenced by BOOST_AUTO_TEST_CASE(), and SELECTION_TOOL::doSelectionMenu().

◆ CountType()

int COLLECTOR::CountType ( KICAD_T  aType)
inlineinherited

Count the number of items matching aType.

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

Definition at line 223 of file collector.h.

References COLLECTOR::m_list.

Referenced by 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 COLLECTOR::m_list.

Referenced by BOOST_AUTO_TEST_CASE(), PCB_TYPE_COLLECTOR::Collect(), PCB_LAYER_COLLECTOR::Collect(), GENERAL_COLLECTOR::Collect(), GERBER_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 COLLECTOR::m_list.

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

◆ end() [2/2]

CITER COLLECTOR::end ( ) const
inlineinherited

Definition at line 78 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 83 of file collector.h.

References COLLECTOR::m_list.

Referenced by BOARD_EDITOR_CONTROL::AssignNetclass(), EDIT_TOOL::BooleanPolygons(), BOOST_AUTO_TEST_CASE(), BuildBoardPolygonOutlines(), BuildFootprintPolygonOutlines(), EDIT_TOOL::ChangeTrackLayer(), EDIT_TOOL::ChangeTrackWidth(), SCH_SELECTION_TOOL::CollectHits(), connectedItemFilter(), FOOTPRINT::CoverageRatio(), CONVERT_TOOL::CreateLines(), BOARD_INSPECTION_TOOL::DiffFootprint(), SELECTION_TOOL::doSelectionMenu(), PAD_TOOL::EnumeratePads(), EDIT_TOOL::FilletTracks(), PCB_SELECTION_TOOL::FilterCollectedItems(), SCH_SELECTION_TOOL::filterCollectedItems(), PCB_SELECTION_TOOL::FilterCollectorForFootprints(), PCB_SELECTION_TOOL::FilterCollectorForFreePads(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), SCH_SELECTION_TOOL::filterCollectorForHierarchy(), PCB_SELECTION_TOOL::FilterCollectorForMarkers(), PCB_SELECTION_TOOL::FilterCollectorForTableCells(), EDIT_TOOL::FootprintFilter(), SCH_SELECTION_TOOL::GetNode(), PANEL_SETUP_LAYERS::getNonRemovableLayers(), PANEL_SETUP_LAYERS::getRemovedLayersWithItems(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), PCB_EDIT_TABLE_TOOL::getTableCellSelection(), GENDRILL_WRITER_BASE::getUniqueLayerPairs(), PCB_GROUP_TOOL::Group(), PL_SELECTION_TOOL::guessSelectionCandidates(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), SCH_SELECTION_TOOL::GuessSelectionCandidates(), EDIT_TOOL::HealShapes(), BOARD_INSPECTION_TOOL::highlightNet(), PCB_EDIT_FRAME::inferLegacyEdgeClearance(), SCH_EDIT_TOOL::InteractiveDelete(), PCB_CONTROL::InteractiveDelete(), SCH_COLLECTOR::IsCorner(), SCH_SELECTION_TOOL::Main(), PCB_SELECTION_TOOL::Main(), DSN::SPECCTRA_DB::makeIMAGE(), EDIT_TOOL::ModifyLines(), SCH_SELECTION_TOOL::narrowSelection(), ROUTER_TOOL::NeighboringSegmentFilter(), COLLECTOR::operator[](), SCH_COLLECTOR::operator[](), GERBER_COLLECTOR::operator[](), PCB_COLLECTOR::operator[](), CONVERT_TOOL::OutsetItems(), EDIT_TOOL::PackAndMoveFootprints(), EDIT_TOOL::PadFilter(), DRAWING_TOOL::PlaceTuningPattern(), PCB_SELECTION_TOOL::pruneObscuredSelectionCandidates(), GENERATOR_TOOL::RegenerateSelected(), CONVERT_TOOL::SegmentToArc(), SCH_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::SelectMultiple(), GERBVIEW_SELECTION_TOOL::selectPoint(), PCB_TEST_SELECTION_TOOL::selectPoint(), PL_SELECTION_TOOL::SelectPoint(), PCB_SELECTION_TOOL::selectPoint(), SCH_SELECTION_TOOL::selectPoint(), EDIT_TOOL::SimplifyPolygons(), SCH_EDITOR_CONTROL::SimProbe(), SCH_EDITOR_CONTROL::SimTune(), EDIT_TOOL::Swap(), TestBoardOutlinesGraphicItems(), and PANEL_SETUP_LAYERS::TransferDataFromWindow().

◆ GetInspectCalls()

int TEST_COLLECTOR::GetInspectCalls ( ) const
inline

Definition at line 71 of file test_collector.cpp.

References m_inspectCalls.

Referenced by BOOST_AUTO_TEST_CASE().

◆ 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 COLLECTOR::m_backupList.

Referenced by 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
aItemThe EDA_ITEM* to be tested.
Returns
True if aItem is already collected.

Definition at line 197 of file collector.h.

References COLLECTOR::m_list.

Referenced by 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 TEST_COLLECTOR::Inspect ( EDA_ITEM *  aTestItem,
void *  aTestData 
)
inlineoverridevirtual

Reimplemented from COLLECTOR.

Definition at line 44 of file test_collector.cpp.

References COLLECTOR::Append(), m_inspectCalls, COLLECTOR::m_scanTypes, m_shouldCollect, and EDA_ITEM::Type().

Referenced by BOOST_AUTO_TEST_CASE().

◆ operator[]()

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

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 SCH_COLLECTOR, GERBER_COLLECTOR, and PCB_COLLECTOR.

Definition at line 183 of file collector.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
aItemthe item to be removed.

Definition at line 121 of file collector.h.

References COLLECTOR::m_list.

◆ Remove() [2/2]

void COLLECTOR::Remove ( int  aIndex)
inlineinherited

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

Parameters
aIndexThe index into the list.

Definition at line 111 of file collector.h.

References COLLECTOR::m_list.

Referenced by BOARD_EDITOR_CONTROL::AssignNetclass(), EDIT_TOOL::BooleanPolygons(), BOOST_AUTO_TEST_CASE(), connectedItemFilter(), PCB_SELECTION_TOOL::FilterCollectedItems(), SCH_SELECTION_TOOL::filterCollectedItems(), PCB_SELECTION_TOOL::FilterCollectorForFootprints(), PCB_SELECTION_TOOL::FilterCollectorForFreePads(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), SCH_SELECTION_TOOL::filterCollectorForHierarchy(), PCB_SELECTION_TOOL::FilterCollectorForMarkers(), PCB_SELECTION_TOOL::FilterCollectorForTableCells(), EDIT_TOOL::FootprintFilter(), PCB_EDIT_TABLE_TOOL::getTableCellSelection(), PCB_GROUP_TOOL::Group(), EDIT_TOOL::HealShapes(), PCB_CONTROL::InteractiveDelete(), EDIT_TOOL::ModifyLines(), SCH_SELECTION_TOOL::narrowSelection(), CONVERT_TOOL::OutsetItems(), EDIT_TOOL::PadFilter(), PCB_SELECTION_TOOL::pruneObscuredSelectionCandidates(), GENERATOR_TOOL::RegenerateSelected(), CONVERT_TOOL::SegmentToArc(), GERBVIEW_SELECTION_TOOL::selectPoint(), PCB_SELECTION_TOOL::selectPoint(), and EDIT_TOOL::SimplifyPolygons().

◆ SetRefPos()

void COLLECTOR::SetRefPos ( const VECTOR2I &  aRefPos)
inlineinherited

Definition at line 215 of file collector.h.

References COLLECTOR::m_refPos.

Referenced by BOOST_AUTO_TEST_CASE(), GENERAL_COLLECTOR::Collect(), GERBER_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
aScanTypesA list of KICAD_Ts.

Definition at line 213 of file collector.h.

References COLLECTOR::m_scanTypes.

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

◆ SetShouldCollect()

void TEST_COLLECTOR::SetShouldCollect ( bool  aShouldCollect)
inline

Definition at line 72 of file test_collector.cpp.

References m_shouldCollect.

◆ Transfer() [1/2]

void COLLECTOR::Transfer ( EDA_ITEM *  aItem)
inlineinherited

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

Parameters
aItemthe item to be moved.

Definition at line 164 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
aIndexThe index into the list.

Definition at line 153 of file collector.h.

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

Referenced by BOOST_AUTO_TEST_CASE(), PL_SELECTION_TOOL::guessSelectionCandidates(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), and SCH_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 COLLECTOR::Combine(), COLLECTOR::HasAdditionalItems(), and COLLECTOR::Transfer().

◆ m_inspectCalls

int TEST_COLLECTOR::m_inspectCalls
private

Definition at line 75 of file test_collector.cpp.

Referenced by GetInspectCalls(), and Inspect().

◆ m_inspector

INSPECTOR_FUNC COLLECTOR::m_inspector
protectedinherited

Definition at line 246 of file collector.h.

Referenced by PCB_TYPE_COLLECTOR::Collect(), PCB_LAYER_COLLECTOR::Collect(), GENERAL_COLLECTOR::Collect(), GERBER_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 COLLECTOR::Append(), COLLECTOR::begin(), COLLECTOR::Combine(), COLLECTOR::CountType(), COLLECTOR::Empty(), COLLECTOR::end(), COLLECTOR::GetCount(), COLLECTOR::HasItem(), SCH_COLLECTOR::IsCorner(), COLLECTOR::operator[](), SCH_COLLECTOR::operator[](), GERBER_COLLECTOR::operator[](), PCB_COLLECTOR::operator[](), COLLECTOR::Remove(), and COLLECTOR::Transfer().

◆ m_MenuCancelled

bool COLLECTOR::m_MenuCancelled
inherited

Definition at line 239 of file collector.h.

Referenced by BOOST_AUTO_TEST_CASE(), SELECTION_TOOL::SelectionMenu(), GERBVIEW_SELECTION_TOOL::selectPoint(), PL_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 SCH_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), GERBER_COLLECTOR::Inspect(), and COLLECTOR::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(), Inspect(), and COLLECTOR::SetScanTypes().

◆ m_shouldCollect

bool TEST_COLLECTOR::m_shouldCollect
private

Definition at line 76 of file test_collector.cpp.

Referenced by Inspect(), and SetShouldCollect().

◆ 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(), SCH_SELECTION_TOOL::GetNode(), SCH_SELECTION_TOOL::GuessSelectionCandidates(), SCH_COLLECTOR::Inspect(), SCH_EDIT_TOOL::InteractiveDelete(), 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 file: