KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | List of all members
COLLECTORS_GUIDE Class Referenceabstract

An abstract base class whose derivatives may be passed to a GENERAL_COLLECTOR telling it what should be collected (aside from HitTest()ing and KICAD_T scanTypes, which are provided to the GENERAL_COLLECTOR through attributes or arguments separately). More...

#include <collectors.h>

Inheritance diagram for COLLECTORS_GUIDE:
GENERAL_COLLECTORS_GUIDE

Public Member Functions

virtual ~COLLECTORS_GUIDE ()
 
virtual bool IsLayerVisible (PCB_LAYER_ID layer) const =0
 
virtual PCB_LAYER_ID GetPreferredLayer () const =0
 
virtual bool IgnoreLockedItems () const =0
 
virtual bool IncludeSecondary () const =0
 Determine if the secondary criteria or 2nd choice items should be included.
 
virtual bool IgnoreHiddenFPText () const =0
 
virtual bool IgnoreFPTextOnBack () const =0
 
virtual bool IgnoreFPTextOnFront () const =0
 
virtual bool IgnoreFootprintsOnBack () const =0
 
virtual bool IgnoreFootprintsOnFront () const =0
 
virtual bool IgnorePadsOnBack () const =0
 
virtual bool IgnorePadsOnFront () const =0
 
virtual bool IgnoreThroughHolePads () const =0
 
virtual bool IgnorePads () const
 
virtual bool IgnoreFPValues () const =0
 
virtual bool IgnoreFPReferences () const =0
 
virtual bool IgnoreThroughVias () const =0
 
virtual bool IgnoreBlindBuriedVias () const =0
 
virtual bool IgnoreMicroVias () const =0
 
virtual bool IgnoreTracks () const =0
 
virtual bool IgnoreZoneFills () const =0
 
virtual int Accuracy () const =0
 
virtual double OnePixelInIU () const =0
 

Detailed Description

An abstract base class whose derivatives may be passed to a GENERAL_COLLECTOR telling it what should be collected (aside from HitTest()ing and KICAD_T scanTypes, which are provided to the GENERAL_COLLECTOR through attributes or arguments separately).

A justification for this class is to keep the structural storage details of the program's "configuration options" out of GENERAL_COLLECTOR::Inspect(). This class carries all the necessary details with it into the Inspect() call. The constructors or other functions of this class's derivatives are then the only place where knowledge of the specific structure of the global preference storage is needed. Thus, GENERAL_COLLECTOR::Inspect() can be kept as simple as possible, and insulated from changes in global preference storage.

This class introduces the notion of layer locking.

Definition at line 52 of file collectors.h.

Constructor & Destructor Documentation

◆ ~COLLECTORS_GUIDE()

virtual COLLECTORS_GUIDE::~COLLECTORS_GUIDE ( )
inlinevirtual

Definition at line 55 of file collectors.h.

Member Function Documentation

◆ Accuracy()

virtual int COLLECTORS_GUIDE::Accuracy ( ) const
pure virtual

Implemented in GENERAL_COLLECTORS_GUIDE.

Referenced by FOOTPRINT::CoverageRatio(), FOOTPRINT::GetCoverageArea(), and GENERAL_COLLECTOR::Inspect().

◆ GetPreferredLayer()

virtual PCB_LAYER_ID COLLECTORS_GUIDE::GetPreferredLayer ( ) const
pure virtual
Returns
the preferred layer for HitTest()ing.

Implemented in GENERAL_COLLECTORS_GUIDE.

Referenced by GENERAL_COLLECTOR::Inspect().

◆ IgnoreBlindBuriedVias()

virtual bool COLLECTORS_GUIDE::IgnoreBlindBuriedVias ( ) const
pure virtual
Returns
true if should ignore blind/buried vias

Implemented in GENERAL_COLLECTORS_GUIDE.

Referenced by GENERAL_COLLECTOR::Inspect().

◆ IgnoreFootprintsOnBack()

virtual bool COLLECTORS_GUIDE::IgnoreFootprintsOnBack ( ) const
pure virtual
Returns
true if should ignore FOOTPRINTs on Back Side.

Implemented in GENERAL_COLLECTORS_GUIDE.

Referenced by GENERAL_COLLECTOR::Inspect().

◆ IgnoreFootprintsOnFront()

virtual bool COLLECTORS_GUIDE::IgnoreFootprintsOnFront ( ) const
pure virtual
Returns
true if should ignore FOOTPRINTs on Front Side.

Implemented in GENERAL_COLLECTORS_GUIDE.

Referenced by GENERAL_COLLECTOR::Inspect().

◆ IgnoreFPReferences()

virtual bool COLLECTORS_GUIDE::IgnoreFPReferences ( ) const
pure virtual
Returns
true if should ignore footprint references.

Implemented in GENERAL_COLLECTORS_GUIDE.

Referenced by GENERAL_COLLECTOR::Inspect().

◆ IgnoreFPTextOnBack()

virtual bool COLLECTORS_GUIDE::IgnoreFPTextOnBack ( ) const
pure virtual
Returns
true if should ignore footprint text on back layers

Implemented in GENERAL_COLLECTORS_GUIDE.

Referenced by GENERAL_COLLECTOR::Inspect().

◆ IgnoreFPTextOnFront()

virtual bool COLLECTORS_GUIDE::IgnoreFPTextOnFront ( ) const
pure virtual
Returns
true if should ignore footprint text on front layers.

Implemented in GENERAL_COLLECTORS_GUIDE.

Referenced by GENERAL_COLLECTOR::Inspect().

◆ IgnoreFPValues()

virtual bool COLLECTORS_GUIDE::IgnoreFPValues ( ) const
pure virtual
Returns
true if should ignore footprint values.

Implemented in GENERAL_COLLECTORS_GUIDE.

Referenced by GENERAL_COLLECTOR::Inspect().

◆ IgnoreHiddenFPText()

virtual bool COLLECTORS_GUIDE::IgnoreHiddenFPText ( ) const
pure virtual
Returns
true if footprint texts marked as "no show" should be ignored.

Implemented in GENERAL_COLLECTORS_GUIDE.

Referenced by GENERAL_COLLECTOR::Inspect().

◆ IgnoreLockedItems()

virtual bool COLLECTORS_GUIDE::IgnoreLockedItems ( ) const
pure virtual
Returns
true if should ignore locked items, else false.

Implemented in GENERAL_COLLECTORS_GUIDE.

Referenced by GENERAL_COLLECTOR::Inspect().

◆ IgnoreMicroVias()

virtual bool COLLECTORS_GUIDE::IgnoreMicroVias ( ) const
pure virtual
Returns
true if should ignore micro vias

Implemented in GENERAL_COLLECTORS_GUIDE.

Referenced by GENERAL_COLLECTOR::Inspect().

◆ IgnorePads()

virtual bool COLLECTORS_GUIDE::IgnorePads ( ) const
inlinevirtual
Returns
true if should ignore PADSs on Front side and Back side.

Definition at line 122 of file collectors.h.

References IgnorePadsOnBack(), IgnorePadsOnFront(), and IgnoreThroughHolePads().

Referenced by GENERAL_COLLECTOR::Inspect().

◆ IgnorePadsOnBack()

virtual bool COLLECTORS_GUIDE::IgnorePadsOnBack ( ) const
pure virtual
Returns
true if should ignore Pads on Back Side.

Implemented in GENERAL_COLLECTORS_GUIDE.

Referenced by IgnorePads(), and GENERAL_COLLECTOR::Inspect().

◆ IgnorePadsOnFront()

virtual bool COLLECTORS_GUIDE::IgnorePadsOnFront ( ) const
pure virtual
Returns
true if should ignore PADSs on Front Side.

Implemented in GENERAL_COLLECTORS_GUIDE.

Referenced by IgnorePads(), and GENERAL_COLLECTOR::Inspect().

◆ IgnoreThroughHolePads()

virtual bool COLLECTORS_GUIDE::IgnoreThroughHolePads ( ) const
pure virtual
Returns
true if should ignore through-hole PADSs.

Implemented in GENERAL_COLLECTORS_GUIDE.

Referenced by IgnorePads().

◆ IgnoreThroughVias()

virtual bool COLLECTORS_GUIDE::IgnoreThroughVias ( ) const
pure virtual
Returns
true if should ignore through-hole vias

Implemented in GENERAL_COLLECTORS_GUIDE.

Referenced by GENERAL_COLLECTOR::Inspect().

◆ IgnoreTracks()

virtual bool COLLECTORS_GUIDE::IgnoreTracks ( ) const
pure virtual
Returns
true if should ignore tracks

Implemented in GENERAL_COLLECTORS_GUIDE.

Referenced by GENERAL_COLLECTOR::Inspect().

◆ IgnoreZoneFills()

virtual bool COLLECTORS_GUIDE::IgnoreZoneFills ( ) const
pure virtual
Returns
true if should ignore the interiors of zones

Implemented in GENERAL_COLLECTORS_GUIDE.

Referenced by GENERAL_COLLECTOR::Inspect().

◆ IncludeSecondary()

virtual bool COLLECTORS_GUIDE::IncludeSecondary ( ) const
pure virtual

Determine if the secondary criteria or 2nd choice items should be included.

Returns
true if should include, else false.

Implemented in GENERAL_COLLECTORS_GUIDE.

Referenced by GENERAL_COLLECTOR::Inspect().

◆ IsLayerVisible()

virtual bool COLLECTORS_GUIDE::IsLayerVisible ( PCB_LAYER_ID  layer) const
pure virtual
Returns
true if the given layer is visible, else false.

Implemented in GENERAL_COLLECTORS_GUIDE.

Referenced by GENERAL_COLLECTOR::Inspect().

◆ OnePixelInIU()

virtual double COLLECTORS_GUIDE::OnePixelInIU ( ) const
pure virtual

Implemented in GENERAL_COLLECTORS_GUIDE.

Referenced by PCB_SELECTION_TOOL::GuessSelectionCandidates().

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