KiCad PCB EDA Suite
COLLECTORS_GUIDE Class Referenceabstract

Class COLLECTORS_GUIDE is an abstract base class whose derivatives may be passed to a GENERAL_COLLECTOR, telling GENERAL_COLLECTOR what should be collected (aside from HitTest()ing and KICAD_T scanTypes[], information 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 IsLayerLocked (PCB_LAYER_ID layer) const =0
 Function IsLayerLocked. More...
 
virtual bool IsLayerVisible (PCB_LAYER_ID layer) const =0
 Function IsLayerVisible. More...
 
virtual bool IgnoreLockedLayers () const =0
 Function IgnoreLockedLayers. More...
 
virtual bool IgnoreNonVisibleLayers () const =0
 Function IgnoredNonVisibleLayers. More...
 
virtual PCB_LAYER_ID GetPreferredLayer () const =0
 Function GetPreferredLayer. More...
 
virtual bool IgnorePreferredLayer () const =0
 Function IgnorePreferredLayer provides wildcard behavior regarding the preferred layer. More...
 
virtual bool IgnoreLockedItems () const =0
 Function IgnoreLockedItems. More...
 
virtual bool IncludeSecondary () const =0
 Function IncludeSecondary determines if the secondary criteria, or 2nd choice items should be included. More...
 
virtual bool IgnoreMTextsMarkedNoShow () const =0
 Function IgnoreMTextsMarkedNoShow. More...
 
virtual bool IgnoreMTextsOnBack () const =0
 Function IgnoreZones. More...
 
virtual bool IgnoreMTextsOnFront () const =0
 Function IgnoreMTextsOnFront. More...
 
virtual bool IgnoreModulesOnBack () const =0
 Function IgnoreModulesOnBack. More...
 
virtual bool IgnoreModulesOnFront () const =0
 Function IgnoreModulesOnFront. More...
 
virtual bool IgnorePadsOnBack () const =0
 Function IgnorePadsOnBack. More...
 
virtual bool IgnorePadsOnFront () const =0
 Function IgnorePadsOnFront. More...
 
virtual bool IgnorePads () const
 Function IgnorePads. More...
 
virtual bool IgnoreModulesVals () const =0
 Function IgnoreModulesVals. More...
 
virtual bool IgnoreModulesRefs () const =0
 Function IgnoreModulesRefs. More...
 

Detailed Description

Class COLLECTORS_GUIDE is an abstract base class whose derivatives may be passed to a GENERAL_COLLECTOR, telling GENERAL_COLLECTOR what should be collected (aside from HitTest()ing and KICAD_T scanTypes[], information 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 "global preferences" or "configuration options" out of GENERAL_COLLECTOR::Inspect(). This class carries all the necessary details in with it to 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 (and even then it is not simple enough).

This class introduces the notion of layer locking.

Definition at line 64 of file collectors.h.

Constructor & Destructor Documentation

virtual COLLECTORS_GUIDE::~COLLECTORS_GUIDE ( )
inlinevirtual

Definition at line 68 of file collectors.h.

68 {}

Member Function Documentation

virtual PCB_LAYER_ID COLLECTORS_GUIDE::GetPreferredLayer ( ) const
pure virtual

Function GetPreferredLayer.

Returns
int - the preferred layer for HitTest()ing.

Implemented in GENERAL_COLLECTORS_GUIDE.

Referenced by GENERAL_COLLECTOR::Inspect().

virtual bool COLLECTORS_GUIDE::IgnoreLockedItems ( ) const
pure virtual

Function IgnoreLockedItems.

Returns
bool - true if should ignore locked items, else false.

Implemented in GENERAL_COLLECTORS_GUIDE.

Referenced by GENERAL_COLLECTOR::Inspect().

virtual bool COLLECTORS_GUIDE::IgnoreLockedLayers ( ) const
pure virtual

Function IgnoreLockedLayers.

Returns
bool - true if should ignore locked layers, else false.

Implemented in GENERAL_COLLECTORS_GUIDE.

Referenced by GENERAL_COLLECTOR::Inspect().

virtual bool COLLECTORS_GUIDE::IgnoreModulesOnBack ( ) const
pure virtual

Function IgnoreModulesOnBack.

Returns
bool - true if should ignore MODULEs on Back Side.

Implemented in GENERAL_COLLECTORS_GUIDE.

Referenced by GENERAL_COLLECTOR::Inspect().

virtual bool COLLECTORS_GUIDE::IgnoreModulesOnFront ( ) const
pure virtual

Function IgnoreModulesOnFront.

Returns
bool - ture if should ignore MODULEs on Front Side.

Implemented in GENERAL_COLLECTORS_GUIDE.

Referenced by GENERAL_COLLECTOR::Inspect().

virtual bool COLLECTORS_GUIDE::IgnoreModulesRefs ( ) const
pure virtual

Function IgnoreModulesRefs.

Returns
bool - true if should ignore module references.

Implemented in GENERAL_COLLECTORS_GUIDE.

Referenced by GENERAL_COLLECTOR::Inspect().

virtual bool COLLECTORS_GUIDE::IgnoreModulesVals ( ) const
pure virtual

Function IgnoreModulesVals.

Returns
bool - true if should ignore modules values.

Implemented in GENERAL_COLLECTORS_GUIDE.

Referenced by GENERAL_COLLECTOR::Inspect().

virtual bool COLLECTORS_GUIDE::IgnoreMTextsMarkedNoShow ( ) const
pure virtual

Function IgnoreMTextsMarkedNoShow.

Returns
bool - true if MTexts marked as "no show" should be ignored.

Implemented in GENERAL_COLLECTORS_GUIDE.

Referenced by GENERAL_COLLECTOR::Inspect().

virtual bool COLLECTORS_GUIDE::IgnoreMTextsOnBack ( ) const
pure virtual

Function IgnoreZones.

Returns
bool - true if should ignore zones. virtual bool IgnoreZones() const = 0; can simply omit from scanTypes[] PCB_ZONE_T Function IgnoreMTextsOnBack
bool - true if should ignore MTexts on back layers

Implemented in GENERAL_COLLECTORS_GUIDE.

Referenced by GENERAL_COLLECTOR::Inspect().

virtual bool COLLECTORS_GUIDE::IgnoreMTextsOnFront ( ) const
pure virtual

Function IgnoreMTextsOnFront.

Returns
bool - true if should ignore MTexts on front layers.

Implemented in GENERAL_COLLECTORS_GUIDE.

Referenced by GENERAL_COLLECTOR::Inspect().

virtual bool COLLECTORS_GUIDE::IgnoreNonVisibleLayers ( ) const
pure virtual

Function IgnoredNonVisibleLayers.

Returns
bool - true if should ignore non-visible layers, else false.

Implemented in GENERAL_COLLECTORS_GUIDE.

Referenced by GENERAL_COLLECTOR::Inspect().

virtual bool COLLECTORS_GUIDE::IgnorePads ( ) const
inlinevirtual

Function IgnorePads.

Returns
bool - true if should ignore PADSs on Front side and Back side.

Definition at line 173 of file collectors.h.

References IgnorePadsOnBack(), and IgnorePadsOnFront().

Referenced by GENERAL_COLLECTOR::Inspect().

174  {
175  return IgnorePadsOnFront() && IgnorePadsOnBack();
176  }
virtual bool IgnorePadsOnFront() const =0
Function IgnorePadsOnFront.
virtual bool IgnorePadsOnBack() const =0
Function IgnorePadsOnBack.
virtual bool COLLECTORS_GUIDE::IgnorePadsOnBack ( ) const
pure virtual

Function IgnorePadsOnBack.

Returns
bool - true if should ignore Pads on Back Side.

Implemented in GENERAL_COLLECTORS_GUIDE.

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

virtual bool COLLECTORS_GUIDE::IgnorePadsOnFront ( ) const
pure virtual

Function IgnorePadsOnFront.

Returns
bool - ture if should ignore PADSs on Front Side.

Implemented in GENERAL_COLLECTORS_GUIDE.

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

virtual bool COLLECTORS_GUIDE::IgnorePreferredLayer ( ) const
pure virtual

Function IgnorePreferredLayer provides wildcard behavior regarding the preferred layer.

Returns
bool - true if should ignore preferred layer, else false.

Implemented in GENERAL_COLLECTORS_GUIDE.

Referenced by GENERAL_COLLECTOR::Inspect().

virtual bool COLLECTORS_GUIDE::IncludeSecondary ( ) const
pure virtual

Function IncludeSecondary determines if the secondary criteria, or 2nd choice items should be included.

Returns
bool - true if should include, else false.

Implemented in GENERAL_COLLECTORS_GUIDE.

Referenced by GENERAL_COLLECTOR::Inspect().

virtual bool COLLECTORS_GUIDE::IsLayerLocked ( PCB_LAYER_ID  layer) const
pure virtual

Function IsLayerLocked.

Returns
bool - true if the given layer is locked, else false.

Implemented in GENERAL_COLLECTORS_GUIDE.

Referenced by GENERAL_COLLECTOR::Inspect().

virtual bool COLLECTORS_GUIDE::IsLayerVisible ( PCB_LAYER_ID  layer) const
pure virtual

Function IsLayerVisible.

Returns
bool - true if the given layer is visible, else false.

Implemented in GENERAL_COLLECTORS_GUIDE.

Referenced by GENERAL_COLLECTOR::Inspect().


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