KiCad PCB EDA Suite
PNS::JOINT Class Reference

Class JOINT. More...

#include <pns_joint.h>

Inheritance diagram for PNS::JOINT:
PNS::ITEM

Classes

struct  HASH_TAG
 

Joints are hashed by their position, layers and net.

More...
 
struct  JOINT_TAG_HASH
 

Public Types

typedef ITEM_SET::ENTRIES LINKED_ITEMS
 
enum  PnsKind {
  SOLID_T = 1, LINE_T = 2, JOINT_T = 4, SEGMENT_T = 8,
  VIA_T = 16, DIFF_PAIR_T = 32, ANY_T = 0xff
}
 

Supported item types

More...
 

Public Member Functions

 JOINT ()
 
 JOINT (const VECTOR2I &aPos, const LAYER_RANGE &aLayers, int aNet=-1)
 
 JOINT (const JOINT &aB)
 
ITEMClone () const override
 Function Clone() More...
 
bool IsLineCorner () const
 

Returns true if the joint is a trivial line corner, connecting two

segments of the same net, on the same layer. More...

 
bool IsNonFanoutVia () const
 
bool IsTraceWidthChange () const
 
void Link (ITEM *aItem)
 

Links the joint to a given board item (when it's added to the NODE)

More...
 
bool Unlink (ITEM *aItem)
 

Unlinks a given board item from the joint (upon its removal from a NODE) Returns true if the joint became dangling after unlinking.

More...
 
SEGMENTNextSegment (SEGMENT *aCurrent) const
 

For trivial joints, returns the segment adjacent to (aCurrent).

More...
 
VIAVia ()
 
const HASH_TAGTag () const
 trivial accessors More...
 
const VECTOR2IPos () const
 
int Net () const
 
const LINKED_ITEMSLinkList () const
 
const ITEM_SETCLinks () const
 
ITEM_SETLinks ()
 
int LinkCount (int aMask=-1) const
 
void Dump () const
 
bool operator== (const JOINT &rhs) const
 
void Merge (const JOINT &aJoint)
 
bool Overlaps (const JOINT &rhs) const
 
void Lock (bool aLock=true)
 
bool IsLocked () const
 
virtual const SHAPE_LINE_CHAIN Hull (int aClearance=0, int aWalkaroundThickness=0) const
 
PnsKind Kind () const
 Function Kind() More...
 
bool OfKind (int aKindMask) const
 Function OfKind() More...
 
const std::string KindStr () const
 Function KindStr() More...
 
void SetParent (BOARD_CONNECTED_ITEM *aParent)
 Function SetParent() More...
 
BOARD_CONNECTED_ITEMParent () const
 Function Parent() More...
 
void SetNet (int aNet)
 Function SetNet() More...
 
bool InAnyNet () const
 
void SetLayers (const LAYER_RANGE &aLayers)
 Function SetLayers() More...
 
void SetLayer (int aLayer)
 Function SetLayer() More...
 
const LAYER_RANGELayers () const
 Function Layers() More...
 
virtual int Layer () const
 Function Layer() More...
 
bool LayersOverlap (const ITEM *aOther) const
 Function LayersOverlap() More...
 
void SetOwner (NODE *aOwner)
 Functon SetOwner() More...
 
bool BelongsTo (NODE *aNode) const
 Function BelongsTo() More...
 
NODEOwner () const
 Function Owner() More...
 
virtual bool Collide (const ITEM *aOther, int aClearance, bool aNeedMTV, VECTOR2I &aMTV, bool aDifferentNetsOnly=true) const
 Function Collide() More...
 
bool Collide (const ITEM *aOther, int aClearance, bool aDifferentNetsOnly=true) const
 Function Collide() More...
 
virtual const SHAPEShape () const
 Function Shape() More...
 
virtual void Mark (int aMarker)
 
virtual void Unmark (int aMarker=-1)
 
virtual int Marker () const
 
virtual void SetRank (int aRank)
 
virtual int Rank () const
 
virtual VECTOR2I Anchor (int n) const
 
virtual int AnchorCount () const
 
void SetRoutable (bool aRoutable)
 
bool IsRoutable () const
 

Static Public Attributes

static const int UnusedNet = INT_MAX
 

Protected Attributes

PnsKind m_kind
 
BOARD_CONNECTED_ITEMm_parent
 
NODEm_owner
 
LAYER_RANGE m_layers
 
bool m_movable
 
int m_net
 
int m_marker
 
int m_rank
 
bool m_routable
 

Private Attributes

HASH_TAG m_tag
 

hash tag for unordered_multimap

More...
 
ITEM_SET m_linkedItems
 

list of items linked to this joint

More...
 
bool m_locked
 

locked (non-movable) flag

More...
 

Detailed Description

Class JOINT.

Represents a 2D point on a given set of layers and belonging to a certain net, that links together a number of board items. A hash table of joints is used by the router to follow connectivity between the items.

Definition at line 43 of file pns_joint.h.

Member Typedef Documentation

◆ LINKED_ITEMS

Definition at line 46 of file pns_joint.h.

Member Enumeration Documentation

◆ PnsKind

enum PNS::ITEM::PnsKind
inherited

Supported item types

Enumerator
SOLID_T 
LINE_T 
JOINT_T 
SEGMENT_T 
VIA_T 
DIFF_PAIR_T 
ANY_T 

Definition at line 59 of file pns_item.h.

60  {
61  SOLID_T = 1,
62  LINE_T = 2,
63  JOINT_T = 4,
64  SEGMENT_T = 8,
65  VIA_T = 16,
66  DIFF_PAIR_T = 32,
67  ANY_T = 0xff
68  };

Constructor & Destructor Documentation

◆ JOINT() [1/3]

PNS::JOINT::JOINT ( )
inline

Definition at line 70 of file pns_joint.h.

70  :
71  ITEM( JOINT_T ), m_locked( false ) {}
ITEM(PnsKind aKind)
Definition: pns_item.h:70
bool m_locked
locked (non-movable) flag
Definition: pns_joint.h:257

◆ JOINT() [2/3]

PNS::JOINT::JOINT ( const VECTOR2I aPos,
const LAYER_RANGE aLayers,
int  aNet = -1 
)
inline

Definition at line 73 of file pns_joint.h.

73  :
74  ITEM( JOINT_T )
75  {
76  m_tag.pos = aPos;
77  m_tag.net = aNet;
78  m_layers = aLayers;
79  m_locked = false;
80  }
LAYER_RANGE m_layers
Definition: pns_item.h:367
ITEM(PnsKind aKind)
Definition: pns_item.h:70
bool m_locked
locked (non-movable) flag
Definition: pns_joint.h:257
HASH_TAG m_tag
hash tag for unordered_multimap
Definition: pns_joint.h:251

References PNS::ITEM::m_layers, m_locked, m_tag, PNS::JOINT::HASH_TAG::net, and PNS::JOINT::HASH_TAG::pos.

◆ JOINT() [3/3]

PNS::JOINT::JOINT ( const JOINT aB)
inline

Definition at line 82 of file pns_joint.h.

82  :
83  ITEM( JOINT_T )
84  {
85  m_layers = aB.m_layers;
86  m_tag.pos = aB.m_tag.pos;
87  m_tag.net = aB.m_tag.net;
88  m_linkedItems = aB.m_linkedItems;
89  m_layers = aB.m_layers;
90  m_locked = aB.m_locked;
91  }
LAYER_RANGE m_layers
Definition: pns_item.h:367
ITEM_SET m_linkedItems
list of items linked to this joint
Definition: pns_joint.h:254
ITEM(PnsKind aKind)
Definition: pns_item.h:70
bool m_locked
locked (non-movable) flag
Definition: pns_joint.h:257
HASH_TAG m_tag
hash tag for unordered_multimap
Definition: pns_joint.h:251

References PNS::ITEM::m_layers, m_linkedItems, m_locked, m_tag, PNS::JOINT::HASH_TAG::net, and PNS::JOINT::HASH_TAG::pos.

Member Function Documentation

◆ Anchor()

virtual VECTOR2I PNS::ITEM::Anchor ( int  n) const
inlinevirtualinherited

Reimplemented in PNS::VIA, PNS::SEGMENT, and PNS::SOLID.

Definition at line 333 of file pns_item.h.

334  {
335  return VECTOR2I();
336  }
VECTOR2< int > VECTOR2I
Definition: vector2d.h:587

Referenced by PNS::DP_PRIMITIVE_PAIR::CursorOrientation(), PNS::DP_PRIMITIVE_PAIR::DP_PRIMITIVE_PAIR(), and PNS::DIFF_PAIR_PLACER::getDanglingAnchor().

◆ AnchorCount()

virtual int PNS::ITEM::AnchorCount ( ) const
inlinevirtualinherited

Reimplemented in PNS::VIA, PNS::SEGMENT, and PNS::SOLID.

Definition at line 338 of file pns_item.h.

339  {
340  return 0;
341  }

◆ BelongsTo()

bool PNS::ITEM::BelongsTo ( NODE aNode) const
inlineinherited

Function BelongsTo()

Returns
true if the item is owned by the node aNode.

Definition at line 256 of file pns_item.h.

257  {
258  return m_owner == aNode;
259  }
NODE * m_owner
Definition: pns_item.h:366

References PNS::ITEM::m_owner.

Referenced by PNS::NODE::doRemove().

◆ CLinks()

const ITEM_SET& PNS::JOINT::CLinks ( ) const
inline

Definition at line 195 of file pns_joint.h.

196  {
197  return m_linkedItems;
198  }
ITEM_SET m_linkedItems
list of items linked to this joint
Definition: pns_joint.h:254

References m_linkedItems.

◆ Clone()

ITEM* PNS::JOINT::Clone ( ) const
inlineoverridevirtual

Function Clone()

Returns a deep copy of the item

Implements PNS::ITEM.

Definition at line 93 of file pns_joint.h.

94  {
95  assert( false );
96  return NULL;
97  }

◆ Collide() [1/2]

bool PNS::ITEM::Collide ( const ITEM aOther,
int  aClearance,
bool  aNeedMTV,
VECTOR2I aMTV,
bool  aDifferentNetsOnly = true 
) const
virtualinherited

Function Collide()

Checks for a collision (clearance violation) with between us and item aOther. Collision checking takes all PCB stuff into accound (layers, nets, DRC rules). Optionally returns a minimum translation vector for force propagation algorithm.

Parameters
aOtheritem to check collision against
aClearancedesired clearance
aNeedMTVwhen true, the minimum translation vector is calculated
aMTVthe minimum translation vector
Returns
true, if a collision was found.

Definition at line 44 of file pns_item.cpp.

46 {
47  if( collideSimple( aOther, aClearance, aNeedMTV, aMTV, aDifferentNetsOnly ) )
48  return true;
49 
50  // special case for "head" line with a via attached at the end.
51  if( aOther->m_kind == LINE_T )
52  {
53  const LINE* line = static_cast<const LINE*>( aOther );
54 
55  if( line->EndsWithVia() )
56  return collideSimple( &line->Via(), aClearance - line->Width() / 2, aNeedMTV, aMTV, aDifferentNetsOnly );
57  }
58 
59  return false;
60 }
bool collideSimple(const ITEM *aOther, int aClearance, bool aNeedMTV, VECTOR2I &aMTV, bool aDifferentNetsOnly) const
Definition: pns_item.cpp:27

References PNS::ITEM::collideSimple(), PNS::LINE::EndsWithVia(), PNS::ITEM::LINE_T, PNS::ITEM::m_kind, PNS::LINE::Via(), and PNS::LINE::Width().

Referenced by PNS::NODE::CheckColliding(), PNS::ITEM::Collide(), PNS::OPTIMIZER::CACHE_VISITOR::operator()(), and PNS::NODE::DEFAULT_OBSTACLE_VISITOR::operator()().

◆ Collide() [2/2]

bool PNS::ITEM::Collide ( const ITEM aOther,
int  aClearance,
bool  aDifferentNetsOnly = true 
) const
inlineinherited

Function Collide()

A shortcut for ITEM::Colllide() without MTV stuff.

Definition at line 290 of file pns_item.h.

291  {
292  VECTOR2I dummy;
293 
294  return Collide( aOther, aClearance, false, dummy, aDifferentNetsOnly );
295  }
static LIB_PART * dummy()
Used to draw a dummy shape when a LIB_PART is not found in library.
virtual bool Collide(const ITEM *aOther, int aClearance, bool aNeedMTV, VECTOR2I &aMTV, bool aDifferentNetsOnly=true) const
Function Collide()
Definition: pns_item.cpp:44

References PNS::ITEM::Collide(), and dummy().

◆ Dump()

void PNS::JOINT::Dump ( ) const

Definition at line 1057 of file pns_node.cpp.

1058 {
1059  wxLogTrace( "PNS", "joint layers %d-%d, net %d, pos %s, links: %d", m_layers.Start(),
1060  m_layers.End(), m_tag.net, m_tag.pos.Format().c_str(), LinkCount() );
1061 }
LAYER_RANGE m_layers
Definition: pns_item.h:367
int Start() const
Definition: pns_layerset.h:83
int End() const
Definition: pns_layerset.h:88
const std::string Format() const
Function Format returns the vector formatted as a string.
Definition: vector2d.h:400
HASH_TAG m_tag
hash tag for unordered_multimap
Definition: pns_joint.h:251
int LinkCount(int aMask=-1) const
Definition: pns_joint.h:205

References LAYER_RANGE::End(), VECTOR2< T >::Format(), LinkCount(), PNS::ITEM::m_layers, m_tag, PNS::JOINT::HASH_TAG::net, PNS::JOINT::HASH_TAG::pos, and LAYER_RANGE::Start().

◆ Hull()

virtual const SHAPE_LINE_CHAIN PNS::ITEM::Hull ( int  aClearance = 0,
int  aWalkaroundThickness = 0 
) const
inlinevirtualinherited

Reimplemented in PNS::VIA, PNS::SEGMENT, and PNS::SOLID.

Definition at line 112 of file pns_item.h.

113  {
114  return SHAPE_LINE_CHAIN();
115  }
Class SHAPE_LINE_CHAIN.

◆ InAnyNet()

bool PNS::ITEM::InAnyNet ( ) const
inlineinherited

Definition at line 184 of file pns_item.h.

185  {
186  return m_net != UnusedNet;
187  }
static const int UnusedNet
Definition: pns_item.h:56
int m_net
Definition: pns_item.h:370

References PNS::ITEM::m_net, and PNS::ITEM::UnusedNet.

◆ IsLineCorner()

bool PNS::JOINT::IsLineCorner ( ) const
inline

Returns true if the joint is a trivial line corner, connecting two

segments of the same net, on the same layer.

Definition at line 101 of file pns_joint.h.

102  {
103  if( m_linkedItems.Size() != 2 || m_linkedItems.Count( SEGMENT_T ) != 2 )
104  return false;
105 
106  SEGMENT* seg1 = static_cast<SEGMENT*>( m_linkedItems[0] );
107  SEGMENT* seg2 = static_cast<SEGMENT*>( m_linkedItems[1] );
108 
109  // joints between segments of different widths are not considered trivial.
110  return seg1->Width() == seg2->Width();
111  }
int Count(int aKindMask=-1) const
Definition: pns_itemset.h:119
ITEM_SET m_linkedItems
list of items linked to this joint
Definition: pns_joint.h:254
int Size() const
Definition: pns_itemset.h:165

References PNS::ITEM_SET::Count(), m_linkedItems, PNS::ITEM::SEGMENT_T, PNS::ITEM_SET::Size(), and PNS::SEGMENT::Width().

Referenced by PNS::NODE::followLine(), and NextSegment().

◆ IsLocked()

bool PNS::JOINT::IsLocked ( ) const
inline

Definition at line 244 of file pns_joint.h.

245  {
246  return m_locked;
247  }
bool m_locked
locked (non-movable) flag
Definition: pns_joint.h:257

References m_locked.

Referenced by PNS::NODE::followLine(), and Merge().

◆ IsNonFanoutVia()

bool PNS::JOINT::IsNonFanoutVia ( ) const
inline

Definition at line 113 of file pns_joint.h.

114  {
115  int vias = m_linkedItems.Count( VIA_T );
116  int segs = m_linkedItems.Count( SEGMENT_T );
117 
118  return ( m_linkedItems.Size() == 3 && vias == 1 && segs == 2 );
119  }
int Count(int aKindMask=-1) const
Definition: pns_itemset.h:119
ITEM_SET m_linkedItems
list of items linked to this joint
Definition: pns_joint.h:254
int Size() const
Definition: pns_itemset.h:165

References PNS::ITEM_SET::Count(), m_linkedItems, PNS::ITEM::SEGMENT_T, PNS::ITEM_SET::Size(), and PNS::ITEM::VIA_T.

Referenced by PNS::TOPOLOGY::AssembleTrivialPath(), and PNS::TOPOLOGY::followTrivialPath().

◆ IsRoutable()

bool PNS::ITEM::IsRoutable ( ) const
inlineinherited

Definition at line 353 of file pns_item.h.

354  {
355  return m_routable;
356  }
bool m_routable
Definition: pns_item.h:373

References PNS::ITEM::m_routable.

◆ IsTraceWidthChange()

bool PNS::JOINT::IsTraceWidthChange ( ) const
inline

Definition at line 121 of file pns_joint.h.

122  {
123  if( m_linkedItems.Size() != 2 )
124  return false;
125 
126  if( m_linkedItems.Count( SEGMENT_T ) != 2)
127  return false;
128 
129  SEGMENT* seg1 = static_cast<SEGMENT*>( m_linkedItems[0] );
130  SEGMENT* seg2 = static_cast<SEGMENT*>( m_linkedItems[1] );
131 
132  return seg1->Width() != seg2->Width();
133  }
int Count(int aKindMask=-1) const
Definition: pns_itemset.h:119
ITEM_SET m_linkedItems
list of items linked to this joint
Definition: pns_joint.h:254
int Size() const
Definition: pns_itemset.h:165

References PNS::ITEM_SET::Count(), m_linkedItems, PNS::ITEM::SEGMENT_T, PNS::ITEM_SET::Size(), and PNS::SEGMENT::Width().

Referenced by PNS::TOPOLOGY::followTrivialPath().

◆ Kind()

◆ KindStr()

const std::string PNS::ITEM::KindStr ( ) const
inherited

Function KindStr()

Returns the kind of the item, as string

Definition at line 63 of file pns_item.cpp.

64 {
65  switch( m_kind )
66  {
67  case LINE_T:
68  return "line";
69 
70  case SEGMENT_T:
71  return "segment";
72 
73  case VIA_T:
74  return "via";
75 
76  case JOINT_T:
77  return "joint";
78 
79  case SOLID_T:
80  return "solid";
81 
82  default:
83  return "unknown";
84  }
85 }
PnsKind m_kind
Definition: pns_item.h:363

References PNS::ITEM::JOINT_T, PNS::ITEM::LINE_T, PNS::ITEM::m_kind, PNS::ITEM::SEGMENT_T, PNS::ITEM::SOLID_T, and PNS::ITEM::VIA_T.

Referenced by PNS::TOOL_BASE::pickSingleItem(), and PNS::TOOL_BASE::updateEndItem().

◆ Layer()

virtual int PNS::ITEM::Layer ( ) const
inlinevirtualinherited

Function Layer()

Returns the item's layer, for single-layered items only.

Reimplemented in PNS::SEGMENT.

Definition at line 224 of file pns_item.h.

225  {
226  return Layers().Start();
227  }
int Start() const
Definition: pns_layerset.h:83
const LAYER_RANGE & Layers() const
Function Layers()
Definition: pns_item.h:214

References PNS::ITEM::Layers(), and LAYER_RANGE::Start().

Referenced by PNS::OPTIMIZER::fanoutCleanup(), and PNS::OPTIMIZER::runSmartPads().

◆ Layers()

◆ LayersOverlap()

bool PNS::ITEM::LayersOverlap ( const ITEM aOther) const
inlineinherited

Function LayersOverlap()

Returns true if the set of layers spanned by aOther overlaps our layers.

Definition at line 235 of file pns_item.h.

236  {
237  return Layers().Overlaps( aOther->Layers() );
238  }
bool Overlaps(const LAYER_RANGE &aOther) const
Definition: pns_layerset.h:68
const LAYER_RANGE & Layers() const
Function Layers()
Definition: pns_item.h:214

References PNS::ITEM::Layers(), and LAYER_RANGE::Overlaps().

Referenced by PNS::SHOVE::onCollidingSegment(), PNS::SHOVE::ProcessSingleLine(), and PNS::NODE::removeViaIndex().

◆ Link()

void PNS::JOINT::Link ( ITEM aItem)
inline

Links the joint to a given board item (when it's added to the NODE)

Definition at line 136 of file pns_joint.h.

137  {
138  if( m_linkedItems.Contains( aItem ) )
139  return;
140 
141  m_linkedItems.Add( aItem );
142  }
bool Contains(ITEM *aItem) const
Definition: pns_itemset.h:193
ITEM_SET m_linkedItems
list of items linked to this joint
Definition: pns_joint.h:254
void Add(const LINE &aLine)
Definition: pns_itemset.cpp:32

References PNS::ITEM_SET::Add(), PNS::ITEM_SET::Contains(), and m_linkedItems.

Referenced by PNS::NODE::linkJoint().

◆ LinkCount()

int PNS::JOINT::LinkCount ( int  aMask = -1) const
inline

Definition at line 205 of file pns_joint.h.

206  {
207  return m_linkedItems.Count( aMask );
208  }
int Count(int aKindMask=-1) const
Definition: pns_itemset.h:119
ITEM_SET m_linkedItems
list of items linked to this joint
Definition: pns_joint.h:254

References PNS::ITEM_SET::Count(), and m_linkedItems.

Referenced by Dump(), PNS::DIFF_PAIR_PLACER::getDanglingAnchor(), PNS::TOPOLOGY::LeadingRatLine(), and PNS::LINE_PLACER::SplitAdjacentSegments().

◆ LinkList()

◆ Links()

ITEM_SET& PNS::JOINT::Links ( )
inline

Definition at line 200 of file pns_joint.h.

201  {
202  return m_linkedItems;
203  }
ITEM_SET m_linkedItems
list of items linked to this joint
Definition: pns_joint.h:254

References m_linkedItems.

Referenced by PNS::LINE_RESTRICTIONS::allowedAngles(), PNS::TOPOLOGY::AssembleTrivialPath(), PNS::TOPOLOGY::followTrivialPath(), and PNS::SIZES_SETTINGS::inheritTrackWidth().

◆ Lock()

void PNS::JOINT::Lock ( bool  aLock = true)
inline

Definition at line 239 of file pns_joint.h.

240  {
241  m_locked = aLock;
242  }
bool m_locked
locked (non-movable) flag
Definition: pns_joint.h:257

References m_locked.

Referenced by PNS::NODE::LockJoint().

◆ Mark()

virtual void PNS::ITEM::Mark ( int  aMarker)
inlinevirtualinherited

Reimplemented in PNS::LINE.

Definition at line 308 of file pns_item.h.

309  {
310  m_marker = aMarker;
311  }
int m_marker
Definition: pns_item.h:371

References PNS::ITEM::m_marker.

Referenced by PNS::SHOVE::ShoveDraggingVia().

◆ Marker()

virtual int PNS::ITEM::Marker ( ) const
inlinevirtualinherited

Reimplemented in PNS::LINE.

Definition at line 318 of file pns_item.h.

319  {
320  return m_marker;
321  }
int m_marker
Definition: pns_item.h:371

References PNS::ITEM::m_marker.

Referenced by PNS::ITEM::IsLocked(), PNS::LOGGER::Log(), PNS::SHOVE::pushVia(), and ROUTER_PREVIEW_ITEM::Update().

◆ Merge()

void PNS::JOINT::Merge ( const JOINT aJoint)
inline

Definition at line 217 of file pns_joint.h.

218  {
219  if( !Overlaps( aJoint ) )
220  return;
221 
222  m_layers.Merge( aJoint.m_layers );
223 
224  if( aJoint.IsLocked() )
225  m_locked = true;
226 
227  for( ITEM* item : aJoint.LinkList() )
228  {
229  m_linkedItems.Add( item );
230  }
231  }
LAYER_RANGE m_layers
Definition: pns_item.h:367
ITEM_SET m_linkedItems
list of items linked to this joint
Definition: pns_joint.h:254
ITEM(PnsKind aKind)
Definition: pns_item.h:70
void Add(const LINE &aLine)
Definition: pns_itemset.cpp:32
bool m_locked
locked (non-movable) flag
Definition: pns_joint.h:257
void Merge(const LAYER_RANGE &aOther)
Definition: pns_layerset.h:93
bool Overlaps(const JOINT &rhs) const
Definition: pns_joint.h:233

References PNS::ITEM_SET::Add(), IsLocked(), LinkList(), PNS::ITEM::m_layers, m_linkedItems, m_locked, LAYER_RANGE::Merge(), and Overlaps().

Referenced by PNS::NODE::touchJoint().

◆ Net()

int PNS::JOINT::Net ( ) const
inline

Definition at line 185 of file pns_joint.h.

186  {
187  return m_tag.net;
188  }
HASH_TAG m_tag
hash tag for unordered_multimap
Definition: pns_joint.h:251

References m_tag, and PNS::JOINT::HASH_TAG::net.

Referenced by PNS::TOPOLOGY::NearestUnconnectedItem().

◆ NextSegment()

SEGMENT* PNS::JOINT::NextSegment ( SEGMENT aCurrent) const
inline

For trivial joints, returns the segment adjacent to (aCurrent).

For non-trival ones, returns NULL, indicating the end of line.

Definition at line 154 of file pns_joint.h.

155  {
156  if( !IsLineCorner() )
157  return NULL;
158 
159  return static_cast<SEGMENT*>( m_linkedItems[m_linkedItems[0] == aCurrent ? 1 : 0] );
160  }
ITEM_SET m_linkedItems
list of items linked to this joint
Definition: pns_joint.h:254
bool IsLineCorner() const
Returns true if the joint is a trivial line corner, connecting two segments of the same net,...
Definition: pns_joint.h:101

References IsLineCorner(), and m_linkedItems.

Referenced by PNS::NODE::followLine().

◆ OfKind()

◆ operator==()

bool PNS::JOINT::operator== ( const JOINT rhs) const
inline

Definition at line 212 of file pns_joint.h.

213  {
214  return m_tag.pos == rhs.m_tag.pos && m_tag.net == rhs.m_tag.net;
215  }
HASH_TAG m_tag
hash tag for unordered_multimap
Definition: pns_joint.h:251

References m_tag, PNS::JOINT::HASH_TAG::net, and PNS::JOINT::HASH_TAG::pos.

◆ Overlaps()

bool PNS::JOINT::Overlaps ( const JOINT rhs) const
inline

Definition at line 233 of file pns_joint.h.

234  {
235  return m_tag.pos == rhs.m_tag.pos &&
236  m_tag.net == rhs.m_tag.net && m_layers.Overlaps( rhs.m_layers );
237  }
bool Overlaps(const LAYER_RANGE &aOther) const
Definition: pns_layerset.h:68
LAYER_RANGE m_layers
Definition: pns_item.h:367
HASH_TAG m_tag
hash tag for unordered_multimap
Definition: pns_joint.h:251

References PNS::ITEM::m_layers, m_tag, PNS::JOINT::HASH_TAG::net, LAYER_RANGE::Overlaps(), and PNS::JOINT::HASH_TAG::pos.

Referenced by Merge().

◆ Owner()

NODE* PNS::ITEM::Owner ( ) const
inlineinherited

Function Owner()

Returns the owner of this item, or NULL if there's none.

Definition at line 266 of file pns_item.h.

266 { return m_owner; }
NODE * m_owner
Definition: pns_item.h:366

References PNS::ITEM::m_owner.

Referenced by PNS::SIZES_SETTINGS::inheritTrackWidth(), and PNS::LINE_PLACER::Move().

◆ Parent()

BOARD_CONNECTED_ITEM* PNS::ITEM::Parent ( ) const
inlineinherited

Function Parent()

Returns the corresponding parent object in the host application's model.

Definition at line 159 of file pns_item.h.

160  {
161  return m_parent;
162  }
BOARD_CONNECTED_ITEM * m_parent
Definition: pns_item.h:365

References PNS::ITEM::m_parent.

Referenced by PNS_PCBNEW_RULE_RESOLVER::DpNetPair(), PNS_KICAD_IFACE::HideItem(), PNS_PCBNEW_RULE_RESOLVER::localPadClearance(), ROUTER_TOOL::prepareInteractive(), and PNS_KICAD_IFACE::RemoveItem().

◆ Pos()

const VECTOR2I& PNS::JOINT::Pos ( ) const
inline

Definition at line 180 of file pns_joint.h.

181  {
182  return m_tag.pos;
183  }
HASH_TAG m_tag
hash tag for unordered_multimap
Definition: pns_joint.h:251

References m_tag, and PNS::JOINT::HASH_TAG::pos.

Referenced by PNS::NODE::FindLinesBetweenJoints(), PNS::NODE::followLine(), PNS::TOPOLOGY::LeadingRatLine(), and PNS::TOPOLOGY::NearestUnconnectedItem().

◆ Rank()

virtual int PNS::ITEM::Rank ( ) const
inlinevirtualinherited

Reimplemented in PNS::LINE.

Definition at line 328 of file pns_item.h.

329  {
330  return m_rank;
331  }
int m_rank
Definition: pns_item.h:372

References PNS::ITEM::m_rank.

Referenced by PNS::LOGGER::Log(), PNS::SHOVE::onCollidingVia(), and PNS::SHOVE::shoveIteration().

◆ SetLayer()

void PNS::ITEM::SetLayer ( int  aLayer)
inlineinherited

Function SetLayer()

Sets the layers spanned by the item to a single layer aLayer.

Definition at line 204 of file pns_item.h.

205  {
206  m_layers = LAYER_RANGE( aLayer, aLayer );
207  }
LAYER_RANGE m_layers
Definition: pns_item.h:367
Class LAYER_RANGE.
Definition: pns_layerset.h:32

References PNS::ITEM::m_layers.

Referenced by PNS::LINE_PLACER::initPlacement(), PNS::DIFF_PAIR_PLACER::propagateDpHeadForces(), PNS::DIFF_PAIR_PLACER::routeHead(), and PNS::DIFF_PAIR::updateLine().

◆ SetLayers()

void PNS::ITEM::SetLayers ( const LAYER_RANGE aLayers)
inlineinherited

Function SetLayers()

Sets the layers spanned by the item to aLayers.

Definition at line 194 of file pns_item.h.

195  {
196  m_layers = aLayers;
197  }
LAYER_RANGE m_layers
Definition: pns_item.h:367

References PNS::ITEM::m_layers.

Referenced by PNS::TOPOLOGY::AssembleDiffPair(), PNS::NODE::AssembleLine(), PNS::VIA::Clone(), PNS::SEGMENT::SetLayer(), and PNS::VIA::VIA().

◆ SetNet()

void PNS::ITEM::SetNet ( int  aNet)
inlineinherited

◆ SetOwner()

void PNS::ITEM::SetOwner ( NODE aOwner)
inlineinherited

Functon SetOwner()

Sets the node that owns this item. An item can belong to a single NODE or stay unowned.

Definition at line 246 of file pns_item.h.

247  {
248  m_owner = aOwner;
249  }
NODE * m_owner
Definition: pns_item.h:366

References PNS::ITEM::m_owner.

Referenced by PNS::NODE::AssembleLine(), PNS::NODE::doRemove(), and PNS::NODE::Remove().

◆ SetParent()

void PNS::ITEM::SetParent ( BOARD_CONNECTED_ITEM aParent)
inlineinherited

Function SetParent()

Sets the corresponding parent object in the host application's model.

Definition at line 149 of file pns_item.h.

150  {
151  m_parent = aParent;
152  }
BOARD_CONNECTED_ITEM * m_parent
Definition: pns_item.h:365

References PNS::ITEM::m_parent.

Referenced by PNS_KICAD_IFACE::AddItem().

◆ SetRank()

virtual void PNS::ITEM::SetRank ( int  aRank)
inlinevirtualinherited

Reimplemented in PNS::LINE.

Definition at line 323 of file pns_item.h.

324  {
325  m_rank = aRank;
326  }
int m_rank
Definition: pns_item.h:372

References PNS::ITEM::m_rank.

◆ SetRoutable()

void PNS::ITEM::SetRoutable ( bool  aRoutable)
inlineinherited

Definition at line 348 of file pns_item.h.

349  {
350  m_routable = aRoutable;
351  }
bool m_routable
Definition: pns_item.h:373

References PNS::ITEM::m_routable.

◆ Shape()

virtual const SHAPE* PNS::ITEM::Shape ( ) const
inlinevirtualinherited

Function Shape()

Returns the geometrical shape of the item. Used for collision detection & spatial indexing.

Reimplemented in PNS::VIA, PNS::LINE, PNS::SEGMENT, and PNS::SOLID.

Definition at line 303 of file pns_item.h.

304  {
305  return NULL;
306  }

Referenced by PNS::DP_GATEWAYS::BuildFromPrimitivePair(), PNS::OPTIMIZER::checkColliding(), PNS::ITEM::collideSimple(), PNS::OPTIMIZER::computeBreakouts(), PNS::OPTIMIZER::customBreakouts(), PNS::LOGGER::Log(), PNS::SHOVE::onCollidingVia(), PNS::HIT_VISITOR::operator()(), PNS::INDEX::Query(), and ROUTER_PREVIEW_ITEM::Update().

◆ Tag()

const HASH_TAG& PNS::JOINT::Tag ( ) const
inline

trivial accessors

Definition at line 175 of file pns_joint.h.

176  {
177  return m_tag;
178  }
HASH_TAG m_tag
hash tag for unordered_multimap
Definition: pns_joint.h:251

References m_tag.

◆ Unlink()

bool PNS::JOINT::Unlink ( ITEM aItem)
inline

Unlinks a given board item from the joint (upon its removal from a NODE) Returns true if the joint became dangling after unlinking.

Definition at line 146 of file pns_joint.h.

147  {
148  m_linkedItems.Erase( aItem );
149  return m_linkedItems.Size() == 0;
150  }
ITEM_SET m_linkedItems
list of items linked to this joint
Definition: pns_joint.h:254
int Size() const
Definition: pns_itemset.h:165
void Erase(ITEM *aItem)
Definition: pns_itemset.h:199

References PNS::ITEM_SET::Erase(), m_linkedItems, and PNS::ITEM_SET::Size().

Referenced by PNS::NODE::unlinkJoint().

◆ Unmark()

virtual void PNS::ITEM::Unmark ( int  aMarker = -1)
inlinevirtualinherited

Reimplemented in PNS::LINE.

Definition at line 313 of file pns_item.h.

314  {
315  m_marker &= ~aMarker;
316  }
int m_marker
Definition: pns_item.h:371

References PNS::ITEM::m_marker.

Referenced by PNS::DRAGGER::Start().

◆ Via()

VIA* PNS::JOINT::Via ( )
inline

Definition at line 162 of file pns_joint.h.

163  {
164  for( ITEM* item : m_linkedItems.Items() )
165  {
166  if( item->OfKind( VIA_T ) )
167  return static_cast<VIA*>( item );
168  }
169 
170  return NULL;
171  }
ENTRIES & Items()
Definition: pns_itemset.h:140
ITEM_SET m_linkedItems
list of items linked to this joint
Definition: pns_joint.h:254
ITEM(PnsKind aKind)
Definition: pns_item.h:70

References PNS::ITEM_SET::Items(), m_linkedItems, and PNS::ITEM::VIA_T.

Member Data Documentation

◆ m_kind

PnsKind PNS::ITEM::m_kind
protectedinherited

◆ m_layers

◆ m_linkedItems

ITEM_SET PNS::JOINT::m_linkedItems
private

list of items linked to this joint

Definition at line 254 of file pns_joint.h.

Referenced by CLinks(), IsLineCorner(), IsNonFanoutVia(), IsTraceWidthChange(), JOINT(), Link(), LinkCount(), LinkList(), Links(), Merge(), NextSegment(), Unlink(), and Via().

◆ m_locked

bool PNS::JOINT::m_locked
private

locked (non-movable) flag

Definition at line 257 of file pns_joint.h.

Referenced by IsLocked(), JOINT(), Lock(), and Merge().

◆ m_marker

◆ m_movable

bool PNS::ITEM::m_movable
protectedinherited

◆ m_net

◆ m_owner

NODE* PNS::ITEM::m_owner
protectedinherited

◆ m_parent

BOARD_CONNECTED_ITEM* PNS::ITEM::m_parent
protectedinherited

Definition at line 365 of file pns_item.h.

Referenced by PNS::ITEM::ITEM(), PNS::ITEM::Parent(), and PNS::ITEM::SetParent().

◆ m_rank

◆ m_routable

bool PNS::ITEM::m_routable
protectedinherited

Definition at line 373 of file pns_item.h.

Referenced by PNS::ITEM::IsRoutable(), PNS::ITEM::ITEM(), and PNS::ITEM::SetRoutable().

◆ m_tag

HASH_TAG PNS::JOINT::m_tag
private

hash tag for unordered_multimap

Definition at line 251 of file pns_joint.h.

Referenced by Dump(), JOINT(), Net(), operator==(), Overlaps(), Pos(), and Tag().

◆ UnusedNet

const int PNS::ITEM::UnusedNet = INT_MAX
staticinherited

Definition at line 56 of file pns_item.h.

Referenced by PNS::ITEM::InAnyNet(), and PNS::ITEM::ITEM().


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