KiCad PCB EDA Suite
PNS::ROUTER Class Reference

#include <pns_router.h>

Public Member Functions

 ROUTER ()
 
 ~ROUTER ()
 
void SetInterface (ROUTER_IFACE *aIface)
 
void SetMode (ROUTER_MODE aMode)
 
ROUTER_MODE Mode () const
 
void ClearWorld ()
 
void SyncWorld ()
 
void SetView (KIGFX::VIEW *aView)
 
bool RoutingInProgress () const
 
bool StartRouting (const VECTOR2I &aP, ITEM *aItem, int aLayer)
 
void Move (const VECTOR2I &aP, ITEM *aItem)
 
bool FixRoute (const VECTOR2I &aP, ITEM *aItem, bool aForceFinish=false)
 
void BreakSegment (ITEM *aItem, const VECTOR2I &aP)
 
void StopRouting ()
 
int GetClearance (const ITEM *aA, const ITEM *aB) const
 
NODEGetWorld () const
 
void FlipPosture ()
 
void DisplayItem (const ITEM *aItem, int aColor=-1, int aClearance=-1, bool aEdit=false)
 
void DisplayItems (const ITEM_SET &aItems)
 
void DeleteTraces (ITEM *aStartItem, bool aWholeTrack)
 
void SwitchLayer (int layer)
 
void ToggleViaPlacement ()
 
void SetOrthoMode (bool aEnable)
 
int GetCurrentLayer () const
 
const std::vector< int > GetCurrentNets () const
 
void DumpLog ()
 
RULE_RESOLVERGetRuleResolver () const
 
bool IsPlacingVia () const
 
const ITEM_SET QueryHoverItems (const VECTOR2I &aP)
 
const VECTOR2I SnapToItem (ITEM *aItem, VECTOR2I aP, bool &aSplitsSegment)
 
bool StartDragging (const VECTOR2I &aP, ITEM *aItem, int aDragMode=DM_ANY)
 
void SetIterLimit (int aX)
 
int GetIterLimit () const
 
void SetShowIntermediateSteps (bool aX, int aSnapshotIter=-1)
 
bool GetShowIntermediateSteps () const
 
int GetShapshotIter () const
 
ROUTING_SETTINGSSettings ()
 
void CommitRouting (NODE *aNode)
 
void UpdateSizes (const SIZES_SETTINGS &aSizes)
 Applies stored settings. More...
 
void LoadSettings (const ROUTING_SETTINGS &aSettings)
 Changes routing settings to ones passed in the parameter. More...
 
SIZES_SETTINGSSizes ()
 
ITEMQueryItemByParent (const BOARD_ITEM *aItem) const
 
void SetFailureReason (const wxString &aReason)
 
const wxString & FailureReason () const
 
PLACEMENT_ALGOPlacer ()
 
ROUTER_IFACEGetInterface () const
 

Static Public Member Functions

static ROUTERGetInstance ()
 

Private Types

enum  RouterState { IDLE, DRAG_SEGMENT, ROUTE_TRACK }
 

Private Member Functions

void movePlacing (const VECTOR2I &aP, ITEM *aItem)
 
void moveDragging (const VECTOR2I &aP, ITEM *aItem)
 
void eraseView ()
 
void updateView (NODE *aNode, ITEM_SET &aCurrent, bool aDragging=false)
 
void clearViewFlags ()
 
ITEMpickSingleItem (ITEM_SET &aItems) const
 
void splitAdjacentSegments (NODE *aNode, ITEM *aSeg, const VECTOR2I &aP)
 
ITEMsyncPad (D_PAD *aPad)
 
ITEMsyncTrack (TRACK *aTrack)
 
ITEMsyncVia (VIA *aVia)
 
void commitPad (SOLID *aPad)
 
void commitSegment (SEGMENT *aTrack)
 
void commitVia (VIA *aVia)
 
void highlightCurrent (bool enabled)
 
void markViolations (NODE *aNode, ITEM_SET &aCurrent, NODE::ITEM_VECTOR &aRemoved)
 
bool isStartingPointRoutable (const VECTOR2I &aWhere, int aLayer)
 

Private Attributes

VECTOR2I m_currentEnd
 
RouterState m_state
 
std::unique_ptr< NODEm_world
 
NODEm_lastNode
 
std::unique_ptr< PLACEMENT_ALGOm_placer
 
std::unique_ptr< DRAGGERm_dragger
 
std::unique_ptr< SHOVEm_shove
 
ROUTER_IFACEm_iface
 
int m_iterLimit
 
bool m_showInterSteps
 
int m_snapshotIter
 
bool m_violation
 
bool m_forceMarkObstaclesMode = false
 
ROUTING_SETTINGS m_settings
 
SIZES_SETTINGS m_sizes
 
ROUTER_MODE m_mode
 
wxString m_toolStatusbarName
 
wxString m_failureReason
 

Detailed Description

Definition at line 108 of file pns_router.h.

Member Enumeration Documentation

◆ RouterState

Enumerator
IDLE 
DRAG_SEGMENT 
ROUTE_TRACK 

Definition at line 111 of file pns_router.h.

Constructor & Destructor Documentation

◆ ROUTER()

PNS::ROUTER::ROUTER ( )

Definition at line 61 of file pns_router.cpp.

62 {
63  theRouter = this;
64 
65  m_state = IDLE;
67 
68  // Initialize all other variables:
69  m_lastNode = nullptr;
70  m_iterLimit = 0;
71  m_showInterSteps = false;
72  m_snapshotIter = 0;
73  m_violation = false;
74  m_iface = nullptr;
75 }
int m_snapshotIter
Definition: pns_router.h:264
int m_iterLimit
Definition: pns_router.h:262
bool m_showInterSteps
Definition: pns_router.h:263
NODE * m_lastNode
Definition: pns_router.h:254
RouterState m_state
Definition: pns_router.h:251
ROUTER_IFACE * m_iface
Definition: pns_router.h:260
static ROUTER * theRouter
Definition: pns_router.cpp:59
bool m_violation
Definition: pns_router.h:265
ROUTER_MODE m_mode
Definition: pns_router.h:270

References IDLE, m_iface, m_iterLimit, m_lastNode, m_mode, m_showInterSteps, m_snapshotIter, m_state, m_violation, PNS::PNS_MODE_ROUTE_SINGLE, and PNS::theRouter.

◆ ~ROUTER()

PNS::ROUTER::~ROUTER ( )

Definition at line 84 of file pns_router.cpp.

85 {
86  ClearWorld();
87  theRouter = nullptr;
88 }
void ClearWorld()
Definition: pns_router.cpp:100
static ROUTER * theRouter
Definition: pns_router.cpp:59

References ClearWorld(), and PNS::theRouter.

Member Function Documentation

◆ BreakSegment()

void PNS::ROUTER::BreakSegment ( ITEM aItem,
const VECTOR2I aP 
)

Definition at line 529 of file pns_router.cpp.

530 {
531  NODE *node = m_world->Branch();
532 
533  LINE_PLACER placer( this );
534 
535  if ( placer.SplitAdjacentSegments( node, aItem, aP ) )
536  {
537  CommitRouting( node );
538  }
539  else
540  {
541  delete node;
542  }
543 
544 }
std::unique_ptr< NODE > m_world
Definition: pns_router.h:253
void CommitRouting(NODE *aNode)
Definition: pns_router.cpp:357

References CommitRouting(), m_world, and PNS::LINE_PLACER::SplitAdjacentSegments().

Referenced by ROUTER_TOOL::breakTrack().

◆ clearViewFlags()

void PNS::ROUTER::clearViewFlags ( )
private

◆ ClearWorld()

void PNS::ROUTER::ClearWorld ( )

Definition at line 100 of file pns_router.cpp.

101 {
102  if( m_world )
103  {
104  m_world->KillChildren();
105  m_world.reset();
106  }
107 
108  m_placer.reset();
109 }
std::unique_ptr< NODE > m_world
Definition: pns_router.h:253
std::unique_ptr< PLACEMENT_ALGO > m_placer
Definition: pns_router.h:256

References m_placer, and m_world.

Referenced by ROUTER_TOOL::mainLoop(), PNS::TOOL_BASE::Reset(), SyncWorld(), and ~ROUTER().

◆ commitPad()

void PNS::ROUTER::commitPad ( SOLID aPad)
private

◆ CommitRouting()

void PNS::ROUTER::CommitRouting ( NODE aNode)

Definition at line 357 of file pns_router.cpp.

358 {
359  NODE::ITEM_VECTOR removed, added;
360 
361  aNode->GetUpdatedItems( removed, added );
362 
363  for( auto item : removed )
364  m_iface->RemoveItem( item );
365 
366  for( auto item : added )
367  m_iface->AddItem( item );
368 
369  m_iface->Commit();
370  m_world->Commit( aNode );
371 }
virtual void AddItem(ITEM *aItem)=0
std::unique_ptr< NODE > m_world
Definition: pns_router.h:253
ROUTER_IFACE * m_iface
Definition: pns_router.h:260
virtual void Commit()=0
virtual void RemoveItem(ITEM *aItem)=0
std::vector< ITEM * > ITEM_VECTOR
Definition: pns_node.h:140

References PNS::ROUTER_IFACE::AddItem(), PNS::ROUTER_IFACE::Commit(), PNS::NODE::GetUpdatedItems(), m_iface, m_world, and PNS::ROUTER_IFACE::RemoveItem().

Referenced by BreakSegment(), PNS::TOOL_BASE::deleteTraces(), PNS::MEANDER_PLACER::FixRoute(), PNS::DRAGGER::FixRoute(), PNS::DP_MEANDER_PLACER::FixRoute(), PNS::LINE_PLACER::FixRoute(), and PNS::DIFF_PAIR_PLACER::FixRoute().

◆ commitSegment()

void PNS::ROUTER::commitSegment ( SEGMENT aTrack)
private

◆ commitVia()

void PNS::ROUTER::commitVia ( VIA aVia)
private

◆ DeleteTraces()

void PNS::ROUTER::DeleteTraces ( ITEM aStartItem,
bool  aWholeTrack 
)

◆ DisplayItem()

void PNS::ROUTER::DisplayItem ( const ITEM aItem,
int  aColor = -1,
int  aClearance = -1,
bool  aEdit = false 
)

◆ DisplayItems()

void PNS::ROUTER::DisplayItems ( const ITEM_SET aItems)

Definition at line 224 of file pns_router.cpp.

225 {
226  for( const ITEM* item : aItems.CItems() )
227  m_iface->DisplayItem( item );
228 }
virtual void DisplayItem(const ITEM *aItem, int aColor=-1, int aClearance=-1, bool aEdit=false)=0
ROUTER_IFACE * m_iface
Definition: pns_router.h:260

References PNS::ITEM_SET::CItems(), PNS::ROUTER_IFACE::DisplayItem(), and m_iface.

◆ DumpLog()

void PNS::ROUTER::DumpLog ( )

Definition at line 476 of file pns_router.cpp.

477 {
478  LOGGER* logger = nullptr;
479 
480  switch( m_state )
481  {
482  case DRAG_SEGMENT:
483  logger = m_dragger->Logger();
484  break;
485 
486  case ROUTE_TRACK:
487  logger = m_placer->Logger();
488  break;
489 
490  default:
491  break;
492  }
493 
494  if( logger )
495  logger->Save( "/tmp/shove.log" );
496 }
std::unique_ptr< PLACEMENT_ALGO > m_placer
Definition: pns_router.h:256
RouterState m_state
Definition: pns_router.h:251
std::unique_ptr< DRAGGER > m_dragger
Definition: pns_router.h:257

References DRAG_SEGMENT, m_dragger, m_placer, m_state, ROUTE_TRACK, and PNS::LOGGER::Save().

Referenced by ROUTER_TOOL::handleCommonEvents().

◆ eraseView()

void PNS::ROUTER::eraseView ( )
private

◆ FailureReason()

const wxString& PNS::ROUTER::FailureReason ( ) const
inline

Definition at line 214 of file pns_router.h.

214 { return m_failureReason; }
wxString m_failureReason
Definition: pns_router.h:273

References m_failureReason.

Referenced by LENGTH_TUNER_TOOL::performTuning(), and ROUTER_TOOL::prepareInteractive().

◆ FixRoute()

bool PNS::ROUTER::FixRoute ( const VECTOR2I aP,
ITEM aItem,
bool  aForceFinish = false 
)

Definition at line 374 of file pns_router.cpp.

375 {
376  bool rv = false;
377 
378  switch( m_state )
379  {
380  case ROUTE_TRACK:
381  rv = m_placer->FixRoute( aP, aEndItem, aForceFinish );
382  break;
383 
384  case DRAG_SEGMENT:
385  rv = m_dragger->FixRoute();
386  break;
387 
388  default:
389  break;
390  }
391 
392  if( rv )
393  StopRouting();
394 
395  return rv;
396 }
std::unique_ptr< PLACEMENT_ALGO > m_placer
Definition: pns_router.h:256
RouterState m_state
Definition: pns_router.h:251
std::unique_ptr< DRAGGER > m_dragger
Definition: pns_router.h:257
void StopRouting()
Definition: pns_router.cpp:399

References DRAG_SEGMENT, m_dragger, m_placer, m_state, ROUTE_TRACK, and StopRouting().

Referenced by ROUTER_TOOL::InlineDrag(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), and LENGTH_TUNER_TOOL::performTuning().

◆ FlipPosture()

void PNS::ROUTER::FlipPosture ( )

Definition at line 427 of file pns_router.cpp.

428 {
429  if( m_state == ROUTE_TRACK )
430  {
431  m_placer->FlipPosture();
432  }
433 }
std::unique_ptr< PLACEMENT_ALGO > m_placer
Definition: pns_router.h:256
RouterState m_state
Definition: pns_router.h:251

References m_placer, m_state, and ROUTE_TRACK.

Referenced by ROUTER_TOOL::performRouting().

◆ GetClearance()

int PNS::ROUTER::GetClearance ( const ITEM aA,
const ITEM aB 
) const

◆ GetCurrentLayer()

int PNS::ROUTER::GetCurrentLayer ( ) const

Definition at line 468 of file pns_router.cpp.

469 {
470  if( m_placer )
471  return m_placer->CurrentLayer();
472  return -1;
473 }
std::unique_ptr< PLACEMENT_ALGO > m_placer
Definition: pns_router.h:256

References m_placer.

Referenced by ROUTER_TOOL::onViaCommand(), ROUTER_TOOL::performRouting(), ROUTER_TOOL::switchLayerOnViaPlacement(), and PNS::TOOL_BASE::updateEndItem().

◆ GetCurrentNets()

const std::vector< int > PNS::ROUTER::GetCurrentNets ( ) const

Definition at line 459 of file pns_router.cpp.

460 {
461  if( m_placer )
462  return m_placer->CurrentNets();
463 
464  return std::vector<int>();
465 }
std::unique_ptr< PLACEMENT_ALGO > m_placer
Definition: pns_router.h:256

References m_placer.

Referenced by PNS::TOOL_BASE::updateEndItem().

◆ GetInstance()

ROUTER * PNS::ROUTER::GetInstance ( )
static

Definition at line 78 of file pns_router.cpp.

79 {
80  return theRouter;
81 }
static ROUTER * theRouter
Definition: pns_router.cpp:59

References PNS::theRouter.

◆ GetInterface()

ROUTER_IFACE* PNS::ROUTER::GetInterface ( ) const
inline

Definition at line 218 of file pns_router.h.

219  {
220  return m_iface;
221  }
ROUTER_IFACE * m_iface
Definition: pns_router.h:260

References m_iface.

◆ GetIterLimit()

int PNS::ROUTER::GetIterLimit ( ) const
inline

Definition at line 176 of file pns_router.h.

176 { return m_iterLimit; };
int m_iterLimit
Definition: pns_router.h:262

References m_iterLimit.

◆ GetRuleResolver()

RULE_RESOLVER* PNS::ROUTER::GetRuleResolver ( ) const
inline

Definition at line 163 of file pns_router.h.

164  {
165  return m_iface->GetRuleResolver();
166  }
virtual RULE_RESOLVER * GetRuleResolver()=0
ROUTER_IFACE * m_iface
Definition: pns_router.h:260

References PNS::ROUTER_IFACE::GetRuleResolver(), and m_iface.

Referenced by movePlacing(), and updateView().

◆ GetShapshotIter()

int PNS::ROUTER::GetShapshotIter ( ) const
inline

Definition at line 185 of file pns_router.h.

185 { return m_snapshotIter; }
int m_snapshotIter
Definition: pns_router.h:264

References m_snapshotIter.

◆ GetShowIntermediateSteps()

bool PNS::ROUTER::GetShowIntermediateSteps ( ) const
inline

Definition at line 184 of file pns_router.h.

184 { return m_showInterSteps; }
bool m_showInterSteps
Definition: pns_router.h:263

References m_showInterSteps.

◆ GetWorld()

◆ highlightCurrent()

void PNS::ROUTER::highlightCurrent ( bool  enabled)
private

◆ IsPlacingVia()

bool PNS::ROUTER::IsPlacingVia ( ) const

Definition at line 499 of file pns_router.cpp.

500 {
501  if( !m_placer )
502  return false;
503 
504  return m_placer->IsPlacingVia();
505 }
std::unique_ptr< PLACEMENT_ALGO > m_placer
Definition: pns_router.h:256

References m_placer.

Referenced by ROUTER_TOOL::onViaCommand(), ROUTER_TOOL::performRouting(), and PNS::TOOL_BASE::updateEndItem().

◆ isStartingPointRoutable()

bool PNS::ROUTER::isStartingPointRoutable ( const VECTOR2I aWhere,
int  aLayer 
)
private

Definition at line 158 of file pns_router.cpp.

159 {
160  if( Settings().CanViolateDRC() && Settings().Mode() == RM_MarkObstacles )
161  return true;
162 
163  auto candidates = QueryHoverItems( aWhere );
164 
165  for( ITEM* item : candidates.Items() )
166  {
167  if( ! item->IsRoutable() && item->Layers().Overlaps( aLayer ) )
168  {
169  return false;
170  }
171  }
172 
173  return true;
174 }
const ITEM_SET QueryHoverItems(const VECTOR2I &aP)
Definition: pns_router.cpp:118
ROUTER_MODE Mode() const
Definition: pns_router.h:124
ROUTING_SETTINGS & Settings()
Definition: pns_router.h:187

References Mode(), QueryHoverItems(), PNS::RM_MarkObstacles, and Settings().

Referenced by StartRouting().

◆ LoadSettings()

void PNS::ROUTER::LoadSettings ( const ROUTING_SETTINGS aSettings)
inline

Changes routing settings to ones passed in the parameter.

Parameters
aSettingsare the new settings.

Definition at line 201 of file pns_router.h.

202  {
203  m_settings = aSettings;
204  }
ROUTING_SETTINGS m_settings
Definition: pns_router.h:268

References m_settings.

Referenced by PNS::TOOL_BASE::Reset().

◆ markViolations()

void PNS::ROUTER::markViolations ( NODE aNode,
ITEM_SET aCurrent,
NODE::ITEM_VECTOR aRemoved 
)
private

Definition at line 262 of file pns_router.cpp.

263 {
264  for( ITEM* item : aCurrent.Items() )
265  {
266  NODE::OBSTACLES obstacles;
267 
268  aNode->QueryColliding( item, obstacles, ITEM::ANY_T );
269 
270  if( item->OfKind( ITEM::LINE_T ) )
271  {
272  LINE* l = static_cast<LINE*>( item );
273 
274  if( l->EndsWithVia() )
275  {
276  VIA v( l->Via() );
277  aNode->QueryColliding( &v, obstacles, ITEM::ANY_T );
278  }
279  }
280 
281  for( OBSTACLE& obs : obstacles )
282  {
283  int clearance = aNode->GetClearance( item, obs.m_item );
284  std::unique_ptr<ITEM> tmp( obs.m_item->Clone() );
285  tmp->Mark( MK_VIOLATION );
286  m_iface->DisplayItem( tmp.get(), -1, clearance );
287  aRemoved.push_back( obs.m_item );
288  }
289  }
290 }
virtual void DisplayItem(const ITEM *aItem, int aColor=-1, int aClearance=-1, bool aEdit=false)=0
ROUTER_IFACE * m_iface
Definition: pns_router.h:260
virtual int GetClearance(BOARD_CONNECTED_ITEM *aItem=NULL) const override
Function GetClearance returns the clearance in internal units.
std::vector< OBSTACLE > OBSTACLES
Definition: pns_node.h:141

References PNS::ITEM::ANY_T, PNS::ROUTER_IFACE::DisplayItem(), PNS::LINE::EndsWithVia(), PNS::NODE::GetClearance(), PNS::ITEM_SET::Items(), PNS::ITEM::LINE_T, m_iface, PNS::MK_VIOLATION, PNS::NODE::QueryColliding(), and PNS::LINE::Via().

Referenced by updateView().

◆ Mode()

ROUTER_MODE PNS::ROUTER::Mode ( ) const
inline

Definition at line 124 of file pns_router.h.

124 { return m_mode; }
ROUTER_MODE m_mode
Definition: pns_router.h:270

References m_mode.

Referenced by isStartingPointRoutable(), LENGTH_TUNER_TOOL::meanderSettingsDialog(), and updateView().

◆ Move()

void PNS::ROUTER::Move ( const VECTOR2I aP,
ITEM aItem 
)

Definition at line 231 of file pns_router.cpp.

232 {
233  m_currentEnd = aP;
234 
235  switch( m_state )
236  {
237  case ROUTE_TRACK:
238  movePlacing( aP, endItem );
239  break;
240 
241  case DRAG_SEGMENT:
242  moveDragging( aP, endItem );
243  break;
244 
245  default:
246  break;
247  }
248 }
void moveDragging(const VECTOR2I &aP, ITEM *aItem)
Definition: pns_router.cpp:251
VECTOR2I m_currentEnd
Definition: pns_router.h:250
RouterState m_state
Definition: pns_router.h:251
void movePlacing(const VECTOR2I &aP, ITEM *aItem)
Definition: pns_router.cpp:330

References DRAG_SEGMENT, m_currentEnd, m_state, moveDragging(), movePlacing(), and ROUTE_TRACK.

Referenced by ROUTER_TOOL::InlineDrag(), ROUTER_TOOL::onTrackViaSizeChanged(), ROUTER_TOOL::onViaCommand(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), and LENGTH_TUNER_TOOL::performTuning().

◆ moveDragging()

void PNS::ROUTER::moveDragging ( const VECTOR2I aP,
ITEM aItem 
)
private

Definition at line 251 of file pns_router.cpp.

252 {
253  m_iface->EraseView();
254 
255  m_dragger->Drag( aP );
256  ITEM_SET dragged = m_dragger->Traces();
257 
258  updateView( m_dragger->CurrentNode(), dragged, true );
259 }
void updateView(NODE *aNode, ITEM_SET &aCurrent, bool aDragging=false)
Definition: pns_router.cpp:293
ROUTER_IFACE * m_iface
Definition: pns_router.h:260
std::unique_ptr< DRAGGER > m_dragger
Definition: pns_router.h:257
virtual void EraseView()=0

References PNS::ROUTER_IFACE::EraseView(), m_dragger, m_iface, and updateView().

Referenced by Move().

◆ movePlacing()

void PNS::ROUTER::movePlacing ( const VECTOR2I aP,
ITEM aItem 
)
private

Definition at line 330 of file pns_router.cpp.

331 {
332  m_iface->EraseView();
333 
334  m_placer->Move( aP, aEndItem );
335  ITEM_SET current = m_placer->Traces();
336 
337  for( const ITEM* item : current.CItems() )
338  {
339  if( !item->OfKind( ITEM::LINE_T ) )
340  continue;
341 
342  const LINE* l = static_cast<const LINE*>( item );
343  int clearance = GetRuleResolver()->Clearance( item->Net() );
344 
345  m_iface->DisplayItem( l, -1, clearance );
346 
347  if( l->EndsWithVia() )
348  m_iface->DisplayItem( &l->Via(), -1, clearance );
349  }
350 
351  //ITEM_SET tmp( &current );
352 
353  updateView( m_placer->CurrentNode( true ), current );
354 }
RULE_RESOLVER * GetRuleResolver() const
Definition: pns_router.h:163
void updateView(NODE *aNode, ITEM_SET &aCurrent, bool aDragging=false)
Definition: pns_router.cpp:293
virtual int Clearance(const ITEM *aA, const ITEM *aB) const =0
std::unique_ptr< PLACEMENT_ALGO > m_placer
Definition: pns_router.h:256
virtual void DisplayItem(const ITEM *aItem, int aColor=-1, int aClearance=-1, bool aEdit=false)=0
ROUTER_IFACE * m_iface
Definition: pns_router.h:260
virtual void EraseView()=0

References PNS::ITEM_SET::CItems(), PNS::RULE_RESOLVER::Clearance(), PNS::ROUTER_IFACE::DisplayItem(), PNS::LINE::EndsWithVia(), PNS::ROUTER_IFACE::EraseView(), GetRuleResolver(), PNS::ITEM::LINE_T, m_iface, m_placer, updateView(), and PNS::LINE::Via().

Referenced by Move().

◆ pickSingleItem()

ITEM* PNS::ROUTER::pickSingleItem ( ITEM_SET aItems) const
private

◆ Placer()

PLACEMENT_ALGO* PNS::ROUTER::Placer ( )
inline

Definition at line 216 of file pns_router.h.

216 { return m_placer.get(); }
std::unique_ptr< PLACEMENT_ALGO > m_placer
Definition: pns_router.h:256

References m_placer.

Referenced by LENGTH_TUNER_TOOL::meanderSettingsDialog(), LENGTH_TUNER_TOOL::performTuning(), and PNS_TUNE_STATUS_POPUP::UpdateStatus().

◆ QueryHoverItems()

const ITEM_SET PNS::ROUTER::QueryHoverItems ( const VECTOR2I aP)

Definition at line 118 of file pns_router.cpp.

119 {
120  if( m_state == IDLE || m_placer == nullptr )
121  return m_world->HitTest( aP );
122  else
123  return m_placer->CurrentNode()->HitTest( aP );
124 }
std::unique_ptr< NODE > m_world
Definition: pns_router.h:253
std::unique_ptr< PLACEMENT_ALGO > m_placer
Definition: pns_router.h:256
RouterState m_state
Definition: pns_router.h:251

References IDLE, m_placer, m_state, and m_world.

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

◆ QueryItemByParent()

ITEM* PNS::ROUTER::QueryItemByParent ( const BOARD_ITEM aItem) const

◆ RoutingInProgress()

bool PNS::ROUTER::RoutingInProgress ( ) const

◆ SetFailureReason()

void PNS::ROUTER::SetFailureReason ( const wxString &  aReason)
inline

◆ SetInterface()

void PNS::ROUTER::SetInterface ( ROUTER_IFACE aIface)

Definition at line 523 of file pns_router.cpp.

524 {
525  m_iface = aIface;
526  m_iface->SetRouter( this );
527 }
ROUTER_IFACE * m_iface
Definition: pns_router.h:260
virtual void SetRouter(ROUTER *aRouter)=0

References m_iface, and PNS::ROUTER_IFACE::SetRouter().

Referenced by PNS::TOOL_BASE::Reset().

◆ SetIterLimit()

void PNS::ROUTER::SetIterLimit ( int  aX)
inline

Definition at line 175 of file pns_router.h.

175 { m_iterLimit = aX; }
int m_iterLimit
Definition: pns_router.h:262

References m_iterLimit.

◆ SetMode()

void PNS::ROUTER::SetMode ( ROUTER_MODE  aMode)

Definition at line 517 of file pns_router.cpp.

518 {
519  m_mode = aMode;
520 }
ROUTER_MODE m_mode
Definition: pns_router.h:270

References m_mode.

Referenced by LENGTH_TUNER_TOOL::mainLoop(), and ROUTER_TOOL::mainLoop().

◆ SetOrthoMode()

void PNS::ROUTER::SetOrthoMode ( bool  aEnable)

Definition at line 508 of file pns_router.cpp.

509 {
510  if( !m_placer )
511  return;
512 
513  m_placer->SetOrthoMode( aEnable );
514 }
std::unique_ptr< PLACEMENT_ALGO > m_placer
Definition: pns_router.h:256

References m_placer.

Referenced by ROUTER_TOOL::performRouting().

◆ SetShowIntermediateSteps()

void PNS::ROUTER::SetShowIntermediateSteps ( bool  aX,
int  aSnapshotIter = -1 
)
inline

Definition at line 178 of file pns_router.h.

179  {
180  m_showInterSteps = aX;
181  m_snapshotIter = aSnapshotIter;
182  }
int m_snapshotIter
Definition: pns_router.h:264
bool m_showInterSteps
Definition: pns_router.h:263

References m_showInterSteps, and m_snapshotIter.

◆ Settings()

◆ SetView()

void PNS::ROUTER::SetView ( KIGFX::VIEW aView)

◆ Sizes()

◆ SnapToItem()

const VECTOR2I PNS::ROUTER::SnapToItem ( ITEM aItem,
VECTOR2I  aP,
bool &  aSplitsSegment 
)

◆ splitAdjacentSegments()

void PNS::ROUTER::splitAdjacentSegments ( NODE aNode,
ITEM aSeg,
const VECTOR2I aP 
)
private

◆ StartDragging()

bool PNS::ROUTER::StartDragging ( const VECTOR2I aP,
ITEM aItem,
int  aDragMode = DM_ANY 
)

Definition at line 127 of file pns_router.cpp.

128 {
129 
130  if( aDragMode & DM_FREE_ANGLE )
132  else
133  m_forceMarkObstaclesMode = false;
134 
135  if( !aStartItem || aStartItem->OfKind( ITEM::SOLID_T ) )
136  return false;
137 
138  m_placer.reset( new LINE_PLACER( this ) );
139  m_placer->Start( aP, aStartItem );
140 
141  m_dragger.reset( new DRAGGER( this ) );
142  m_dragger->SetMode( aDragMode );
143  m_dragger->SetWorld( m_world.get() );
144  m_dragger->SetDebugDecorator ( m_iface->GetDebugDecorator () );
145 
146  if( m_dragger->Start ( aP, aStartItem ) )
148  else
149  {
150  m_dragger.reset();
151  m_state = IDLE;
152  return false;
153  }
154 
155  return true;
156 }
std::unique_ptr< NODE > m_world
Definition: pns_router.h:253
std::unique_ptr< PLACEMENT_ALGO > m_placer
Definition: pns_router.h:256
RouterState m_state
Definition: pns_router.h:251
ROUTER_IFACE * m_iface
Definition: pns_router.h:260
std::unique_ptr< DRAGGER > m_dragger
Definition: pns_router.h:257
virtual DEBUG_DECORATOR * GetDebugDecorator()=0
bool m_forceMarkObstaclesMode
Definition: pns_router.h:266

References PNS::DM_FREE_ANGLE, DRAG_SEGMENT, PNS::ROUTER_IFACE::GetDebugDecorator(), IDLE, m_dragger, m_forceMarkObstaclesMode, m_iface, m_placer, m_state, m_world, PNS::ITEM::OfKind(), and PNS::ITEM::SOLID_T.

Referenced by ROUTER_TOOL::InlineDrag(), and ROUTER_TOOL::performDragging().

◆ StartRouting()

bool PNS::ROUTER::StartRouting ( const VECTOR2I aP,
ITEM aItem,
int  aLayer 
)

Definition at line 176 of file pns_router.cpp.

177 {
178 
179  if( ! isStartingPointRoutable( aP, aLayer ) )
180  {
181  SetFailureReason( _("Cannot start routing inside a keepout area or board outline." ) );
182  return false;
183  }
184 
185  m_forceMarkObstaclesMode = false;
186 
187  switch( m_mode )
188  {
190  m_placer.reset( new LINE_PLACER( this ) );
191  break;
193  m_placer.reset( new DIFF_PAIR_PLACER( this ) );
194  break;
196  m_placer.reset( new MEANDER_PLACER( this ) );
197  break;
199  m_placer.reset( new DP_MEANDER_PLACER( this ) );
200  break;
202  m_placer.reset( new MEANDER_SKEW_PLACER( this ) );
203  break;
204 
205  default:
206  return false;
207  }
208 
209  m_placer->UpdateSizes ( m_sizes );
210  m_placer->SetLayer( aLayer );
211  m_placer->SetDebugDecorator ( m_iface->GetDebugDecorator () );
212 
213  bool rv = m_placer->Start( aP, aStartItem );
214 
215  if( !rv )
216  return false;
217 
218  m_currentEnd = aP;
220  return rv;
221 }
bool isStartingPointRoutable(const VECTOR2I &aWhere, int aLayer)
Definition: pns_router.cpp:158
VECTOR2I m_currentEnd
Definition: pns_router.h:250
std::unique_ptr< PLACEMENT_ALGO > m_placer
Definition: pns_router.h:256
void SetFailureReason(const wxString &aReason)
Definition: pns_router.h:213
RouterState m_state
Definition: pns_router.h:251
ROUTER_IFACE * m_iface
Definition: pns_router.h:260
virtual DEBUG_DECORATOR * GetDebugDecorator()=0
SIZES_SETTINGS m_sizes
Definition: pns_router.h:269
ROUTER_MODE m_mode
Definition: pns_router.h:270
bool m_forceMarkObstaclesMode
Definition: pns_router.h:266

References PNS::ROUTER_IFACE::GetDebugDecorator(), isStartingPointRoutable(), m_currentEnd, m_forceMarkObstaclesMode, m_iface, m_mode, m_placer, m_sizes, m_state, PNS::PNS_MODE_ROUTE_DIFF_PAIR, PNS::PNS_MODE_ROUTE_SINGLE, PNS::PNS_MODE_TUNE_DIFF_PAIR, PNS::PNS_MODE_TUNE_DIFF_PAIR_SKEW, PNS::PNS_MODE_TUNE_SINGLE, ROUTE_TRACK, and SetFailureReason().

Referenced by LENGTH_TUNER_TOOL::performTuning(), and ROUTER_TOOL::prepareInteractive().

◆ StopRouting()

void PNS::ROUTER::StopRouting ( )

Definition at line 399 of file pns_router.cpp.

400 {
401  // Update the ratsnest with new changes
402 
403  if( m_placer )
404  {
405  std::vector<int> nets;
406  m_placer->GetModifiedNets( nets );
407 
408  // Update the ratsnest with new changes
409  for ( auto n : nets )
410  m_iface->UpdateNet( n );
411  }
412 
413  if( !RoutingInProgress() )
414  return;
415 
416  m_placer.reset();
417  m_dragger.reset();
418 
419  m_iface->EraseView();
420 
421  m_state = IDLE;
422  m_world->KillChildren();
423  m_world->ClearRanks();
424 }
std::unique_ptr< NODE > m_world
Definition: pns_router.h:253
virtual void UpdateNet(int aNetCode)=0
std::unique_ptr< PLACEMENT_ALGO > m_placer
Definition: pns_router.h:256
RouterState m_state
Definition: pns_router.h:251
ROUTER_IFACE * m_iface
Definition: pns_router.h:260
std::unique_ptr< DRAGGER > m_dragger
Definition: pns_router.h:257
virtual void EraseView()=0
bool RoutingInProgress() const
Definition: pns_router.cpp:112

References PNS::ROUTER_IFACE::EraseView(), IDLE, m_dragger, m_iface, m_placer, m_state, m_world, RoutingInProgress(), and PNS::ROUTER_IFACE::UpdateNet().

Referenced by ROUTER_TOOL::finishInteractive(), FixRoute(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), ROUTER_TOOL::performDragging(), and LENGTH_TUNER_TOOL::performTuning().

◆ SwitchLayer()

void PNS::ROUTER::SwitchLayer ( int  layer)

Definition at line 436 of file pns_router.cpp.

437 {
438  switch( m_state )
439  {
440  case ROUTE_TRACK:
441  m_placer->SetLayer( aLayer );
442  break;
443  default:
444  break;
445  }
446 }
std::unique_ptr< PLACEMENT_ALGO > m_placer
Definition: pns_router.h:256
RouterState m_state
Definition: pns_router.h:251

References m_placer, m_state, and ROUTE_TRACK.

Referenced by ROUTER_TOOL::performRouting(), and ROUTER_TOOL::switchLayerOnViaPlacement().

◆ syncPad()

ITEM* PNS::ROUTER::syncPad ( D_PAD aPad)
private

◆ syncTrack()

ITEM* PNS::ROUTER::syncTrack ( TRACK aTrack)
private

◆ syncVia()

ITEM* PNS::ROUTER::syncVia ( VIA aVia)
private

◆ SyncWorld()

void PNS::ROUTER::SyncWorld ( )

Definition at line 91 of file pns_router.cpp.

92 {
93  ClearWorld();
94 
95  m_world = std::unique_ptr<NODE>( new NODE );
96  m_iface->SyncWorld( m_world.get() );
97 
98 }
void ClearWorld()
Definition: pns_router.cpp:100
std::unique_ptr< NODE > m_world
Definition: pns_router.h:253
virtual void SyncWorld(NODE *aNode)=0
ROUTER_IFACE * m_iface
Definition: pns_router.h:260

References ClearWorld(), m_iface, m_world, and PNS::ROUTER_IFACE::SyncWorld().

Referenced by ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), ROUTER_TOOL::mainLoop(), and PNS::TOOL_BASE::Reset().

◆ ToggleViaPlacement()

void PNS::ROUTER::ToggleViaPlacement ( )

Definition at line 449 of file pns_router.cpp.

450 {
451  if( m_state == ROUTE_TRACK )
452  {
453  bool toggle = !m_placer->IsPlacingVia();
454  m_placer->ToggleVia( toggle );
455  }
456 }
std::unique_ptr< PLACEMENT_ALGO > m_placer
Definition: pns_router.h:256
RouterState m_state
Definition: pns_router.h:251

References m_placer, m_state, and ROUTE_TRACK.

Referenced by ROUTER_TOOL::onViaCommand().

◆ UpdateSizes()

void PNS::ROUTER::UpdateSizes ( const SIZES_SETTINGS aSizes)

Applies stored settings.

See also
Settings()

Definition at line 318 of file pns_router.cpp.

319 {
320  m_sizes = aSizes;
321 
322  // Change track/via size settings
323  if( m_state == ROUTE_TRACK)
324  {
325  m_placer->UpdateSizes( m_sizes );
326  }
327 }
std::unique_ptr< PLACEMENT_ALGO > m_placer
Definition: pns_router.h:256
RouterState m_state
Definition: pns_router.h:251
SIZES_SETTINGS m_sizes
Definition: pns_router.h:269

References m_placer, m_sizes, m_state, and ROUTE_TRACK.

Referenced by ROUTER_TOOL::DpDimensionsDialog(), ROUTER_TOOL::onTrackViaSizeChanged(), ROUTER_TOOL::onViaCommand(), ROUTER_TOOL::prepareInteractive(), and PNS::TOOL_BASE::Reset().

◆ updateView()

void PNS::ROUTER::updateView ( NODE aNode,
ITEM_SET aCurrent,
bool  aDragging = false 
)
private

Definition at line 293 of file pns_router.cpp.

294 {
295  NODE::ITEM_VECTOR removed, added;
296  NODE::OBSTACLES obstacles;
297 
298  if( !aNode )
299  return;
300 
302  markViolations( aNode, aCurrent, removed );
303 
304  aNode->GetUpdatedItems( removed, added );
305 
306  for( auto item : added )
307  {
308  int clearance = GetRuleResolver()->Clearance( item->Net() );
309 
310  m_iface->DisplayItem( item, -1, clearance, aDragging );
311  }
312 
313  for( auto item : removed )
314  m_iface->HideItem( item );
315 }
RULE_RESOLVER * GetRuleResolver() const
Definition: pns_router.h:163
virtual void HideItem(ITEM *aItem)=0
virtual int Clearance(const ITEM *aA, const ITEM *aB) const =0
virtual void DisplayItem(const ITEM *aItem, int aColor=-1, int aClearance=-1, bool aEdit=false)=0
ROUTER_IFACE * m_iface
Definition: pns_router.h:260
std::vector< OBSTACLE > OBSTACLES
Definition: pns_node.h:141
ROUTER_MODE Mode() const
Definition: pns_router.h:124
ROUTING_SETTINGS & Settings()
Definition: pns_router.h:187
bool m_forceMarkObstaclesMode
Definition: pns_router.h:266
std::vector< ITEM * > ITEM_VECTOR
Definition: pns_node.h:140
void markViolations(NODE *aNode, ITEM_SET &aCurrent, NODE::ITEM_VECTOR &aRemoved)
Definition: pns_router.cpp:262

References PNS::RULE_RESOLVER::Clearance(), PNS::ROUTER_IFACE::DisplayItem(), GetRuleResolver(), PNS::NODE::GetUpdatedItems(), PNS::ROUTER_IFACE::HideItem(), m_forceMarkObstaclesMode, m_iface, markViolations(), Mode(), PNS::RM_MarkObstacles, and Settings().

Referenced by moveDragging(), and movePlacing().

Member Data Documentation

◆ m_currentEnd

VECTOR2I PNS::ROUTER::m_currentEnd
private

Definition at line 250 of file pns_router.h.

Referenced by Move(), and StartRouting().

◆ m_dragger

std::unique_ptr< DRAGGER > PNS::ROUTER::m_dragger
private

Definition at line 257 of file pns_router.h.

Referenced by DumpLog(), FixRoute(), moveDragging(), StartDragging(), and StopRouting().

◆ m_failureReason

wxString PNS::ROUTER::m_failureReason
private

Definition at line 273 of file pns_router.h.

Referenced by FailureReason(), and SetFailureReason().

◆ m_forceMarkObstaclesMode

bool PNS::ROUTER::m_forceMarkObstaclesMode = false
private

Definition at line 266 of file pns_router.h.

Referenced by StartDragging(), StartRouting(), and updateView().

◆ m_iface

◆ m_iterLimit

int PNS::ROUTER::m_iterLimit
private

Definition at line 262 of file pns_router.h.

Referenced by GetIterLimit(), ROUTER(), and SetIterLimit().

◆ m_lastNode

NODE* PNS::ROUTER::m_lastNode
private

Definition at line 254 of file pns_router.h.

Referenced by ROUTER().

◆ m_mode

ROUTER_MODE PNS::ROUTER::m_mode
private

Definition at line 270 of file pns_router.h.

Referenced by Mode(), ROUTER(), SetMode(), and StartRouting().

◆ m_placer

◆ m_settings

ROUTING_SETTINGS PNS::ROUTER::m_settings
private

Definition at line 268 of file pns_router.h.

Referenced by LoadSettings(), and Settings().

◆ m_shove

std::unique_ptr< SHOVE > PNS::ROUTER::m_shove
private

Definition at line 258 of file pns_router.h.

◆ m_showInterSteps

bool PNS::ROUTER::m_showInterSteps
private

Definition at line 263 of file pns_router.h.

Referenced by GetShowIntermediateSteps(), ROUTER(), and SetShowIntermediateSteps().

◆ m_sizes

SIZES_SETTINGS PNS::ROUTER::m_sizes
private

Definition at line 269 of file pns_router.h.

Referenced by Sizes(), StartRouting(), and UpdateSizes().

◆ m_snapshotIter

int PNS::ROUTER::m_snapshotIter
private

Definition at line 264 of file pns_router.h.

Referenced by GetShapshotIter(), ROUTER(), and SetShowIntermediateSteps().

◆ m_state

◆ m_toolStatusbarName

wxString PNS::ROUTER::m_toolStatusbarName
private

Definition at line 272 of file pns_router.h.

◆ m_violation

bool PNS::ROUTER::m_violation
private

Definition at line 265 of file pns_router.h.

Referenced by ROUTER().

◆ m_world

std::unique_ptr< NODE > PNS::ROUTER::m_world
private

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