KiCad PCB EDA Suite
pns_joint.h
Go to the documentation of this file.
1 /*
2  * KiRouter - a push-and-(sometimes-)shove PCB router
3  *
4  * Copyright (C) 2013-2014 CERN
5  * Copyright (C) 2016 KiCad Developers, see AUTHORS.txt for contributors.
6  * Author: Tomasz Wlostowski <tomasz.wlostowski@cern.ch>
7  *
8  * This program is free software: you can redistribute it and/or modify it
9  * under the terms of the GNU General Public License as published by the
10  * Free Software Foundation, either version 3 of the License, or (at your
11  * option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful, but
14  * WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16  * General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License along
19  * with this program. If not, see <http://www.gnu.org/licenses/>.
20  */
21 
22 #ifndef __PNS_JOINT_H
23 #define __PNS_JOINT_H
24 
25 #include <vector>
26 
27 #include <math/vector2d.h>
28 
29 #include "pns_item.h"
30 #include "pns_segment.h"
31 #include "pns_itemset.h"
32 
33 namespace PNS {
34 
43 class JOINT : public ITEM
44 {
45 public:
47 
50  struct HASH_TAG
51  {
53  int net;
54  };
55 
57  {
58  std::size_t operator()( const JOINT::HASH_TAG& aP ) const
59  {
60  using std::size_t;
61  using std::hash;
62  using std::string;
63 
64  return ( (hash<int>()( aP.pos.x )
65  ^ (hash<int>()( aP.pos.y ) << 1) ) >> 1 )
66  ^ (hash<int>()( aP.net ) << 1);
67  }
68  };
69 
70  JOINT() :
71  ITEM( JOINT_T ), m_locked( false ) {}
72 
73  JOINT( const VECTOR2I& aPos, const LAYER_RANGE& aLayers, int aNet = -1 ) :
74  ITEM( JOINT_T )
75  {
76  m_tag.pos = aPos;
77  m_tag.net = aNet;
78  m_layers = aLayers;
79  m_locked = false;
80  }
81 
82  JOINT( const JOINT& aB ) :
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;
89  m_layers = aB.m_layers;
90  m_locked = aB.m_locked;
91  }
92 
93  ITEM* Clone( ) const override
94  {
95  assert( false );
96  return NULL;
97  }
98 
101  bool IsLineCorner() const
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  }
112 
113  bool IsNonFanoutVia() const
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  }
120 
121  bool IsTraceWidthChange() const
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  }
134 
136  void Link( ITEM* aItem )
137  {
138  if( m_linkedItems.Contains( aItem ) )
139  return;
140 
141  m_linkedItems.Add( aItem );
142  }
143 
146  bool Unlink( ITEM* aItem )
147  {
148  m_linkedItems.Erase( aItem );
149  return m_linkedItems.Size() == 0;
150  }
151 
154  SEGMENT* NextSegment( SEGMENT* aCurrent ) const
155  {
156  if( !IsLineCorner() )
157  return NULL;
158 
159  return static_cast<SEGMENT*>( m_linkedItems[m_linkedItems[0] == aCurrent ? 1 : 0] );
160  }
161 
162  VIA* Via()
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  }
172 
173 
175  const HASH_TAG& Tag() const
176  {
177  return m_tag;
178  }
179 
180  const VECTOR2I& Pos() const
181  {
182  return m_tag.pos;
183  }
184 
185  int Net() const
186  {
187  return m_tag.net;
188  }
189 
190  const LINKED_ITEMS& LinkList() const
191  {
192  return m_linkedItems.CItems();
193  }
194 
195  const ITEM_SET& CLinks() const
196  {
197  return m_linkedItems;
198  }
199 
201  {
202  return m_linkedItems;
203  }
204 
205  int LinkCount( int aMask = -1 ) const
206  {
207  return m_linkedItems.Count( aMask );
208  }
209 
210  void Dump() const;
211 
212  bool operator==( const JOINT& rhs ) const
213  {
214  return m_tag.pos == rhs.m_tag.pos && m_tag.net == rhs.m_tag.net;
215  }
216 
217  void Merge( const JOINT& aJoint )
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  }
232 
233  bool Overlaps( const JOINT& rhs ) const
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  }
238 
239  void Lock( bool aLock = true )
240  {
241  m_locked = aLock;
242  }
243 
244  bool IsLocked() const
245  {
246  return m_locked;
247  }
248 
249 private:
252 
255 
257  bool m_locked;
258 };
259 
260 inline bool operator==( JOINT::HASH_TAG const& aP1, JOINT::HASH_TAG const& aP2 )
261 {
262  return aP1.pos == aP2.pos && aP1.net == aP2.net;
263 }
264 
265 }
266 
267 #endif // __PNS_JOINT_H
Class ITEM.
Definition: pns_item.h:53
const ITEM_SET & CLinks() const
Definition: pns_joint.h:195
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
const ENTRIES & CItems() const
Definition: pns_itemset.h:138
bool Overlaps(const JOINT &rhs) const
Definition: pns_joint.h:233
bool Unlink(ITEM *aItem)
Unlinks a given board item from the joint (upon its removal from a NODE) Returns true if the joint be...
Definition: pns_joint.h:146
bool IsTraceWidthChange() const
Definition: pns_joint.h:121
ENTRIES & Items()
Definition: pns_itemset.h:137
LAYER_RANGE m_layers
Definition: pns_item.h:350
ITEM_SET m_linkedItems
list of items linked to this joint
Definition: pns_joint.h:254
void Lock(bool aLock=true)
Definition: pns_joint.h:239
std::vector< ENTRY > ENTRIES
Definition: pns_itemset.h:96
void Erase(ITEM *aItem)
Definition: pns_itemset.h:196
void Add(const LINE &aLine)
Definition: pns_itemset.cpp:32
ITEM_SET & Links()
Definition: pns_joint.h:200
Joints are hashed by their position, layers and net.
Definition: pns_joint.h:50
JOINT(const VECTOR2I &aPos, const LAYER_RANGE &aLayers, int aNet=-1)
Definition: pns_joint.h:73
Class JOINT.
Definition: pns_joint.h:43
bool m_locked
locked (non-movable) flag
Definition: pns_joint.h:257
bool IsNonFanoutVia() const
Definition: pns_joint.h:113
int LinkCount(int aMask=-1) const
Definition: pns_joint.h:205
void Merge(const LAYER_RANGE &aOther)
Definition: pns_layerset.h:93
void Dump() const
Definition: pns_node.cpp:1054
SEGMENT * NextSegment(SEGMENT *aCurrent) const
For trivial joints, returns the segment adjacent to (aCurrent).
Definition: pns_joint.h:154
bool Contains(ITEM *aItem) const
Definition: pns_itemset.h:190
bool IsLocked() const
Definition: pns_joint.h:244
int Width() const
Definition: pns_segment.h:88
ITEM_SET::ENTRIES LINKED_ITEMS
Definition: pns_joint.h:46
bool Overlaps(const LAYER_RANGE &aOther) const
Definition: pns_layerset.h:68
bool operator==(JOINT::HASH_TAG const &aP1, JOINT::HASH_TAG const &aP2)
Definition: pns_joint.h:260
JOINT(const JOINT &aB)
Definition: pns_joint.h:82
VIA * Via()
Definition: pns_joint.h:162
HASH_TAG m_tag
hash tag for unordered_multimap
Definition: pns_joint.h:251
const VECTOR2I & Pos() const
Definition: pns_joint.h:180
bool operator==(const JOINT &rhs) const
Definition: pns_joint.h:212
void Merge(const JOINT &aJoint)
Definition: pns_joint.h:217
const HASH_TAG & Tag() const
trivial accessors
Definition: pns_joint.h:175
ITEM * Clone() const override
Function Clone()
Definition: pns_joint.h:93
int Size() const
Definition: pns_itemset.h:162
void Link(ITEM *aItem)
Links the joint to a given board item (when it's added to the NODE)
Definition: pns_joint.h:136
const LINKED_ITEMS & LinkList() const
Definition: pns_joint.h:190
int Net() const
Definition: pns_joint.h:185
Push and Shove diff pair dimensions (gap) settings dialog.
int Count(int aKindMask=-1) const
Definition: pns_itemset.h:119
Class LAYER_RANGE.
Definition: pns_layerset.h:32
std::size_t operator()(const JOINT::HASH_TAG &aP) const
Definition: pns_joint.h:58