KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
LAYER_RANGE Class Reference

Represent a contiguous set of PCB layers. More...

#include <pns_layerset.h>

Public Member Functions

 LAYER_RANGE ()
 
 LAYER_RANGE (int aStart, int aEnd)
 
 LAYER_RANGE (int aLayer)
 
 LAYER_RANGE (const LAYER_RANGE &aB)
 
 ~LAYER_RANGE ()
 
LAYER_RANGE & operator= (const LAYER_RANGE &aB)
 
bool Overlaps (const LAYER_RANGE &aOther) const
 
bool Overlaps (const int aLayer) const
 
bool IsMultilayer () const
 
int Start () const
 
int End () const
 
void Merge (const LAYER_RANGE &aOther)
 
LAYER_RANGE Intersection (const LAYER_RANGE &aOther) const
 Shortcut for comparisons/overlap tests. More...
 
bool operator== (const LAYER_RANGE &aOther) const
 
bool operator!= (const LAYER_RANGE &aOther) const
 

Static Public Member Functions

static LAYER_RANGE All ()
 

Private Attributes

int m_start
 
int m_end
 

Detailed Description

Represent a contiguous set of PCB layers.

Definition at line 31 of file pns_layerset.h.

Constructor & Destructor Documentation

◆ LAYER_RANGE() [1/4]

LAYER_RANGE::LAYER_RANGE ( )
inline

Definition at line 34 of file pns_layerset.h.

Referenced by All().

◆ LAYER_RANGE() [2/4]

LAYER_RANGE::LAYER_RANGE ( int  aStart,
int  aEnd 
)
inline

Definition at line 39 of file pns_layerset.h.

References m_end, and m_start.

◆ LAYER_RANGE() [3/4]

LAYER_RANGE::LAYER_RANGE ( int  aLayer)
inline

Definition at line 48 of file pns_layerset.h.

References m_end, and m_start.

◆ LAYER_RANGE() [4/4]

LAYER_RANGE::LAYER_RANGE ( const LAYER_RANGE &  aB)
inline

Definition at line 53 of file pns_layerset.h.

◆ ~LAYER_RANGE()

LAYER_RANGE::~LAYER_RANGE ( )
inline

Definition at line 58 of file pns_layerset.h.

Member Function Documentation

◆ All()

static LAYER_RANGE LAYER_RANGE::All ( )
inlinestatic

Definition at line 125 of file pns_layerset.h.

References LAYER_RANGE().

Referenced by PNS::ROUTER::QueryHoverItems().

◆ End()

int LAYER_RANGE::End ( ) const
inline

Definition at line 87 of file pns_layerset.h.

References m_end.

Referenced by PNS::INDEX::Add(), PNS_PCBNEW_RULE_RESOLVER::Clearance(), MOCK_RULE_RESOLVER::Clearance(), PNS::JOINT::Dump(), PNS::ITEM::Format(), CN_RTREE< T >::Insert(), PNS_KICAD_IFACE::IsAnyLayerVisible(), CN_RTREE< T >::Query(), PNS::INDEX::Query(), PNS::INDEX::Remove(), and CN_RTREE< T >::Remove().

◆ Intersection()

LAYER_RANGE LAYER_RANGE::Intersection ( const LAYER_RANGE &  aOther) const
inline

Shortcut for comparisons/overlap tests.

Definition at line 108 of file pns_layerset.h.

References m_end, and m_start.

Referenced by PNS_PCBNEW_RULE_RESOLVER::Clearance(), MOCK_RULE_RESOLVER::Clearance(), and PNS_KICAD_IFACE_BASE::IsFlashedOnLayer().

◆ IsMultilayer()

bool LAYER_RANGE::IsMultilayer ( ) const
inline

Definition at line 77 of file pns_layerset.h.

References m_end, and m_start.

Referenced by PNS::NODE::FixupVirtualVias(), and PNS::ROUTER::markViolations().

◆ Merge()

void LAYER_RANGE::Merge ( const LAYER_RANGE &  aOther)
inline

Definition at line 92 of file pns_layerset.h.

References m_end, and m_start.

Referenced by PNS::JOINT::Merge().

◆ operator!=()

bool LAYER_RANGE::operator!= ( const LAYER_RANGE &  aOther) const
inline

Definition at line 135 of file pns_layerset.h.

References m_end, and m_start.

◆ operator=()

LAYER_RANGE & LAYER_RANGE::operator= ( const LAYER_RANGE &  aB)
inline

Definition at line 60 of file pns_layerset.h.

References m_end, and m_start.

◆ operator==()

bool LAYER_RANGE::operator== ( const LAYER_RANGE &  aOther) const
inline

Definition at line 130 of file pns_layerset.h.

References m_end, and m_start.

◆ Overlaps() [1/2]

bool LAYER_RANGE::Overlaps ( const int  aLayer) const
inline

Definition at line 72 of file pns_layerset.h.

References m_end, and m_start.

◆ Overlaps() [2/2]

bool LAYER_RANGE::Overlaps ( const LAYER_RANGE &  aOther) const
inline

Definition at line 67 of file pns_layerset.h.

References m_end, and m_start.

Referenced by PNS::ITEM::collideSimple(), PNS::ROUTER::ContinueFromEnd(), PNS::NODE::FindLinesBetweenJoints(), PNS::ROUTER::Finish(), ROUTER_TOOL::getStartLayer(), PNS_KICAD_IFACE_BASE::IsFlashedOnLayer(), PNS::ITEM::LayersOverlap(), PNS::JOINT::Overlaps(), PNS::LINE_PLACER::SetLayer(), PNS::NODE::touchJoint(), and PNS::TOOL_BASE::updateStartItem().

◆ Start()

int LAYER_RANGE::Start ( ) const
inline

Definition at line 82 of file pns_layerset.h.

References m_start.

Referenced by PNS::INDEX::Add(), PNS_KICAD_IFACE::AddItem(), PNS_PCBNEW_RULE_RESOLVER::Clearance(), MOCK_RULE_RESOLVER::Clearance(), PNS::ROUTER::ContinueFromEnd(), PNS::DP_MEANDER_PLACER::CurrentLayer(), PNS::MEANDER_PLACER::CurrentLayer(), PNS::JOINT::Dump(), PNS::NODE::FindJoint(), PNS::NODE::findRedundantArc(), PNS::NODE::findRedundantSegment(), PNS::findViaByHandle(), PNS::DRAGGER::findViaFanoutByHandle(), PNS::NODE::FixupVirtualVias(), PNS::ITEM::Format(), ROUTER_TOOL::getStartLayer(), CN_RTREE< T >::Insert(), PNS_KICAD_IFACE::IsAnyLayerVisible(), CN_ITEM::Layer(), PNS::ITEM::Layer(), PNS::SHOVE::onCollidingSolid(), LENGTH_TUNER_TOOL::performTuning(), PNS::TOOL_BASE::pickSingleItem(), CN_RTREE< T >::Query(), PNS::INDEX::Query(), PNS::INDEX::Remove(), CN_RTREE< T >::Remove(), PNS::NODE::removeSolidIndex(), PNS::NODE::removeViaIndex(), PNS_LOG_PLAYER::ReplayLog(), ROUTER_PREVIEW_ITEM::Update(), and PNS::TOOL_BASE::updateEndItem().

Member Data Documentation

◆ m_end

int LAYER_RANGE::m_end
private

Definition at line 142 of file pns_layerset.h.

Referenced by End(), Intersection(), IsMultilayer(), LAYER_RANGE(), Merge(), operator!=(), operator=(), operator==(), and Overlaps().

◆ m_start

int LAYER_RANGE::m_start
private

Definition at line 141 of file pns_layerset.h.

Referenced by Intersection(), IsMultilayer(), LAYER_RANGE(), Merge(), operator!=(), operator=(), operator==(), Overlaps(), and Start().

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