KiCad PCB EDA Suite
GENERAL_COLLECTORS_GUIDE Class Reference

A general implementation of a COLLECTORS_GUIDE. More...

#include <collectors.h>

Inheritance diagram for GENERAL_COLLECTORS_GUIDE:
COLLECTORS_GUIDE

Public Member Functions

 GENERAL_COLLECTORS_GUIDE (LSET aVisibleLayerMask, PCB_LAYER_ID aPreferredLayer)
 Grab stuff from global preferences and uses reasonable defaults. More...
 
bool IsLayerLocked (PCB_LAYER_ID aLayerId) const override
 
void SetLayerLocked (PCB_LAYER_ID aLayerId, bool isLocked)
 
bool IsLayerVisible (PCB_LAYER_ID aLayerId) const override
 
void SetLayerVisible (PCB_LAYER_ID aLayerId, bool isVisible)
 
void SetLayerVisibleBits (LSET aLayerBits)
 
bool IgnoreLockedLayers () const override
 
void SetIgnoreLockedLayers (bool ignore)
 
bool IgnoreNonVisibleLayers () const override
 
void SetIgnoreNonVisibleLayers (bool ignore)
 
PCB_LAYER_ID GetPreferredLayer () const override
 
void SetPreferredLayer (PCB_LAYER_ID aLayer)
 
bool IgnorePreferredLayer () const override
 Provide wildcard behavior regarding the preferred layer. More...
 
void SetIgnorePreferredLayer (bool ignore)
 
bool IgnoreLockedItems () const override
 
void SetIgnoreLockedItems (bool ignore)
 
bool IncludeSecondary () const override
 Determine if the secondary criteria, or 2nd choice items should be included. More...
 
void SetIncludeSecondary (bool include)
 
bool IgnoreMTextsMarkedNoShow () const override
 
void SetIgnoreMTextsMarkedNoShow (bool ignore)
 
bool IgnoreMTextsOnBack () const override
 
void SetIgnoreMTextsOnBack (bool ignore)
 
bool IgnoreMTextsOnFront () const override
 
void SetIgnoreMTextsOnFront (bool ignore)
 
bool IgnoreModulesOnBack () const override
 
void SetIgnoreModulesOnBack (bool ignore)
 
bool IgnoreModulesOnFront () const override
 
void SetIgnoreModulesOnFront (bool ignore)
 
bool IgnorePadsOnBack () const override
 
void SetIgnorePadsOnBack (bool ignore)
 
bool IgnorePadsOnFront () const override
 
void SetIgnorePadsOnFront (bool ignore)
 
bool IgnoreThroughHolePads () const override
 
void SetIgnoreThroughHolePads (bool ignore)
 
bool IgnoreModulesVals () const override
 
void SetIgnoreModulesVals (bool ignore)
 
bool IgnoreModulesRefs () const override
 
void SetIgnoreModulesRefs (bool ignore)
 
bool IgnoreThroughVias () const override
 
void SetIgnoreThroughVias (bool ignore)
 
bool IgnoreBlindBuriedVias () const override
 
void SetIgnoreBlindBuriedVias (bool ignore)
 
bool IgnoreMicroVias () const override
 
void SetIgnoreMicroVias (bool ignore)
 
bool IgnoreTracks () const override
 
void SetIgnoreTracks (bool ignore)
 
bool IgnoreZoneFills () const override
 
void SetIgnoreZoneFills (bool ignore)
 
virtual bool IgnorePads () const
 

Private Attributes

PCB_LAYER_ID m_PreferredLayer
 
bool m_IgnorePreferredLayer
 
LSET m_LayerLocked
 bit-mapped layer locked bits More...
 
bool m_IgnoreLockedLayers
 
LSET m_LayerVisible
 bit-mapped layer visible bits More...
 
bool m_IgnoreNonVisibleLayers
 
bool m_IgnoreLockedItems
 
bool m_IncludeSecondary
 
bool m_IgnoreMTextsMarkedNoShow
 
bool m_IgnoreMTextsOnBack
 
bool m_IgnoreMTextsOnFront
 
bool m_IgnoreModulesOnBack
 
bool m_IgnoreModulesOnFront
 
bool m_IgnorePadsOnFront
 
bool m_IgnorePadsOnBack
 
bool m_IgnoreThroughHolePads
 
bool m_IgnoreModulesVals
 
bool m_IgnoreModulesRefs
 
bool m_IgnoreThroughVias
 
bool m_IgnoreBlindBuriedVias
 
bool m_IgnoreMicroVias
 
bool m_IgnoreTracks
 
bool m_IgnoreZoneFills
 

Detailed Description

A general implementation of a COLLECTORS_GUIDE.

One of its constructors is entitled to grab information from the program's global preferences.

Definition at line 386 of file collectors.h.

Constructor & Destructor Documentation

GENERAL_COLLECTORS_GUIDE::GENERAL_COLLECTORS_GUIDE ( LSET  aVisibleLayerMask,
PCB_LAYER_ID  aPreferredLayer 
)
inline

Grab stuff from global preferences and uses reasonable defaults.

Add more constructors as needed.

Parameters
aVisibleLayerMask= current visible layers (bit mask)
aPreferredLayer= the layer to search first

Definition at line 430 of file collectors.h.

431  {
432  m_PreferredLayer = aPreferredLayer;
433  m_IgnorePreferredLayer = false;
434  m_LayerVisible = aVisibleLayerMask;
435  m_IgnoreLockedLayers = true;
437  m_IgnoreLockedItems = false;
438 
439 #if defined(USE_MATCH_LAYER)
440  m_IncludeSecondary = false;
441 #else
442  m_IncludeSecondary = true;
443 #endif
444 
445  m_IgnoreMTextsMarkedNoShow = true; // g_ModuleTextNOVColor;
446  m_IgnoreMTextsOnBack = true;
447  m_IgnoreMTextsOnFront = false;
448  m_IgnoreModulesOnBack = true; // !Show_Modules_Cmp;
449  m_IgnoreModulesOnFront = false;
450 
451  m_IgnorePadsOnFront = false;
452  m_IgnorePadsOnBack = false;
453  m_IgnoreThroughHolePads = false;
454 
455  m_IgnoreModulesVals = false;
456  m_IgnoreModulesRefs = false;
457 
458  m_IgnoreThroughVias = false;
459  m_IgnoreBlindBuriedVias = false;
460  m_IgnoreMicroVias = false;
461  m_IgnoreTracks = false;
462  m_IgnoreZoneFills = true;
463  }
PCB_LAYER_ID m_PreferredLayer
Definition: collectors.h:392
LSET m_LayerVisible
bit-mapped layer visible bits
Definition: collectors.h:398

Member Function Documentation

PCB_LAYER_ID GENERAL_COLLECTORS_GUIDE::GetPreferredLayer ( ) const
inlineoverridevirtual
Returns
int - the preferred layer for HitTest()ing.

Implements COLLECTORS_GUIDE.

Definition at line 506 of file collectors.h.

506 { return m_PreferredLayer; }
PCB_LAYER_ID m_PreferredLayer
Definition: collectors.h:392
bool GENERAL_COLLECTORS_GUIDE::IgnoreBlindBuriedVias ( ) const
inlineoverridevirtual
Returns
true if should ignore blind/buried vias

Implements COLLECTORS_GUIDE.

Definition at line 594 of file collectors.h.

594 { return m_IgnoreBlindBuriedVias; }
bool GENERAL_COLLECTORS_GUIDE::IgnoreLockedItems ( ) const
inlineoverridevirtual
Returns
bool - true if should ignore locked items, else false.

Implements COLLECTORS_GUIDE.

Definition at line 520 of file collectors.h.

520 { return m_IgnoreLockedItems; }
bool GENERAL_COLLECTORS_GUIDE::IgnoreLockedLayers ( ) const
inlineoverridevirtual
Returns
bool - true if should ignore locked layers, else false.

Implements COLLECTORS_GUIDE.

Definition at line 494 of file collectors.h.

494 { return m_IgnoreLockedLayers; }
bool GENERAL_COLLECTORS_GUIDE::IgnoreMicroVias ( ) const
inlineoverridevirtual
Returns
true if should ignore micro vias

Implements COLLECTORS_GUIDE.

Definition at line 597 of file collectors.h.

597 { return m_IgnoreMicroVias; }
bool GENERAL_COLLECTORS_GUIDE::IgnoreModulesOnBack ( ) const
inlineoverridevirtual
Returns
bool - true if should ignore MODULEs on the back side

Implements COLLECTORS_GUIDE.

Definition at line 552 of file collectors.h.

552 { return m_IgnoreModulesOnBack; }
bool GENERAL_COLLECTORS_GUIDE::IgnoreModulesOnFront ( ) const
inlineoverridevirtual
Returns
bool - true if should ignore MODULEs on component layer.

Implements COLLECTORS_GUIDE.

Definition at line 558 of file collectors.h.

558 { return m_IgnoreModulesOnFront; }
bool GENERAL_COLLECTORS_GUIDE::IgnoreModulesRefs ( ) const
inlineoverridevirtual
Returns
bool - true if should ignore modules references.

Implements COLLECTORS_GUIDE.

Definition at line 588 of file collectors.h.

588 { return m_IgnoreModulesRefs; }
bool GENERAL_COLLECTORS_GUIDE::IgnoreModulesVals ( ) const
inlineoverridevirtual
Returns
bool - true if should ignore modules values.

Implements COLLECTORS_GUIDE.

Definition at line 582 of file collectors.h.

582 { return m_IgnoreModulesVals; }
bool GENERAL_COLLECTORS_GUIDE::IgnoreMTextsMarkedNoShow ( ) const
inlineoverridevirtual
Returns
bool - true if MTexts marked as "no show" should be ignored.

Implements COLLECTORS_GUIDE.

Definition at line 534 of file collectors.h.

bool GENERAL_COLLECTORS_GUIDE::IgnoreMTextsOnBack ( ) const
inlineoverridevirtual
Returns
bool - true if should ignore MTexts on back layers

Implements COLLECTORS_GUIDE.

Definition at line 540 of file collectors.h.

540 { return m_IgnoreMTextsOnBack; }
bool GENERAL_COLLECTORS_GUIDE::IgnoreMTextsOnFront ( ) const
inlineoverridevirtual
Returns
bool - true if should ignore MTexts on front layers

Implements COLLECTORS_GUIDE.

Definition at line 546 of file collectors.h.

546 { return m_IgnoreMTextsOnFront; }
bool GENERAL_COLLECTORS_GUIDE::IgnoreNonVisibleLayers ( ) const
inlineoverridevirtual
Returns
bool - true if should ignore non-visible layers, else false.

Implements COLLECTORS_GUIDE.

Definition at line 500 of file collectors.h.

500 { return m_IgnoreNonVisibleLayers; }
virtual bool COLLECTORS_GUIDE::IgnorePads ( ) const
inlinevirtualinherited
bool GENERAL_COLLECTORS_GUIDE::IgnorePadsOnBack ( ) const
inlineoverridevirtual
Returns
bool - true if should ignore Pads on Back Side.

Implements COLLECTORS_GUIDE.

Definition at line 564 of file collectors.h.

564 { return m_IgnorePadsOnBack; }
bool GENERAL_COLLECTORS_GUIDE::IgnorePadsOnFront ( ) const
inlineoverridevirtual
Returns
bool - true if should ignore PADSs on Front Side.

Implements COLLECTORS_GUIDE.

Definition at line 570 of file collectors.h.

570 { return m_IgnorePadsOnFront; }
bool GENERAL_COLLECTORS_GUIDE::IgnorePreferredLayer ( ) const
inlineoverridevirtual

Provide wildcard behavior regarding the preferred layer.

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

Implements COLLECTORS_GUIDE.

Definition at line 514 of file collectors.h.

514 { return m_IgnorePreferredLayer; }
bool GENERAL_COLLECTORS_GUIDE::IgnoreThroughHolePads ( ) const
inlineoverridevirtual
Returns
bool - true if should ignore through-hole PADSs.

Implements COLLECTORS_GUIDE.

Definition at line 576 of file collectors.h.

576 { return m_IgnoreThroughHolePads; }
bool GENERAL_COLLECTORS_GUIDE::IgnoreThroughVias ( ) const
inlineoverridevirtual
Returns
true if should ignore through-hole vias

Implements COLLECTORS_GUIDE.

Definition at line 591 of file collectors.h.

591 { return m_IgnoreThroughVias; }
bool GENERAL_COLLECTORS_GUIDE::IgnoreTracks ( ) const
inlineoverridevirtual
Returns
true if should ignore tracks

Implements COLLECTORS_GUIDE.

Definition at line 600 of file collectors.h.

600 { return m_IgnoreTracks; }
bool GENERAL_COLLECTORS_GUIDE::IgnoreZoneFills ( ) const
inlineoverridevirtual
Returns
true if should ignore the interiors of zones

Implements COLLECTORS_GUIDE.

Definition at line 603 of file collectors.h.

603 { return m_IgnoreZoneFills; }
bool GENERAL_COLLECTORS_GUIDE::IncludeSecondary ( ) const
inlineoverridevirtual

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

Returns
bool - true if should include, else false.

Implements COLLECTORS_GUIDE.

Definition at line 528 of file collectors.h.

528 { return m_IncludeSecondary; }
bool GENERAL_COLLECTORS_GUIDE::IsLayerLocked ( PCB_LAYER_ID  aLayerId) const
inlineoverridevirtual
Returns
bool - true if the given layer is locked, else false.

Implements COLLECTORS_GUIDE.

Definition at line 468 of file collectors.h.

469  {
470  return m_LayerLocked[aLayerId];
471  }
LSET m_LayerLocked
bit-mapped layer locked bits
Definition: collectors.h:395
bool GENERAL_COLLECTORS_GUIDE::IsLayerVisible ( PCB_LAYER_ID  aLayerId) const
inlineoverridevirtual
Returns
bool - true if the given layer is visible, else false.

Implements COLLECTORS_GUIDE.

Definition at line 481 of file collectors.h.

482  {
483  return m_LayerVisible[aLayerId];
484  }
LSET m_LayerVisible
bit-mapped layer visible bits
Definition: collectors.h:398
void GENERAL_COLLECTORS_GUIDE::SetIgnoreBlindBuriedVias ( bool  ignore)
inline

Definition at line 595 of file collectors.h.

Referenced by SELECTION_TOOL::getCollectorsGuide().

595 { m_IgnoreBlindBuriedVias = ignore; }
void GENERAL_COLLECTORS_GUIDE::SetIgnoreLockedItems ( bool  ignore)
inline

Definition at line 521 of file collectors.h.

521 { m_IgnoreLockedItems = ignore; }
void GENERAL_COLLECTORS_GUIDE::SetIgnoreLockedLayers ( bool  ignore)
inline

Definition at line 495 of file collectors.h.

495 { m_IgnoreLockedLayers = ignore; }
void GENERAL_COLLECTORS_GUIDE::SetIgnoreMicroVias ( bool  ignore)
inline

Definition at line 598 of file collectors.h.

Referenced by SELECTION_TOOL::getCollectorsGuide().

598 { m_IgnoreMicroVias = ignore; }
void GENERAL_COLLECTORS_GUIDE::SetIgnoreModulesOnBack ( bool  ignore)
inline

Definition at line 553 of file collectors.h.

Referenced by SELECTION_TOOL::getCollectorsGuide().

553 { m_IgnoreModulesOnBack = ignore; }
void GENERAL_COLLECTORS_GUIDE::SetIgnoreModulesOnFront ( bool  ignore)
inline

Definition at line 559 of file collectors.h.

Referenced by SELECTION_TOOL::getCollectorsGuide().

559 { m_IgnoreModulesOnFront = ignore; }
void GENERAL_COLLECTORS_GUIDE::SetIgnoreModulesRefs ( bool  ignore)
inline
void GENERAL_COLLECTORS_GUIDE::SetIgnoreModulesVals ( bool  ignore)
inline
void GENERAL_COLLECTORS_GUIDE::SetIgnoreMTextsMarkedNoShow ( bool  ignore)
inline
void GENERAL_COLLECTORS_GUIDE::SetIgnoreMTextsOnBack ( bool  ignore)
inline
void GENERAL_COLLECTORS_GUIDE::SetIgnoreMTextsOnFront ( bool  ignore)
inline
void GENERAL_COLLECTORS_GUIDE::SetIgnoreNonVisibleLayers ( bool  ignore)
inline

Definition at line 501 of file collectors.h.

501 { m_IgnoreLockedLayers = ignore; }
void GENERAL_COLLECTORS_GUIDE::SetIgnorePadsOnBack ( bool  ignore)
inline

Definition at line 565 of file collectors.h.

Referenced by SELECTION_TOOL::getCollectorsGuide().

565 { m_IgnorePadsOnBack = ignore; }
void GENERAL_COLLECTORS_GUIDE::SetIgnorePadsOnFront ( bool  ignore)
inline

Definition at line 571 of file collectors.h.

Referenced by SELECTION_TOOL::getCollectorsGuide().

571 { m_IgnorePadsOnFront = ignore; }
void GENERAL_COLLECTORS_GUIDE::SetIgnorePreferredLayer ( bool  ignore)
inline

Definition at line 515 of file collectors.h.

515 { m_IgnorePreferredLayer = ignore; }
void GENERAL_COLLECTORS_GUIDE::SetIgnoreThroughHolePads ( bool  ignore)
inline

Definition at line 577 of file collectors.h.

Referenced by SELECTION_TOOL::getCollectorsGuide().

577 { m_IgnoreThroughHolePads = ignore; }
void GENERAL_COLLECTORS_GUIDE::SetIgnoreThroughVias ( bool  ignore)
inline

Definition at line 592 of file collectors.h.

Referenced by SELECTION_TOOL::getCollectorsGuide().

592 { m_IgnoreThroughVias = ignore; }
void GENERAL_COLLECTORS_GUIDE::SetIgnoreTracks ( bool  ignore)
inline

Definition at line 601 of file collectors.h.

Referenced by SELECTION_TOOL::getCollectorsGuide().

601 { m_IgnoreTracks = ignore; }
void GENERAL_COLLECTORS_GUIDE::SetIgnoreZoneFills ( bool  ignore)
inline

Definition at line 604 of file collectors.h.

604 { m_IgnoreZoneFills = ignore; }
void GENERAL_COLLECTORS_GUIDE::SetIncludeSecondary ( bool  include)
inline

Definition at line 529 of file collectors.h.

529 { m_IncludeSecondary = include; }
void GENERAL_COLLECTORS_GUIDE::SetLayerLocked ( PCB_LAYER_ID  aLayerId,
bool  isLocked 
)
inline

Definition at line 473 of file collectors.h.

474  {
475  m_LayerLocked.set( aLayerId, isLocked );
476  }
LSET m_LayerLocked
bit-mapped layer locked bits
Definition: collectors.h:395
void GENERAL_COLLECTORS_GUIDE::SetLayerVisible ( PCB_LAYER_ID  aLayerId,
bool  isVisible 
)
inline

Definition at line 485 of file collectors.h.

486  {
487  m_LayerVisible.set( aLayerId, isVisible );
488  }
LSET m_LayerVisible
bit-mapped layer visible bits
Definition: collectors.h:398
void GENERAL_COLLECTORS_GUIDE::SetLayerVisibleBits ( LSET  aLayerBits)
inline

Definition at line 489 of file collectors.h.

489 { m_LayerVisible = aLayerBits; }
LSET m_LayerVisible
bit-mapped layer visible bits
Definition: collectors.h:398
void GENERAL_COLLECTORS_GUIDE::SetPreferredLayer ( PCB_LAYER_ID  aLayer)
inline

Definition at line 507 of file collectors.h.

507 { m_PreferredLayer = aLayer; }
PCB_LAYER_ID m_PreferredLayer
Definition: collectors.h:392

Member Data Documentation

bool GENERAL_COLLECTORS_GUIDE::m_IgnoreBlindBuriedVias
private

Definition at line 415 of file collectors.h.

bool GENERAL_COLLECTORS_GUIDE::m_IgnoreLockedItems
private

Definition at line 401 of file collectors.h.

bool GENERAL_COLLECTORS_GUIDE::m_IgnoreLockedLayers
private

Definition at line 396 of file collectors.h.

bool GENERAL_COLLECTORS_GUIDE::m_IgnoreMicroVias
private

Definition at line 416 of file collectors.h.

bool GENERAL_COLLECTORS_GUIDE::m_IgnoreModulesOnBack
private

Definition at line 407 of file collectors.h.

bool GENERAL_COLLECTORS_GUIDE::m_IgnoreModulesOnFront
private

Definition at line 408 of file collectors.h.

bool GENERAL_COLLECTORS_GUIDE::m_IgnoreModulesRefs
private

Definition at line 413 of file collectors.h.

bool GENERAL_COLLECTORS_GUIDE::m_IgnoreModulesVals
private

Definition at line 412 of file collectors.h.

bool GENERAL_COLLECTORS_GUIDE::m_IgnoreMTextsMarkedNoShow
private

Definition at line 404 of file collectors.h.

bool GENERAL_COLLECTORS_GUIDE::m_IgnoreMTextsOnBack
private

Definition at line 405 of file collectors.h.

bool GENERAL_COLLECTORS_GUIDE::m_IgnoreMTextsOnFront
private

Definition at line 406 of file collectors.h.

bool GENERAL_COLLECTORS_GUIDE::m_IgnoreNonVisibleLayers
private

Definition at line 399 of file collectors.h.

bool GENERAL_COLLECTORS_GUIDE::m_IgnorePadsOnBack
private

Definition at line 410 of file collectors.h.

bool GENERAL_COLLECTORS_GUIDE::m_IgnorePadsOnFront
private

Definition at line 409 of file collectors.h.

bool GENERAL_COLLECTORS_GUIDE::m_IgnorePreferredLayer
private

Definition at line 393 of file collectors.h.

bool GENERAL_COLLECTORS_GUIDE::m_IgnoreThroughHolePads
private

Definition at line 411 of file collectors.h.

bool GENERAL_COLLECTORS_GUIDE::m_IgnoreThroughVias
private

Definition at line 414 of file collectors.h.

bool GENERAL_COLLECTORS_GUIDE::m_IgnoreTracks
private

Definition at line 417 of file collectors.h.

bool GENERAL_COLLECTORS_GUIDE::m_IgnoreZoneFills
private

Definition at line 418 of file collectors.h.

bool GENERAL_COLLECTORS_GUIDE::m_IncludeSecondary
private

Definition at line 402 of file collectors.h.

LSET GENERAL_COLLECTORS_GUIDE::m_LayerLocked
private

bit-mapped layer locked bits

Definition at line 395 of file collectors.h.

LSET GENERAL_COLLECTORS_GUIDE::m_LayerVisible
private

bit-mapped layer visible bits

Definition at line 398 of file collectors.h.

PCB_LAYER_ID GENERAL_COLLECTORS_GUIDE::m_PreferredLayer
private

Definition at line 392 of file collectors.h.


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