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)
 
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)
 
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)
 
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)
 

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

Enumerator
IDLE 
DRAG_SEGMENT 
ROUTE_TRACK 

Definition at line 111 of file pns_router.h.

Constructor & Destructor Documentation

PNS::ROUTER::ROUTER ( )

Definition at line 61 of file pns_router.cpp.

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

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:263
int m_iterLimit
Definition: pns_router.h:261
bool m_showInterSteps
Definition: pns_router.h:262
NODE * m_lastNode
Definition: pns_router.h:253
RouterState m_state
Definition: pns_router.h:250
ROUTER_IFACE * m_iface
Definition: pns_router.h:259
static ROUTER * theRouter
Definition: pns_router.cpp:59
bool m_violation
Definition: pns_router.h:264
ROUTER_MODE m_mode
Definition: pns_router.h:269
PNS::ROUTER::~ROUTER ( )

Definition at line 84 of file pns_router.cpp.

References ClearWorld().

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

Member Function Documentation

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

Definition at line 498 of file pns_router.cpp.

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

Referenced by ROUTER_TOOL::breakTrack().

499 {
500  NODE *node = m_world->Branch();
501 
502  LINE_PLACER placer( this );
503 
504  if ( placer.SplitAdjacentSegments( node, aItem, aP ) )
505  {
506  CommitRouting( node );
507  }
508  else
509  {
510  delete node;
511  }
512 
513 }
std::unique_ptr< NODE > m_world
Definition: pns_router.h:252
void CommitRouting(NODE *aNode)
Definition: pns_router.cpp:326
void PNS::ROUTER::clearViewFlags ( )
private
void PNS::ROUTER::ClearWorld ( )

Definition at line 100 of file pns_router.cpp.

References m_placer, and m_world.

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

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:252
std::unique_ptr< PLACEMENT_ALGO > m_placer
Definition: pns_router.h:255
void PNS::ROUTER::commitPad ( SOLID aPad)
private
void PNS::ROUTER::CommitRouting ( NODE aNode)

Definition at line 326 of file pns_router.cpp.

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().

327 {
328  NODE::ITEM_VECTOR removed, added;
329 
330  aNode->GetUpdatedItems( removed, added );
331 
332  for( auto item : removed )
333  m_iface->RemoveItem( item );
334 
335  for( auto item : added )
336  m_iface->AddItem( item );
337 
338  m_iface->Commit();
339  m_world->Commit( aNode );
340 }
virtual void AddItem(ITEM *aItem)=0
std::unique_ptr< NODE > m_world
Definition: pns_router.h:252
ROUTER_IFACE * m_iface
Definition: pns_router.h:259
virtual void Commit()=0
virtual void RemoveItem(ITEM *aItem)=0
std::vector< ITEM * > ITEM_VECTOR
Definition: pns_node.h:141
void PNS::ROUTER::commitSegment ( SEGMENT aTrack)
private
void PNS::ROUTER::commitVia ( VIA aVia)
private
void PNS::ROUTER::DeleteTraces ( ITEM aStartItem,
bool  aWholeTrack 
)
void PNS::ROUTER::DisplayItem ( const ITEM aItem,
int  aColor = -1,
int  aClearance = -1 
)
void PNS::ROUTER::DisplayItems ( const ITEM_SET aItems)

Definition at line 197 of file pns_router.cpp.

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

198 {
199  for( const ITEM* item : aItems.CItems() )
200  m_iface->DisplayItem( item );
201 }
ROUTER_IFACE * m_iface
Definition: pns_router.h:259
virtual void DisplayItem(const ITEM *aItem, int aColor=-1, int aClearance=-1)=0
void PNS::ROUTER::DumpLog ( )

Definition at line 445 of file pns_router.cpp.

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

Referenced by ROUTER_TOOL::handleCommonEvents().

446 {
447  LOGGER* logger = nullptr;
448 
449  switch( m_state )
450  {
451  case DRAG_SEGMENT:
452  logger = m_dragger->Logger();
453  break;
454 
455  case ROUTE_TRACK:
456  logger = m_placer->Logger();
457  break;
458 
459  default:
460  break;
461  }
462 
463  if( logger )
464  logger->Save( "/tmp/shove.log" );
465 }
std::unique_ptr< PLACEMENT_ALGO > m_placer
Definition: pns_router.h:255
RouterState m_state
Definition: pns_router.h:250
std::unique_ptr< DRAGGER > m_dragger
Definition: pns_router.h:256
void PNS::ROUTER::eraseView ( )
private
const wxString& PNS::ROUTER::FailureReason ( ) const
inline

Definition at line 214 of file pns_router.h.

References m_failureReason.

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

214 { return m_failureReason; }
wxString m_failureReason
Definition: pns_router.h:272
bool PNS::ROUTER::FixRoute ( const VECTOR2I aP,
ITEM aItem 
)

Definition at line 343 of file pns_router.cpp.

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().

344 {
345  bool rv = false;
346 
347  switch( m_state )
348  {
349  case ROUTE_TRACK:
350  rv = m_placer->FixRoute( aP, aEndItem );
351  break;
352 
353  case DRAG_SEGMENT:
354  rv = m_dragger->FixRoute();
355  break;
356 
357  default:
358  break;
359  }
360 
361  if( rv )
362  StopRouting();
363 
364  return rv;
365 }
std::unique_ptr< PLACEMENT_ALGO > m_placer
Definition: pns_router.h:255
RouterState m_state
Definition: pns_router.h:250
std::unique_ptr< DRAGGER > m_dragger
Definition: pns_router.h:256
void StopRouting()
Definition: pns_router.cpp:368
void PNS::ROUTER::FlipPosture ( )

Definition at line 396 of file pns_router.cpp.

References m_placer, m_state, and ROUTE_TRACK.

Referenced by ROUTER_TOOL::performRouting().

397 {
398  if( m_state == ROUTE_TRACK )
399  {
400  m_placer->FlipPosture();
401  }
402 }
std::unique_ptr< PLACEMENT_ALGO > m_placer
Definition: pns_router.h:255
RouterState m_state
Definition: pns_router.h:250
int PNS::ROUTER::GetClearance ( const ITEM aA,
const ITEM aB 
) const
int PNS::ROUTER::GetCurrentLayer ( ) const

Definition at line 437 of file pns_router.cpp.

References m_placer.

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

438 {
439  if( m_placer )
440  return m_placer->CurrentLayer();
441  return -1;
442 }
std::unique_ptr< PLACEMENT_ALGO > m_placer
Definition: pns_router.h:255
const std::vector< int > PNS::ROUTER::GetCurrentNets ( ) const

Definition at line 428 of file pns_router.cpp.

References m_placer.

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

429 {
430  if( m_placer )
431  return m_placer->CurrentNets();
432 
433  return std::vector<int>();
434 }
std::unique_ptr< PLACEMENT_ALGO > m_placer
Definition: pns_router.h:255
ROUTER * PNS::ROUTER::GetInstance ( )
static

Definition at line 78 of file pns_router.cpp.

References PNS::theRouter.

79 {
80  return theRouter;
81 }
static ROUTER * theRouter
Definition: pns_router.cpp:59
ROUTER_IFACE* PNS::ROUTER::GetInterface ( ) const
inline

Definition at line 218 of file pns_router.h.

References m_iface.

219  {
220  return m_iface;
221  }
ROUTER_IFACE * m_iface
Definition: pns_router.h:259
int PNS::ROUTER::GetIterLimit ( ) const
inline

Definition at line 176 of file pns_router.h.

References m_iterLimit.

176 { return m_iterLimit; };
int m_iterLimit
Definition: pns_router.h:261
RULE_RESOLVER* PNS::ROUTER::GetRuleResolver ( ) const
inline

Definition at line 163 of file pns_router.h.

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

Referenced by PNS::DIFF_PAIR_PLACER::attemptWalk(), and movePlacing().

164  {
165  return m_iface->GetRuleResolver();
166  }
virtual RULE_RESOLVER * GetRuleResolver()=0
ROUTER_IFACE * m_iface
Definition: pns_router.h:259
int PNS::ROUTER::GetShapshotIter ( ) const
inline

Definition at line 185 of file pns_router.h.

References m_snapshotIter.

185 { return m_snapshotIter; }
int m_snapshotIter
Definition: pns_router.h:263
bool PNS::ROUTER::GetShowIntermediateSteps ( ) const
inline

Definition at line 184 of file pns_router.h.

References m_showInterSteps.

184 { return m_showInterSteps; }
bool m_showInterSteps
Definition: pns_router.h:262
void PNS::ROUTER::highlightCurrent ( bool  enabled)
private
bool PNS::ROUTER::IsPlacingVia ( ) const

Definition at line 468 of file pns_router.cpp.

References m_placer.

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

469 {
470  if( !m_placer )
471  return false;
472 
473  return m_placer->IsPlacingVia();
474 }
std::unique_ptr< PLACEMENT_ALGO > m_placer
Definition: pns_router.h:255
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.

References m_settings.

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

202  {
203  m_settings = aSettings;
204  }
ROUTING_SETTINGS m_settings
Definition: pns_router.h:267
void PNS::ROUTER::markViolations ( NODE aNode,
ITEM_SET aCurrent,
NODE::ITEM_VECTOR aRemoved 
)
private

Definition at line 235 of file pns_router.cpp.

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().

236 {
237  for( ITEM* item : aCurrent.Items() )
238  {
239  NODE::OBSTACLES obstacles;
240 
241  aNode->QueryColliding( item, obstacles, ITEM::ANY_T );
242 
243  if( item->OfKind( ITEM::LINE_T ) )
244  {
245  LINE* l = static_cast<LINE*>( item );
246 
247  if( l->EndsWithVia() )
248  {
249  VIA v( l->Via() );
250  aNode->QueryColliding( &v, obstacles, ITEM::ANY_T );
251  }
252  }
253 
254  for( OBSTACLE& obs : obstacles )
255  {
256  int clearance = aNode->GetClearance( item, obs.m_item );
257  std::unique_ptr<ITEM> tmp( obs.m_item->Clone() );
258  tmp->Mark( MK_VIOLATION );
259  m_iface->DisplayItem( tmp.get(), -1, clearance );
260  aRemoved.push_back( obs.m_item );
261  }
262  }
263 }
ROUTER_IFACE * m_iface
Definition: pns_router.h:259
virtual int GetClearance(BOARD_CONNECTED_ITEM *aItem=NULL) const override
Function GetClearance returns the clearance in internal units.
virtual void DisplayItem(const ITEM *aItem, int aColor=-1, int aClearance=-1)=0
std::vector< OBSTACLE > OBSTACLES
Definition: pns_node.h:142
ROUTER_MODE PNS::ROUTER::Mode ( ) const
inline

Definition at line 124 of file pns_router.h.

References m_mode.

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

124 { return m_mode; }
ROUTER_MODE m_mode
Definition: pns_router.h:269
void PNS::ROUTER::Move ( const VECTOR2I aP,
ITEM aItem 
)

Definition at line 204 of file pns_router.cpp.

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

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

205 {
206  m_currentEnd = aP;
207 
208  switch( m_state )
209  {
210  case ROUTE_TRACK:
211  movePlacing( aP, endItem );
212  break;
213 
214  case DRAG_SEGMENT:
215  moveDragging( aP, endItem );
216  break;
217 
218  default:
219  break;
220  }
221 }
void moveDragging(const VECTOR2I &aP, ITEM *aItem)
Definition: pns_router.cpp:224
VECTOR2I m_currentEnd
Definition: pns_router.h:249
RouterState m_state
Definition: pns_router.h:250
void movePlacing(const VECTOR2I &aP, ITEM *aItem)
Definition: pns_router.cpp:299
void PNS::ROUTER::moveDragging ( const VECTOR2I aP,
ITEM aItem 
)
private

Definition at line 224 of file pns_router.cpp.

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

Referenced by Move().

225 {
226  m_iface->EraseView();
227 
228  m_dragger->Drag( aP );
229  ITEM_SET dragged = m_dragger->Traces();
230 
231  updateView( m_dragger->CurrentNode(), dragged );
232 }
void updateView(NODE *aNode, ITEM_SET &aCurrent)
Definition: pns_router.cpp:266
ROUTER_IFACE * m_iface
Definition: pns_router.h:259
std::unique_ptr< DRAGGER > m_dragger
Definition: pns_router.h:256
virtual void EraseView()=0
void PNS::ROUTER::movePlacing ( const VECTOR2I aP,
ITEM aItem 
)
private

Definition at line 299 of file pns_router.cpp.

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().

300 {
301  m_iface->EraseView();
302 
303  m_placer->Move( aP, aEndItem );
304  ITEM_SET current = m_placer->Traces();
305 
306  for( const ITEM* item : current.CItems() )
307  {
308  if( !item->OfKind( ITEM::LINE_T ) )
309  continue;
310 
311  const LINE* l = static_cast<const LINE*>( item );
312  int clearance = GetRuleResolver()->Clearance( item->Net() );
313 
314  m_iface->DisplayItem( l, -1, clearance );
315 
316  if( l->EndsWithVia() )
317  m_iface->DisplayItem( &l->Via(), -1, clearance );
318  }
319 
320  //ITEM_SET tmp( &current );
321 
322  updateView( m_placer->CurrentNode( true ), current );
323 }
void updateView(NODE *aNode, ITEM_SET &aCurrent)
Definition: pns_router.cpp:266
virtual int Clearance(const ITEM *aA, const ITEM *aB) const =0
std::unique_ptr< PLACEMENT_ALGO > m_placer
Definition: pns_router.h:255
ROUTER_IFACE * m_iface
Definition: pns_router.h:259
virtual void EraseView()=0
RULE_RESOLVER * GetRuleResolver() const
Definition: pns_router.h:163
virtual void DisplayItem(const ITEM *aItem, int aColor=-1, int aClearance=-1)=0
ITEM* PNS::ROUTER::pickSingleItem ( ITEM_SET aItems) const
private
PLACEMENT_ALGO* PNS::ROUTER::Placer ( )
inline

Definition at line 216 of file pns_router.h.

References m_placer.

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

216 { return m_placer.get(); }
std::unique_ptr< PLACEMENT_ALGO > m_placer
Definition: pns_router.h:255
const ITEM_SET PNS::ROUTER::QueryHoverItems ( const VECTOR2I aP)

Definition at line 118 of file pns_router.cpp.

References IDLE, m_placer, m_state, and m_world.

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

119 {
120  if( m_state == IDLE )
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:252
std::unique_ptr< PLACEMENT_ALGO > m_placer
Definition: pns_router.h:255
RouterState m_state
Definition: pns_router.h:250
ITEM* PNS::ROUTER::QueryItemByParent ( const BOARD_ITEM aItem) const
bool PNS::ROUTER::RoutingInProgress ( ) const

Definition at line 112 of file pns_router.cpp.

References IDLE, and m_state.

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

113 {
114  return m_state != IDLE;
115 }
RouterState m_state
Definition: pns_router.h:250
void PNS::ROUTER::SetFailureReason ( const wxString &  aReason)
inline
void PNS::ROUTER::SetInterface ( ROUTER_IFACE aIface)

Definition at line 492 of file pns_router.cpp.

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

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

493 {
494  m_iface = aIface;
495  m_iface->SetRouter( this );
496 }
ROUTER_IFACE * m_iface
Definition: pns_router.h:259
virtual void SetRouter(ROUTER *aRouter)=0
void PNS::ROUTER::SetIterLimit ( int  aX)
inline

Definition at line 175 of file pns_router.h.

References m_iterLimit.

175 { m_iterLimit = aX; }
int m_iterLimit
Definition: pns_router.h:261
void PNS::ROUTER::SetMode ( ROUTER_MODE  aMode)

Definition at line 486 of file pns_router.cpp.

References m_mode.

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

487 {
488  m_mode = aMode;
489 }
ROUTER_MODE m_mode
Definition: pns_router.h:269
void PNS::ROUTER::SetOrthoMode ( bool  aEnable)

Definition at line 477 of file pns_router.cpp.

References m_placer.

Referenced by ROUTER_TOOL::performRouting().

478 {
479  if( !m_placer )
480  return;
481 
482  m_placer->SetOrthoMode( aEnable );
483 }
std::unique_ptr< PLACEMENT_ALGO > m_placer
Definition: pns_router.h:255
void PNS::ROUTER::SetShowIntermediateSteps ( bool  aX,
int  aSnapshotIter = -1 
)
inline

Definition at line 178 of file pns_router.h.

References m_showInterSteps, and m_snapshotIter.

179  {
180  m_showInterSteps = aX;
181  m_snapshotIter = aSnapshotIter;
182  }
int m_snapshotIter
Definition: pns_router.h:263
bool m_showInterSteps
Definition: pns_router.h:262
void PNS::ROUTER::SetView ( KIGFX::VIEW aView)
const VECTOR2I PNS::ROUTER::SnapToItem ( ITEM aItem,
VECTOR2I  aP,
bool &  aSplitsSegment 
)
void PNS::ROUTER::splitAdjacentSegments ( NODE aNode,
ITEM aSeg,
const VECTOR2I aP 
)
private
bool PNS::ROUTER::StartDragging ( const VECTOR2I aP,
ITEM aItem,
int  aDragMode = DM_ANY 
)

Definition at line 127 of file pns_router.cpp.

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

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

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_dragger.reset( new DRAGGER( this ) );
139  m_dragger->SetMode( aDragMode );
140  m_dragger->SetWorld( m_world.get() );
141  m_dragger->SetDebugDecorator ( m_iface->GetDebugDecorator () );
142 
143  if( m_dragger->Start ( aP, aStartItem ) )
145  else
146  {
147  m_dragger.reset();
148  m_state = IDLE;
149  return false;
150  }
151 
152  return true;
153 }
std::unique_ptr< NODE > m_world
Definition: pns_router.h:252
RouterState m_state
Definition: pns_router.h:250
ROUTER_IFACE * m_iface
Definition: pns_router.h:259
std::unique_ptr< DRAGGER > m_dragger
Definition: pns_router.h:256
virtual DEBUG_DECORATOR * GetDebugDecorator()=0
bool m_forceMarkObstaclesMode
Definition: pns_router.h:265
bool PNS::ROUTER::StartRouting ( const VECTOR2I aP,
ITEM aItem,
int  aLayer 
)

Definition at line 156 of file pns_router.cpp.

References PNS::ROUTER_IFACE::GetDebugDecorator(), 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, and ROUTE_TRACK.

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

157 {
158  m_forceMarkObstaclesMode = false;
159 
160  switch( m_mode )
161  {
163  m_placer.reset( new LINE_PLACER( this ) );
164  break;
166  m_placer.reset( new DIFF_PAIR_PLACER( this ) );
167  break;
169  m_placer.reset( new MEANDER_PLACER( this ) );
170  break;
172  m_placer.reset( new DP_MEANDER_PLACER( this ) );
173  break;
175  m_placer.reset( new MEANDER_SKEW_PLACER( this ) );
176  break;
177 
178  default:
179  return false;
180  }
181 
182  m_placer->UpdateSizes ( m_sizes );
183  m_placer->SetLayer( aLayer );
184  m_placer->SetDebugDecorator ( m_iface->GetDebugDecorator () );
185 
186  bool rv = m_placer->Start( aP, aStartItem );
187 
188  if( !rv )
189  return false;
190 
191  m_currentEnd = aP;
193  return rv;
194 }
VECTOR2I m_currentEnd
Definition: pns_router.h:249
std::unique_ptr< PLACEMENT_ALGO > m_placer
Definition: pns_router.h:255
RouterState m_state
Definition: pns_router.h:250
ROUTER_IFACE * m_iface
Definition: pns_router.h:259
virtual DEBUG_DECORATOR * GetDebugDecorator()=0
SIZES_SETTINGS m_sizes
Definition: pns_router.h:268
ROUTER_MODE m_mode
Definition: pns_router.h:269
bool m_forceMarkObstaclesMode
Definition: pns_router.h:265
void PNS::ROUTER::StopRouting ( )

Definition at line 368 of file pns_router.cpp.

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::InlineDrag(), ROUTER_TOOL::performDragging(), and LENGTH_TUNER_TOOL::performTuning().

369 {
370  // Update the ratsnest with new changes
371 
372  if( m_placer )
373  {
374  std::vector<int> nets;
375  m_placer->GetModifiedNets( nets );
376 
377  // Update the ratsnest with new changes
378  for ( auto n : nets )
379  m_iface->UpdateNet( n );
380  }
381 
382  if( !RoutingInProgress() )
383  return;
384 
385  m_placer.reset();
386  m_dragger.reset();
387 
388  m_iface->EraseView();
389 
390  m_state = IDLE;
391  m_world->KillChildren();
392  m_world->ClearRanks();
393 }
bool RoutingInProgress() const
Definition: pns_router.cpp:112
std::unique_ptr< NODE > m_world
Definition: pns_router.h:252
virtual void UpdateNet(int aNetCode)=0
std::unique_ptr< PLACEMENT_ALGO > m_placer
Definition: pns_router.h:255
RouterState m_state
Definition: pns_router.h:250
ROUTER_IFACE * m_iface
Definition: pns_router.h:259
std::unique_ptr< DRAGGER > m_dragger
Definition: pns_router.h:256
virtual void EraseView()=0
void PNS::ROUTER::SwitchLayer ( int  layer)

Definition at line 405 of file pns_router.cpp.

References m_placer, m_state, and ROUTE_TRACK.

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

406 {
407  switch( m_state )
408  {
409  case ROUTE_TRACK:
410  m_placer->SetLayer( aLayer );
411  break;
412  default:
413  break;
414  }
415 }
std::unique_ptr< PLACEMENT_ALGO > m_placer
Definition: pns_router.h:255
RouterState m_state
Definition: pns_router.h:250
ITEM* PNS::ROUTER::syncPad ( D_PAD aPad)
private
ITEM* PNS::ROUTER::syncTrack ( TRACK aTrack)
private
ITEM* PNS::ROUTER::syncVia ( VIA aVia)
private
void PNS::ROUTER::SyncWorld ( )

Definition at line 91 of file pns_router.cpp.

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

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

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:252
virtual void SyncWorld(NODE *aNode)=0
ROUTER_IFACE * m_iface
Definition: pns_router.h:259
void PNS::ROUTER::ToggleViaPlacement ( )

Definition at line 418 of file pns_router.cpp.

References m_placer, m_state, and ROUTE_TRACK.

Referenced by ROUTER_TOOL::onViaCommand().

419 {
420  if( m_state == ROUTE_TRACK )
421  {
422  bool toggle = !m_placer->IsPlacingVia();
423  m_placer->ToggleVia( toggle );
424  }
425 }
std::unique_ptr< PLACEMENT_ALGO > m_placer
Definition: pns_router.h:255
RouterState m_state
Definition: pns_router.h:250
void PNS::ROUTER::UpdateSizes ( const SIZES_SETTINGS aSizes)

Applies stored settings.

See also
Settings()

Definition at line 287 of file pns_router.cpp.

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().

288 {
289  m_sizes = aSizes;
290 
291  // Change track/via size settings
292  if( m_state == ROUTE_TRACK)
293  {
294  m_placer->UpdateSizes( m_sizes );
295  }
296 }
std::unique_ptr< PLACEMENT_ALGO > m_placer
Definition: pns_router.h:255
RouterState m_state
Definition: pns_router.h:250
SIZES_SETTINGS m_sizes
Definition: pns_router.h:268
void PNS::ROUTER::updateView ( NODE aNode,
ITEM_SET aCurrent 
)
private

Definition at line 266 of file pns_router.cpp.

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

Referenced by moveDragging(), and movePlacing().

267 {
268  NODE::ITEM_VECTOR removed, added;
269  NODE::OBSTACLES obstacles;
270 
271  if( !aNode )
272  return;
273 
275  markViolations( aNode, aCurrent, removed );
276 
277  aNode->GetUpdatedItems( removed, added );
278 
279  for( auto item : added )
280  m_iface->DisplayItem( item );
281 
282  for( auto item : removed )
283  m_iface->HideItem( item );
284 }
virtual void HideItem(ITEM *aItem)=0
ROUTER_IFACE * m_iface
Definition: pns_router.h:259
ROUTER_MODE Mode() const
Definition: pns_router.h:124
virtual void DisplayItem(const ITEM *aItem, int aColor=-1, int aClearance=-1)=0
std::vector< OBSTACLE > OBSTACLES
Definition: pns_node.h:142
ROUTING_SETTINGS & Settings()
Definition: pns_router.h:187
bool m_forceMarkObstaclesMode
Definition: pns_router.h:265
std::vector< ITEM * > ITEM_VECTOR
Definition: pns_node.h:141
void markViolations(NODE *aNode, ITEM_SET &aCurrent, NODE::ITEM_VECTOR &aRemoved)
Definition: pns_router.cpp:235

Member Data Documentation

VECTOR2I PNS::ROUTER::m_currentEnd
private

Definition at line 249 of file pns_router.h.

Referenced by Move(), and StartRouting().

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

Definition at line 256 of file pns_router.h.

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

wxString PNS::ROUTER::m_failureReason
private

Definition at line 272 of file pns_router.h.

Referenced by FailureReason(), and SetFailureReason().

bool PNS::ROUTER::m_forceMarkObstaclesMode = false
private

Definition at line 265 of file pns_router.h.

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

int PNS::ROUTER::m_iterLimit
private

Definition at line 261 of file pns_router.h.

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

NODE* PNS::ROUTER::m_lastNode
private

Definition at line 253 of file pns_router.h.

Referenced by ROUTER().

ROUTER_MODE PNS::ROUTER::m_mode
private

Definition at line 269 of file pns_router.h.

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

ROUTING_SETTINGS PNS::ROUTER::m_settings
private

Definition at line 267 of file pns_router.h.

Referenced by LoadSettings(), and Settings().

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

Definition at line 257 of file pns_router.h.

bool PNS::ROUTER::m_showInterSteps
private

Definition at line 262 of file pns_router.h.

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

SIZES_SETTINGS PNS::ROUTER::m_sizes
private

Definition at line 268 of file pns_router.h.

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

int PNS::ROUTER::m_snapshotIter
private

Definition at line 263 of file pns_router.h.

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

wxString PNS::ROUTER::m_toolStatusbarName
private

Definition at line 271 of file pns_router.h.

bool PNS::ROUTER::m_violation
private

Definition at line 264 of file pns_router.h.

Referenced by ROUTER().

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

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