KiCad PCB EDA Suite
RN_NET Class Reference

Class RN_NET Describes ratsnest for a single net. More...

#include <ratsnest_data.h>

Classes

class  TRIANGULATOR_STATE
 

Public Member Functions

 RN_NET ()
 

Default constructor.

More...
 
void SetVisible (bool aEnabled)
 Function SetVisible() Sets state of the visibility flag. More...
 
void MarkDirty ()
 Function MarkDirty() Marks ratsnest for given net as 'dirty', i.e. More...
 
bool IsDirty () const
 Function IsDirty() Returns state of the 'dirty' flag, indicating that ratsnest for a given net is invalid and requires an update. More...
 
const std::vector< CN_EDGEGetUnconnected () const
 Function GetUnconnected() Returns pointer to a vector of edges that makes ratsnest for a given net. More...
 
void Update ()
 Function Update() Recomputes ratsnest for a net. More...
 
void Clear ()
 
void AddCluster (std::shared_ptr< CN_CLUSTER > aCluster)
 
unsigned int GetNodeCount () const
 
std::list< CN_ANCHOR_PTRGetNodes (const BOARD_CONNECTED_ITEM *aItem) const
 Function GetNodes() Returns list of nodes that are associated with a given item. More...
 
const std::vector< CN_EDGE > & GetEdges () const
 
void GetAllItems (std::list< BOARD_CONNECTED_ITEM * > &aOutput, const KICAD_T aTypes[]) const
 Function GetAllItems() Adds all stored items to a list. More...
 
const CN_ANCHOR_PTR GetClosestNode (const CN_ANCHOR_PTR &aNode) const
 Function GetClosestNode() Returns a single node that lies in the shortest distance from a specific node. More...
 
bool NearestBicoloredPair (const RN_NET &aOtherNet, CN_ANCHOR_PTR &aNode1, CN_ANCHOR_PTR &aNode2) const
 

Protected Member Functions

void compute ()
 

Recomputes ratsnest from scratch.

More...
 

Protected Attributes

std::vector< CN_ANCHOR_PTRm_nodes
 

Vector of nodes

More...
 
std::vector< CN_EDGEm_boardEdges
 

Vector of edges that make pre-defined connections

More...
 
std::vector< CN_EDGEm_rnEdges
 

Vector of edges that makes ratsnest for a given net.

More...
 
bool m_dirty
 

Flag indicating necessity of recalculation of ratsnest for a net.

More...
 
std::shared_ptr< TRIANGULATOR_STATEm_triangulator
 

Detailed Description

Class RN_NET Describes ratsnest for a single net.

Definition at line 59 of file ratsnest_data.h.

Constructor & Destructor Documentation

RN_NET::RN_NET ( )

Default constructor.

Definition at line 336 of file ratsnest_data.cpp.

References m_triangulator.

336  : m_dirty( true )
337 {
338  m_triangulator.reset( new TRIANGULATOR_STATE );
339 }
bool m_dirty
Flag indicating necessity of recalculation of ratsnest for a net.
std::shared_ptr< TRIANGULATOR_STATE > m_triangulator

Member Function Documentation

void RN_NET::AddCluster ( std::shared_ptr< CN_CLUSTER aCluster)

Definition at line 422 of file ratsnest_data.cpp.

References CN_ITEM::Anchors(), m_boardEdges, and m_nodes.

Referenced by GetUnconnected().

423 {
424  CN_ANCHOR_PTR firstAnchor;
425 
426  for( auto item : *aCluster )
427  {
428  bool isZone = dynamic_cast<CN_ZONE*>(item) != nullptr;
429  auto& anchors = item->Anchors();
430  unsigned int nAnchors = isZone ? 1 : anchors.size();
431 
432  if( nAnchors > anchors.size() )
433  nAnchors = anchors.size();
434 
435  //printf("item %p anchors : %d\n", item, anchors.size() );
436  //printf("add item %p anchors : %d net : %d\n", item, item->Anchors().size(), item->Parent()->GetNetCode() );
437 
438  for( unsigned int i = 0; i < nAnchors; i++ )
439  {
440  // printf("add anchor %p\n", anchors[i].get() );
441 
442  anchors[i]->SetCluster( aCluster );
443  m_nodes.push_back(anchors[i]);
444 
445  if( firstAnchor )
446  {
447  if( firstAnchor != anchors[i] )
448  {
449  m_boardEdges.emplace_back( firstAnchor, anchors[i], 0 );
450  }
451  }
452  else
453  {
454  firstAnchor = anchors[i];
455  }
456  }
457  }
458 }
CN_ANCHORS & Anchors()
std::vector< CN_ANCHOR_PTR > m_nodes
Vector of nodes
std::vector< CN_EDGE > m_boardEdges
Vector of edges that make pre-defined connections
std::shared_ptr< CN_ANCHOR > CN_ANCHOR_PTR
void RN_NET::Clear ( )

Definition at line 412 of file ratsnest_data.cpp.

References m_boardEdges, m_dirty, m_nodes, and m_rnEdges.

Referenced by GetUnconnected().

413 {
414  m_rnEdges.clear();
415  m_boardEdges.clear();
416  m_nodes.clear();
417 
418  m_dirty = true;
419 }
bool m_dirty
Flag indicating necessity of recalculation of ratsnest for a net.
std::vector< CN_EDGE > m_rnEdges
Vector of edges that makes ratsnest for a given net.
std::vector< CN_ANCHOR_PTR > m_nodes
Vector of nodes
std::vector< CN_EDGE > m_boardEdges
Vector of edges that make pre-defined connections
void RN_NET::compute ( )
protected

Recomputes ratsnest from scratch.

Definition at line 342 of file ratsnest_data.cpp.

References CN_EDGE::GetSourceNode(), kruskalMST(), m_boardEdges, m_nodes, m_rnEdges, m_triangulator, and PROF_COUNTER::Show().

Referenced by GetEdges(), and Update().

343 {
344  // Special cases do not need complicated algorithms (actually, it does not work well with
345  // the Delaunay triangulator)
346  //printf("compute nodes : %d\n", m_nodes.size() );
347  if( m_nodes.size() <= 2 )
348  {
349  m_rnEdges.clear();
350 
351  // Check if the only possible connection exists
352  if( m_boardEdges.size() == 0 && m_nodes.size() == 2 )
353  {
354  auto last = ++m_nodes.begin();
355 
356  // There can be only one possible connection, but it is missing
357  CN_EDGE edge (*m_nodes.begin(), *last );
358  edge.GetSourceNode()->SetTag( 0 );
359  edge.GetTargetNode()->SetTag( 1 );
360 
361  m_rnEdges.push_back( edge );
362  }
363  else
364  {
365  // Set tags to m_nodes as connected
366  for( auto node : m_nodes )
367  node->SetTag( 0 );
368  }
369 
370  return;
371  }
372 
373 
374  m_triangulator->Clear();
375 
376  for( auto n : m_nodes )
377  {
378  m_triangulator->AddNode( n );
379  }
380 
381  #ifdef PROFILE
382  PROF_COUNTER cnt("triangulate");
383  #endif
384  auto triangEdges = m_triangulator->Triangulate();
385  #ifdef PROFILE
386  cnt.Show();
387  #endif
388 
389  for( const auto& e : m_boardEdges )
390  triangEdges.push_back( e );
391 
392 // Get the minimal spanning tree
393 #ifdef PROFILE
394  PROF_COUNTER cnt2("mst");
395 #endif
396  m_rnEdges = kruskalMST( triangEdges, m_nodes );
397 #ifdef PROFILE
398  cnt2.Show();
399 #endif
400 }
std::vector< CN_EDGE > m_rnEdges
Vector of edges that makes ratsnest for a given net.
The class PROF_COUNTER is a small class to help profiling.
Definition: profile.h:45
std::vector< CN_ANCHOR_PTR > m_nodes
Vector of nodes
static const std::vector< CN_EDGE > kruskalMST(std::list< CN_EDGE > &aEdges, std::vector< CN_ANCHOR_PTR > &aNodes)
std::shared_ptr< TRIANGULATOR_STATE > m_triangulator
std::vector< CN_EDGE > m_boardEdges
Vector of edges that make pre-defined connections
CN_ANCHOR_PTR GetSourceNode() const
void RN_NET::GetAllItems ( std::list< BOARD_CONNECTED_ITEM * > &  aOutput,
const KICAD_T  aTypes[] 
) const

Function GetAllItems() Adds all stored items to a list.

Parameters
aOutputis the list that will have items added.
aTypesdetermines the type of added items.

Referenced by GetEdges().

const CN_ANCHOR_PTR RN_NET::GetClosestNode ( const CN_ANCHOR_PTR aNode) const

Function GetClosestNode() Returns a single node that lies in the shortest distance from a specific node.

Parameters
aNodeis the node for which the closest node is searched.

Referenced by GetEdges().

const std::vector<CN_EDGE>& RN_NET::GetEdges ( ) const
inline

Definition at line 125 of file ratsnest_data.h.

References compute(), GetAllItems(), GetClosestNode(), m_rnEdges, and NearestBicoloredPair().

Referenced by PCB_BASE_FRAME::DrawGeneralRatsnest().

126  {
127  return m_rnEdges;
128  }
std::vector< CN_EDGE > m_rnEdges
Vector of edges that makes ratsnest for a given net.
unsigned int RN_NET::GetNodeCount ( ) const
inline

Definition at line 112 of file ratsnest_data.h.

References GetNodes(), and m_nodes.

113  {
114  return m_nodes.size();
115  }
std::vector< CN_ANCHOR_PTR > m_nodes
Vector of nodes
std::list<CN_ANCHOR_PTR> RN_NET::GetNodes ( const BOARD_CONNECTED_ITEM aItem) const

Function GetNodes() Returns list of nodes that are associated with a given item.

Parameters
aItemis an item for which the list is generated.
Returns
List of associated nodes.

Referenced by GetNodeCount().

const std::vector<CN_EDGE> RN_NET::GetUnconnected ( ) const
inline

Function GetUnconnected() Returns pointer to a vector of edges that makes ratsnest for a given net.

Returns
Pointer to a vector of edges that makes ratsnest for a given net.

Definition at line 98 of file ratsnest_data.h.

References AddCluster(), Clear(), m_rnEdges, and Update().

Referenced by KIGFX::RATSNEST_VIEWITEM::ViewDraw().

99  {
100  return m_rnEdges;
101  }
std::vector< CN_EDGE > m_rnEdges
Vector of edges that makes ratsnest for a given net.
bool RN_NET::IsDirty ( ) const
inline

Function IsDirty() Returns state of the 'dirty' flag, indicating that ratsnest for a given net is invalid and requires an update.

Returns
True if ratsnest requires recomputation, false otherwise.

Definition at line 88 of file ratsnest_data.h.

References m_dirty.

89  {
90  return m_dirty;
91  }
bool m_dirty
Flag indicating necessity of recalculation of ratsnest for a net.
void RN_NET::MarkDirty ( )
inline

Function MarkDirty() Marks ratsnest for given net as 'dirty', i.e.

requiring recomputation.

Definition at line 77 of file ratsnest_data.h.

References m_dirty.

78  {
79  m_dirty = true;
80  }
bool m_dirty
Flag indicating necessity of recalculation of ratsnest for a net.
bool RN_NET::NearestBicoloredPair ( const RN_NET aOtherNet,
CN_ANCHOR_PTR aNode1,
CN_ANCHOR_PTR aNode2 
) const

Definition at line 461 of file ratsnest_data.cpp.

References VECTOR2< int >::ECOORD_MAX, and m_nodes.

Referenced by GetEdges().

463 {
464  bool rv = false;
465 
467 
468  for( auto nodeA : m_nodes )
469  {
470  for( auto nodeB : aOtherNet.m_nodes )
471  {
472  if( !nodeA->GetNoLine() )
473  {
474  auto squaredDist = (nodeA->Pos() - nodeB->Pos() ).SquaredEuclideanNorm();
475 
476  if( squaredDist < distMax )
477  {
478  rv = true;
479  distMax = squaredDist;
480  aNode1 = nodeA;
481  aNode2 = nodeB;
482  }
483  }
484  }
485  }
486 
487  return rv;
488 }
VECTOR2_TRAITS< int >::extended_type extended_type
Definition: vector2d.h:77
std::vector< CN_ANCHOR_PTR > m_nodes
Vector of nodes
static constexpr extended_type ECOORD_MAX
Definition: vector2d.h:80
void RN_NET::SetVisible ( bool  aEnabled)

Function SetVisible() Sets state of the visibility flag.

Parameters
aEnabledis new state. True if ratsnest for a given net is meant to be displayed, false otherwise.

Definition at line 491 of file ratsnest_data.cpp.

References m_rnEdges.

492 {
493  for( auto& edge : m_rnEdges )
494  edge.SetVisible( aEnabled );
495 }
std::vector< CN_EDGE > m_rnEdges
Vector of edges that makes ratsnest for a given net.
void RN_NET::Update ( )

Function Update() Recomputes ratsnest for a net.

Definition at line 404 of file ratsnest_data.cpp.

References compute(), and m_dirty.

Referenced by GetUnconnected().

405 {
406  compute();
407 
408  m_dirty = false;
409 }
bool m_dirty
Flag indicating necessity of recalculation of ratsnest for a net.
void compute()
Recomputes ratsnest from scratch.

Member Data Documentation

std::vector<CN_EDGE> RN_NET::m_boardEdges
protected

Vector of edges that make pre-defined connections

Definition at line 155 of file ratsnest_data.h.

Referenced by AddCluster(), Clear(), and compute().

bool RN_NET::m_dirty
protected

Flag indicating necessity of recalculation of ratsnest for a net.

Definition at line 161 of file ratsnest_data.h.

Referenced by Clear(), IsDirty(), MarkDirty(), and Update().

std::vector<CN_ANCHOR_PTR> RN_NET::m_nodes
protected

Vector of nodes

Definition at line 152 of file ratsnest_data.h.

Referenced by AddCluster(), Clear(), compute(), GetNodeCount(), and NearestBicoloredPair().

std::vector<CN_EDGE> RN_NET::m_rnEdges
protected

Vector of edges that makes ratsnest for a given net.

Definition at line 158 of file ratsnest_data.h.

Referenced by Clear(), compute(), GetEdges(), GetUnconnected(), and SetVisible().

std::shared_ptr<TRIANGULATOR_STATE> RN_NET::m_triangulator
protected

Definition at line 163 of file ratsnest_data.h.

Referenced by compute(), and RN_NET().


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