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 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)
 
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
 
ROUTING_SETTINGS m_settings
 
SIZES_SETTINGS m_sizes
 
ROUTER_MODE m_mode
 
wxString m_toolStatusbarName
 
wxString m_failureReason
 

Detailed Description

Definition at line 100 of file pns_router.h.

Member Enumeration Documentation

Enumerator
IDLE 
DRAG_SEGMENT 
ROUTE_TRACK 

Definition at line 103 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:254
int m_iterLimit
Definition: pns_router.h:252
bool m_showInterSteps
Definition: pns_router.h:253
NODE * m_lastNode
Definition: pns_router.h:244
RouterState m_state
Definition: pns_router.h:241
ROUTER_IFACE * m_iface
Definition: pns_router.h:250
static ROUTER * theRouter
Definition: pns_router.cpp:59
bool m_violation
Definition: pns_router.h:255
ROUTER_MODE m_mode
Definition: pns_router.h:259
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::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:243
std::unique_ptr< PLACEMENT_ALGO > m_placer
Definition: pns_router.h:246
void PNS::ROUTER::commitPad ( SOLID aPad)
private
void PNS::ROUTER::CommitRouting ( NODE aNode)

Definition at line 317 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 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().

318 {
319  NODE::ITEM_VECTOR removed, added;
320 
321  aNode->GetUpdatedItems( removed, added );
322 
323  for( auto item : removed )
324  m_iface->RemoveItem( item );
325 
326  for( auto item : added )
327  m_iface->AddItem( item );
328 
329  m_iface->Commit();
330  m_world->Commit( aNode );
331 }
virtual void AddItem(ITEM *aItem)=0
std::unique_ptr< NODE > m_world
Definition: pns_router.h:243
ROUTER_IFACE * m_iface
Definition: pns_router.h:250
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 188 of file pns_router.cpp.

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

189 {
190  for( const ITEM* item : aItems.CItems() )
191  m_iface->DisplayItem( item );
192 }
ROUTER_IFACE * m_iface
Definition: pns_router.h:250
virtual void DisplayItem(const ITEM *aItem, int aColor=-1, int aClearance=-1)=0
void PNS::ROUTER::DumpLog ( )

Definition at line 436 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().

437 {
438  LOGGER* logger = nullptr;
439 
440  switch( m_state )
441  {
442  case DRAG_SEGMENT:
443  logger = m_dragger->Logger();
444  break;
445 
446  case ROUTE_TRACK:
447  logger = m_placer->Logger();
448  break;
449 
450  default:
451  break;
452  }
453 
454  if( logger )
455  logger->Save( "/tmp/shove.log" );
456 }
std::unique_ptr< PLACEMENT_ALGO > m_placer
Definition: pns_router.h:246
RouterState m_state
Definition: pns_router.h:241
std::unique_ptr< DRAGGER > m_dragger
Definition: pns_router.h:247
void PNS::ROUTER::eraseView ( )
private
const wxString& PNS::ROUTER::FailureReason ( ) const
inline

Definition at line 205 of file pns_router.h.

References m_failureReason.

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

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

Definition at line 334 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().

335 {
336  bool rv = false;
337 
338  switch( m_state )
339  {
340  case ROUTE_TRACK:
341  rv = m_placer->FixRoute( aP, aEndItem );
342  break;
343 
344  case DRAG_SEGMENT:
345  rv = m_dragger->FixRoute();
346  break;
347 
348  default:
349  break;
350  }
351 
352  if( rv )
353  StopRouting();
354 
355  return rv;
356 }
std::unique_ptr< PLACEMENT_ALGO > m_placer
Definition: pns_router.h:246
RouterState m_state
Definition: pns_router.h:241
std::unique_ptr< DRAGGER > m_dragger
Definition: pns_router.h:247
void StopRouting()
Definition: pns_router.cpp:359
void PNS::ROUTER::FlipPosture ( )

Definition at line 387 of file pns_router.cpp.

References m_placer, m_state, and ROUTE_TRACK.

Referenced by ROUTER_TOOL::performRouting().

388 {
389  if( m_state == ROUTE_TRACK )
390  {
391  m_placer->FlipPosture();
392  }
393 }
std::unique_ptr< PLACEMENT_ALGO > m_placer
Definition: pns_router.h:246
RouterState m_state
Definition: pns_router.h:241
int PNS::ROUTER::GetClearance ( const ITEM aA,
const ITEM aB 
) const
int PNS::ROUTER::GetCurrentLayer ( ) const

Definition at line 428 of file pns_router.cpp.

References m_placer.

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

429 {
430  if( m_placer )
431  return m_placer->CurrentLayer();
432  return -1;
433 }
std::unique_ptr< PLACEMENT_ALGO > m_placer
Definition: pns_router.h:246
const std::vector< int > PNS::ROUTER::GetCurrentNets ( ) const

Definition at line 419 of file pns_router.cpp.

References m_placer.

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

420 {
421  if( m_placer )
422  return m_placer->CurrentNets();
423 
424  return std::vector<int>();
425 }
std::unique_ptr< PLACEMENT_ALGO > m_placer
Definition: pns_router.h:246
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 209 of file pns_router.h.

References m_iface.

210  {
211  return m_iface;
212  }
ROUTER_IFACE * m_iface
Definition: pns_router.h:250
int PNS::ROUTER::GetIterLimit ( ) const
inline

Definition at line 167 of file pns_router.h.

References m_iterLimit.

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

Definition at line 154 of file pns_router.h.

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

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

155  {
156  return m_iface->GetRuleResolver();
157  }
virtual RULE_RESOLVER * GetRuleResolver()=0
ROUTER_IFACE * m_iface
Definition: pns_router.h:250
int PNS::ROUTER::GetShapshotIter ( ) const
inline

Definition at line 176 of file pns_router.h.

References m_snapshotIter.

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

Definition at line 175 of file pns_router.h.

References m_showInterSteps.

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

Definition at line 459 of file pns_router.cpp.

References m_placer.

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

460 {
461  if( !m_placer )
462  return false;
463 
464  return m_placer->IsPlacingVia();
465 }
std::unique_ptr< PLACEMENT_ALGO > m_placer
Definition: pns_router.h:246
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 192 of file pns_router.h.

References m_settings.

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

193  {
194  m_settings = aSettings;
195  }
ROUTING_SETTINGS m_settings
Definition: pns_router.h:257
void PNS::ROUTER::markViolations ( NODE aNode,
ITEM_SET aCurrent,
NODE::ITEM_VECTOR aRemoved 
)
private

Definition at line 226 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().

227 {
228  for( ITEM* item : aCurrent.Items() )
229  {
230  NODE::OBSTACLES obstacles;
231 
232  aNode->QueryColliding( item, obstacles, ITEM::ANY_T );
233 
234  if( item->OfKind( ITEM::LINE_T ) )
235  {
236  LINE* l = static_cast<LINE*>( item );
237 
238  if( l->EndsWithVia() )
239  {
240  VIA v( l->Via() );
241  aNode->QueryColliding( &v, obstacles, ITEM::ANY_T );
242  }
243  }
244 
245  for( OBSTACLE& obs : obstacles )
246  {
247  int clearance = aNode->GetClearance( item, obs.m_item );
248  std::unique_ptr<ITEM> tmp( obs.m_item->Clone() );
249  tmp->Mark( MK_VIOLATION );
250  m_iface->DisplayItem( tmp.get(), -1, clearance );
251  aRemoved.push_back( obs.m_item );
252  }
253  }
254 }
ROUTER_IFACE * m_iface
Definition: pns_router.h:250
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 116 of file pns_router.h.

References m_mode.

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

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

Definition at line 195 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().

196 {
197  m_currentEnd = aP;
198 
199  switch( m_state )
200  {
201  case ROUTE_TRACK:
202  movePlacing( aP, endItem );
203  break;
204 
205  case DRAG_SEGMENT:
206  moveDragging( aP, endItem );
207  break;
208 
209  default:
210  break;
211  }
212 }
void moveDragging(const VECTOR2I &aP, ITEM *aItem)
Definition: pns_router.cpp:215
VECTOR2I m_currentEnd
Definition: pns_router.h:240
RouterState m_state
Definition: pns_router.h:241
void movePlacing(const VECTOR2I &aP, ITEM *aItem)
Definition: pns_router.cpp:290
void PNS::ROUTER::moveDragging ( const VECTOR2I aP,
ITEM aItem 
)
private

Definition at line 215 of file pns_router.cpp.

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

Referenced by Move().

216 {
217  m_iface->EraseView();
218 
219  m_dragger->Drag( aP );
220  ITEM_SET dragged = m_dragger->Traces();
221 
222  updateView( m_dragger->CurrentNode(), dragged );
223 }
void updateView(NODE *aNode, ITEM_SET &aCurrent)
Definition: pns_router.cpp:257
ROUTER_IFACE * m_iface
Definition: pns_router.h:250
std::unique_ptr< DRAGGER > m_dragger
Definition: pns_router.h:247
virtual void EraseView()=0
void PNS::ROUTER::movePlacing ( const VECTOR2I aP,
ITEM aItem 
)
private

Definition at line 290 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().

291 {
292  m_iface->EraseView();
293 
294  m_placer->Move( aP, aEndItem );
295  ITEM_SET current = m_placer->Traces();
296 
297  for( const ITEM* item : current.CItems() )
298  {
299  if( !item->OfKind( ITEM::LINE_T ) )
300  continue;
301 
302  const LINE* l = static_cast<const LINE*>( item );
303  int clearance = GetRuleResolver()->Clearance( item->Net() );
304 
305  m_iface->DisplayItem( l, -1, clearance );
306 
307  if( l->EndsWithVia() )
308  m_iface->DisplayItem( &l->Via(), -1, clearance );
309  }
310 
311  //ITEM_SET tmp( &current );
312 
313  updateView( m_placer->CurrentNode( true ), current );
314 }
void updateView(NODE *aNode, ITEM_SET &aCurrent)
Definition: pns_router.cpp:257
virtual int Clearance(const ITEM *aA, const ITEM *aB) const =0
std::unique_ptr< PLACEMENT_ALGO > m_placer
Definition: pns_router.h:246
ROUTER_IFACE * m_iface
Definition: pns_router.h:250
virtual void EraseView()=0
RULE_RESOLVER * GetRuleResolver() const
Definition: pns_router.h:154
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 207 of file pns_router.h.

References m_placer.

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

207 { return m_placer.get(); }
std::unique_ptr< PLACEMENT_ALGO > m_placer
Definition: pns_router.h:246
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:243
std::unique_ptr< PLACEMENT_ALGO > m_placer
Definition: pns_router.h:246
RouterState m_state
Definition: pns_router.h:241
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:241
void PNS::ROUTER::SetFailureReason ( const wxString &  aReason)
inline
void PNS::ROUTER::SetInterface ( ROUTER_IFACE aIface)

Definition at line 483 of file pns_router.cpp.

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

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

484 {
485  m_iface = aIface;
486  m_iface->SetRouter( this );
487 }
ROUTER_IFACE * m_iface
Definition: pns_router.h:250
virtual void SetRouter(ROUTER *aRouter)=0
void PNS::ROUTER::SetIterLimit ( int  aX)
inline

Definition at line 166 of file pns_router.h.

References m_iterLimit.

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

Definition at line 477 of file pns_router.cpp.

References m_mode.

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

478 {
479  m_mode = aMode;
480 }
ROUTER_MODE m_mode
Definition: pns_router.h:259
void PNS::ROUTER::SetOrthoMode ( bool  aEnable)

Definition at line 468 of file pns_router.cpp.

References m_placer.

Referenced by ROUTER_TOOL::performRouting().

469 {
470  if( !m_placer )
471  return;
472 
473  m_placer->SetOrthoMode( aEnable );
474 }
std::unique_ptr< PLACEMENT_ALGO > m_placer
Definition: pns_router.h:246
void PNS::ROUTER::SetShowIntermediateSteps ( bool  aX,
int  aSnapshotIter = -1 
)
inline

Definition at line 169 of file pns_router.h.

References m_showInterSteps, and m_snapshotIter.

170  {
171  m_showInterSteps = aX;
172  m_snapshotIter = aSnapshotIter;
173  }
int m_snapshotIter
Definition: pns_router.h:254
bool m_showInterSteps
Definition: pns_router.h:253
ROUTING_SETTINGS& PNS::ROUTER::Settings ( )
inline
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 
)

Definition at line 127 of file pns_router.cpp.

References DRAG_SEGMENT, PNS::ROUTER_IFACE::GetDebugDecorator(), IDLE, m_dragger, 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  if( !aStartItem || aStartItem->OfKind( ITEM::SOLID_T ) )
130  return false;
131 
132  m_dragger.reset( new DRAGGER( this ) );
133  m_dragger->SetWorld( m_world.get() );
134  m_dragger->SetDebugDecorator ( m_iface->GetDebugDecorator () );
135 
136  if( m_dragger->Start ( aP, aStartItem ) )
138  else
139  {
140  m_dragger.reset();
141  m_state = IDLE;
142  return false;
143  }
144 
145  return true;
146 }
std::unique_ptr< NODE > m_world
Definition: pns_router.h:243
RouterState m_state
Definition: pns_router.h:241
ROUTER_IFACE * m_iface
Definition: pns_router.h:250
std::unique_ptr< DRAGGER > m_dragger
Definition: pns_router.h:247
virtual DEBUG_DECORATOR * GetDebugDecorator()=0
bool PNS::ROUTER::StartRouting ( const VECTOR2I aP,
ITEM aItem,
int  aLayer 
)

Definition at line 149 of file pns_router.cpp.

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

150 {
151  switch( m_mode )
152  {
154  m_placer.reset( new LINE_PLACER( this ) );
155  break;
157  m_placer.reset( new DIFF_PAIR_PLACER( this ) );
158  break;
160  m_placer.reset( new MEANDER_PLACER( this ) );
161  break;
163  m_placer.reset( new DP_MEANDER_PLACER( this ) );
164  break;
166  m_placer.reset( new MEANDER_SKEW_PLACER( this ) );
167  break;
168 
169  default:
170  return false;
171  }
172 
173  m_placer->UpdateSizes ( m_sizes );
174  m_placer->SetLayer( aLayer );
175  m_placer->SetDebugDecorator ( m_iface->GetDebugDecorator () );
176 
177  bool rv = m_placer->Start( aP, aStartItem );
178 
179  if( !rv )
180  return false;
181 
182  m_currentEnd = aP;
184  return rv;
185 }
VECTOR2I m_currentEnd
Definition: pns_router.h:240
std::unique_ptr< PLACEMENT_ALGO > m_placer
Definition: pns_router.h:246
RouterState m_state
Definition: pns_router.h:241
ROUTER_IFACE * m_iface
Definition: pns_router.h:250
virtual DEBUG_DECORATOR * GetDebugDecorator()=0
SIZES_SETTINGS m_sizes
Definition: pns_router.h:258
ROUTER_MODE m_mode
Definition: pns_router.h:259
void PNS::ROUTER::StopRouting ( )

Definition at line 359 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().

360 {
361  // Update the ratsnest with new changes
362 
363  if( m_placer )
364  {
365  std::vector<int> nets;
366  m_placer->GetModifiedNets( nets );
367 
368  // Update the ratsnest with new changes
369  for ( auto n : nets )
370  m_iface->UpdateNet( n );
371  }
372 
373  if( !RoutingInProgress() )
374  return;
375 
376  m_placer.reset();
377  m_dragger.reset();
378 
379  m_iface->EraseView();
380 
381  m_state = IDLE;
382  m_world->KillChildren();
383  m_world->ClearRanks();
384 }
bool RoutingInProgress() const
Definition: pns_router.cpp:112
std::unique_ptr< NODE > m_world
Definition: pns_router.h:243
virtual void UpdateNet(int aNetCode)=0
std::unique_ptr< PLACEMENT_ALGO > m_placer
Definition: pns_router.h:246
RouterState m_state
Definition: pns_router.h:241
ROUTER_IFACE * m_iface
Definition: pns_router.h:250
std::unique_ptr< DRAGGER > m_dragger
Definition: pns_router.h:247
virtual void EraseView()=0
void PNS::ROUTER::SwitchLayer ( int  layer)

Definition at line 396 of file pns_router.cpp.

References m_placer, m_state, and ROUTE_TRACK.

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

397 {
398  switch( m_state )
399  {
400  case ROUTE_TRACK:
401  m_placer->SetLayer( aLayer );
402  break;
403  default:
404  break;
405  }
406 }
std::unique_ptr< PLACEMENT_ALGO > m_placer
Definition: pns_router.h:246
RouterState m_state
Definition: pns_router.h:241
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:243
virtual void SyncWorld(NODE *aNode)=0
ROUTER_IFACE * m_iface
Definition: pns_router.h:250
void PNS::ROUTER::ToggleViaPlacement ( )

Definition at line 409 of file pns_router.cpp.

References m_placer, m_state, and ROUTE_TRACK.

Referenced by ROUTER_TOOL::onViaCommand().

410 {
411  if( m_state == ROUTE_TRACK )
412  {
413  bool toggle = !m_placer->IsPlacingVia();
414  m_placer->ToggleVia( toggle );
415  }
416 }
std::unique_ptr< PLACEMENT_ALGO > m_placer
Definition: pns_router.h:246
RouterState m_state
Definition: pns_router.h:241
void PNS::ROUTER::UpdateSizes ( const SIZES_SETTINGS aSizes)

Applies stored settings.

See also
Settings()

Definition at line 278 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().

279 {
280  m_sizes = aSizes;
281 
282  // Change track/via size settings
283  if( m_state == ROUTE_TRACK)
284  {
285  m_placer->UpdateSizes( m_sizes );
286  }
287 }
std::unique_ptr< PLACEMENT_ALGO > m_placer
Definition: pns_router.h:246
RouterState m_state
Definition: pns_router.h:241
SIZES_SETTINGS m_sizes
Definition: pns_router.h:258
void PNS::ROUTER::updateView ( NODE aNode,
ITEM_SET aCurrent 
)
private

Definition at line 257 of file pns_router.cpp.

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

Referenced by moveDragging(), and movePlacing().

258 {
259  NODE::ITEM_VECTOR removed, added;
260  NODE::OBSTACLES obstacles;
261 
262  if( !aNode )
263  return;
264 
265  if( Settings().Mode() == RM_MarkObstacles )
266  markViolations( aNode, aCurrent, removed );
267 
268  aNode->GetUpdatedItems( removed, added );
269 
270  for( auto item : added )
271  m_iface->DisplayItem( item );
272 
273  for( auto item : removed )
274  m_iface->HideItem( item );
275 }
virtual void HideItem(ITEM *aItem)=0
ROUTER_IFACE * m_iface
Definition: pns_router.h:250
ROUTER_MODE Mode() const
Definition: pns_router.h:116
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:178
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:226

Member Data Documentation

VECTOR2I PNS::ROUTER::m_currentEnd
private

Definition at line 240 of file pns_router.h.

Referenced by Move(), and StartRouting().

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

Definition at line 247 of file pns_router.h.

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

wxString PNS::ROUTER::m_failureReason
private

Definition at line 262 of file pns_router.h.

Referenced by FailureReason(), and SetFailureReason().

int PNS::ROUTER::m_iterLimit
private

Definition at line 252 of file pns_router.h.

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

NODE* PNS::ROUTER::m_lastNode
private

Definition at line 244 of file pns_router.h.

Referenced by ROUTER().

ROUTER_MODE PNS::ROUTER::m_mode
private

Definition at line 259 of file pns_router.h.

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

ROUTING_SETTINGS PNS::ROUTER::m_settings
private

Definition at line 257 of file pns_router.h.

Referenced by LoadSettings(), and Settings().

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

Definition at line 248 of file pns_router.h.

bool PNS::ROUTER::m_showInterSteps
private

Definition at line 253 of file pns_router.h.

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

SIZES_SETTINGS PNS::ROUTER::m_sizes
private

Definition at line 258 of file pns_router.h.

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

int PNS::ROUTER::m_snapshotIter
private

Definition at line 254 of file pns_router.h.

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

wxString PNS::ROUTER::m_toolStatusbarName
private

Definition at line 261 of file pns_router.h.

bool PNS::ROUTER::m_violation
private

Definition at line 255 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: