KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
PNS::MEANDER_PLACER_BASE Class Referenceabstract

Base class for Single trace & Differential pair meandering tools, as both of them share a lot of code. More...

#include <pns_meander_placer_base.h>

Inheritance diagram for PNS::MEANDER_PLACER_BASE:
PNS::PLACEMENT_ALGO PNS::ALGO_BASE PNS::DP_MEANDER_PLACER PNS::MEANDER_PLACER PNS::MEANDER_SKEW_PLACER

Public Types

enum  TUNING_STATUS { TOO_SHORT = 0 , TOO_LONG , TUNED }
 < Result of the length tuning operation More...
 

Public Member Functions

 MEANDER_PLACER_BASE (ROUTER *aRouter)
 
virtual ~MEANDER_PLACER_BASE ()
 
virtual long long int TuningLengthResult () const =0
 Return the resultant length or skew of the tuned traces.
 
virtual int64_t TuningDelayResult () const
 Return the resultant delay or skew of the tuned traces.
 
bool HasBaseline () const
 
long long int TuningLengthDelta () const
 
int64_t TuningDelayDelta () const
 
virtual TUNING_STATUS TuningStatus () const =0
 Return the tuning status (too short, too long, etc.) of the trace(s) being tuned.
 
virtual void AmplitudeStep (int aSign)
 Increase/decreases the current meandering amplitude by one step.
 
virtual void SpacingStep (int aSign)
 Increase/decrease the current meandering spacing by one step.
 
virtual int Clearance ()
 Return the clearance of the track(s) being length tuned.
 
virtual const MEANDER_SETTINGS & MeanderSettings () const
 Return the current meandering configuration.
 
virtual void UpdateSettings (const MEANDER_SETTINGS &aSettings)
 
virtual bool CheckFit (MEANDER_SHAPE *aShape)
 Checks if it's OK to place the shape aShape (i.e.
 
virtual const ITEM_SET TunedPath ()=0
 
virtual bool Start (const VECTOR2I &aP, ITEM *aStartItem)=0
 Function Start()
 
virtual bool Move (const VECTOR2I &aP, ITEM *aEndItem)=0
 Function Move()
 
virtual bool FixRoute (const VECTOR2I &aP, ITEM *aEndItem, bool aForceFinish=false)=0
 Function FixRoute()
 
virtual std::optional< VECTOR2I > UnfixRoute ()
 
virtual bool CommitPlacement ()
 
virtual bool AbortPlacement ()
 
virtual bool HasPlacedAnything () const
 
virtual bool ToggleVia (bool aEnabled)
 Function ToggleVia()
 
virtual bool IsPlacingVia () const
 Function IsPlacingVia()
 
virtual bool SetLayer (int aLayer)
 Function SetLayer()
 
virtual const ITEM_SET Traces ()=0
 Function Traces()
 
virtual const VECTOR2I & CurrentStart () const =0
 Function CurrentStart()
 
virtual const VECTOR2I & CurrentEnd () const =0
 Function CurrentEnd()
 
virtual const std::vector< NET_HANDLE > CurrentNets () const =0
 Function CurrentNets()
 
virtual int CurrentLayer () const =0
 Function CurrentLayer()
 
virtual NODE * CurrentNode (bool aLoopsRemoved=false) const =0
 Function CurrentNode()
 
virtual void FlipPosture ()
 Function FlipPosture()
 
virtual void UpdateSizes (const SIZES_SETTINGS &aSizes)
 Function UpdateSizes()
 
virtual void SetOrthoMode (bool aOrthoMode)
 Function SetOrthoMode()
 
virtual void GetModifiedNets (std::vector< NET_HANDLE > &aNets) const
 Function GetModifiedNets.
 
ROUTER * Router () const
 Return current router settings.
 
ROUTING_SETTINGS & Settings () const
 Return the logger object, allowing to dump geometry to a file.
 
virtual LOGGER * Logger ()
 
void SetLogger (LOGGER *aLogger)
 
void SetDebugDecorator (DEBUG_DECORATOR *aDecorator)
 Assign a debug decorator allowing this algo to draw extra graphics for visual debugging.
 
DEBUG_DECORATOR * Dbg () const
 
const BOX2I & VisibleViewArea () const
 

Protected Member Functions

void tuneLineLength (MEANDERED_LINE &aTuned, long long int aElongation)
 Take a set of meanders in aTuned and tunes their length to extend the original line length by aElongation.
 
long long int lineLength (const ITEM_SET &aLine, const SOLID *aStartPad, const SOLID *aEndPad) const
 Calculate the total length of the line represented by an item set (tracks and vias)
 
int64_t lineDelay (const ITEM_SET &aLine, const SOLID *aStartPad, const SOLID *aEndPad) const
 Calculate the total delay of the line represented by an item set (tracks and vias)
 
void initChainExtras ()
 Cache the per-session chain-extras length/delay (other nets in the same chain) so per-Move use does not re-walk the live BOARD.
 
long long int chainNarrowingOffset () const
 Return the length offset to subtract when converting a user-facing total signal length target into a meander-only doMove target.
 
virtual bool removeLoops (NODE *aNode, LINE &aLatest)
 
virtual bool simplifyNewLine (NODE *aNode, LINKED_ITEM *aLatest)
 Assemble a line starting from segment or arc aLatest, removes collinear segments and redundant vertices.
 

Protected Attributes

long long int m_baselineLength = 0
 
int64_t m_baselineDelay = 0
 
bool m_hasBaseline = false
 Active path length at Start().
 
long long int m_startPathLength = 0
 Aggregate length/delay of other nets in the same chain, cached at Start().
 
long long int m_chainExtrasLength = 0
 
long long int m_chainExtrasDelay = 0
 
bool m_chainExtrasValid = false
 Pointer to world to search colliding items.
 
NODE * m_world
 Width of the meandered trace(s).
 
int m_currentWidth
 Meander settings.
 
MEANDER_SETTINGS m_settings
 The current end point.
 
VECTOR2I m_currentEnd
 
SOLID * m_startPad_p
 
SOLID * m_endPad_p
 
SOLID * m_startPad_n
 
SOLID * m_endPad_n
 
DEBUG_DECORATOR * m_debugDecorator
 
ROUTER * m_router
 
LOGGER * m_logger
 

Detailed Description

Base class for Single trace & Differential pair meandering tools, as both of them share a lot of code.

Definition at line 45 of file pns_meander_placer_base.h.

Member Enumeration Documentation

◆ TUNING_STATUS

enum PNS::MEANDER_PLACER_BASE::TUNING_STATUS

< Result of the length tuning operation

Enumerator
TOO_SHORT 
TOO_LONG 
TUNED 

Definition at line 49 of file pns_meander_placer_base.h.

Constructor & Destructor Documentation

◆ MEANDER_PLACER_BASE()

PNS::MEANDER_PLACER_BASE::MEANDER_PLACER_BASE ( ROUTER * aRouter)

Definition at line 34 of file pns_meander_placer_base.cpp.

References m_currentWidth, m_endPad_n, m_endPad_p, m_startPad_n, m_startPad_p, m_world, and PNS::PLACEMENT_ALGO::PLACEMENT_ALGO().

Referenced by PNS::DP_MEANDER_PLACER::DP_MEANDER_PLACER(), and PNS::MEANDER_PLACER::MEANDER_PLACER().

◆ ~MEANDER_PLACER_BASE()

PNS::MEANDER_PLACER_BASE::~MEANDER_PLACER_BASE ( )
virtual

Definition at line 46 of file pns_meander_placer_base.cpp.

Member Function Documentation

◆ AbortPlacement()

virtual bool PNS::PLACEMENT_ALGO::AbortPlacement ( )
inlinevirtualinherited

Reimplemented in PNS::DIFF_PAIR_PLACER, PNS::DP_MEANDER_PLACER, PNS::LINE_PLACER, and PNS::MEANDER_PLACER.

Definition at line 85 of file pns_placement_algo.h.

◆ AmplitudeStep()

void PNS::MEANDER_PLACER_BASE::AmplitudeStep ( int aSign)
virtual

Increase/decreases the current meandering amplitude by one step.

Parameters
aSigndirection (negative = decrease, positive = increase).

Definition at line 96 of file pns_meander_placer_base.cpp.

References m_settings.

◆ chainNarrowingOffset()

long long int PNS::MEANDER_PLACER_BASE::chainNarrowingOffset ( ) const
protected

Return the length offset to subtract when converting a user-facing total signal length target into a meander-only doMove target.

The offset combines the chain-extras aggregate (other nets in the same chain) with any unmeasured stub on the actively-tuned net that lives outside the PNS-measured baseline.

Single-ended and skew tuning both rely on this so the meander does not over-correct by the chain budget already absorbed by sibling nets. The tuning results as they were at Start(). The deltas measure change from these.

Definition at line 78 of file pns_meander_placer_base.cpp.

References PNS::PLACEMENT_ALGO::CurrentNets(), PNS::ROUTER::GetInterface(), PNS::ROUTER_IFACE::GetNetBoardLength(), m_chainExtrasLength, m_chainExtrasValid, m_startPathLength, and PNS::ALGO_BASE::Router().

Referenced by PNS::DP_MEANDER_PLACER::Move(), PNS::MEANDER_PLACER::Move(), and PNS::MEANDER_SKEW_PLACER::Move().

◆ CheckFit()

virtual bool PNS::MEANDER_PLACER_BASE::CheckFit ( MEANDER_SHAPE * aShape)
inlinevirtual

Checks if it's OK to place the shape aShape (i.e.

if it doesn't cause DRC violations or collide with other meanders).

Parameters
aShapethe shape to check.
Returns
true if the shape fits.

Reimplemented in PNS::DP_MEANDER_PLACER, and PNS::MEANDER_PLACER.

Definition at line 120 of file pns_meander_placer_base.h.

◆ Clearance()

int PNS::MEANDER_PLACER_BASE::Clearance ( )
virtual

Return the clearance of the track(s) being length tuned.

Returns
clearance value in internal units

Definition at line 114 of file pns_meander_placer_base.cpp.

References PNS::ITEM_SET::CItems(), PNS::CT_CLEARANCE, PNS::PLACEMENT_ALGO::CurrentLayer(), PNS::ROUTER::GetRuleResolver(), MINOPTMAX< T >::HasMin(), m_currentWidth, PNS::CONSTRAINT::m_Value, MINOPTMAX< T >::Min(), PNS::RULE_RESOLVER::QueryConstraint(), PNS::ALGO_BASE::Router(), and PNS::PLACEMENT_ALGO::Traces().

Referenced by SpacingStep().

◆ CommitPlacement()

virtual bool PNS::PLACEMENT_ALGO::CommitPlacement ( )
inlinevirtualinherited

Reimplemented in PNS::DIFF_PAIR_PLACER, PNS::DP_MEANDER_PLACER, PNS::LINE_PLACER, and PNS::MEANDER_PLACER.

Definition at line 83 of file pns_placement_algo.h.

◆ CurrentEnd()

virtual const VECTOR2I & PNS::PLACEMENT_ALGO::CurrentEnd ( ) const
pure virtualinherited

Function CurrentEnd()

Returns the current end of the line(s) being placed/tuned. It may not be equal to the cursor position due to collisions.

Implemented in PNS::DIFF_PAIR_PLACER, PNS::DP_MEANDER_PLACER, PNS::LINE_PLACER, and PNS::MEANDER_PLACER.

Referenced by PNS::ROUTER::ContinueFromEnd(), and PNS::ROUTER::Finish().

◆ CurrentLayer()

virtual int PNS::PLACEMENT_ALGO::CurrentLayer ( ) const
pure virtualinherited

Function CurrentLayer()

Returns the layer of currently routed track.

Implemented in PNS::DIFF_PAIR_PLACER, PNS::DP_MEANDER_PLACER, PNS::LINE_PLACER, and PNS::MEANDER_PLACER.

Referenced by PNS::MEANDER_PLACER_BASE::Clearance(), and PNS::ROUTER::GetNearestRatnestAnchor().

◆ CurrentNets()

virtual const std::vector< NET_HANDLE > PNS::PLACEMENT_ALGO::CurrentNets ( ) const
pure virtualinherited

Function CurrentNets()

Returns the net(s) of currently routed track(s).

Implemented in PNS::DIFF_PAIR_PLACER, PNS::DP_MEANDER_PLACER, PNS::LINE_PLACER, PNS::MEANDER_PLACER, and PNS::MEANDER_SKEW_PLACER.

Referenced by PNS::MEANDER_PLACER_BASE::chainNarrowingOffset(), PNS::ROUTER::GetNearestRatnestAnchor(), and PNS::MEANDER_PLACER_BASE::initChainExtras().

◆ CurrentNode()

virtual NODE * PNS::PLACEMENT_ALGO::CurrentNode ( bool aLoopsRemoved = false) const
pure virtualinherited

Function CurrentNode()

Returns the most recent board state.

Implemented in PNS::DIFF_PAIR_PLACER, PNS::DP_MEANDER_PLACER, PNS::LINE_PLACER, and PNS::MEANDER_PLACER.

Referenced by PNS::ROUTER::GetNearestRatnestAnchor().

◆ CurrentStart()

virtual const VECTOR2I & PNS::PLACEMENT_ALGO::CurrentStart ( ) const
pure virtualinherited

Function CurrentStart()

Returns the current start of the line(s) being placed/tuned.

Implemented in PNS::DIFF_PAIR_PLACER, PNS::DP_MEANDER_PLACER, PNS::LINE_PLACER, and PNS::MEANDER_PLACER.

Referenced by PNS::ROUTER::GetNearestRatnestAnchor().

◆ Dbg()

DEBUG_DECORATOR * PNS::ALGO_BASE::Dbg ( ) const
inlineinherited

Definition at line 78 of file pns_algo_base.h.

References m_debugDecorator.

Referenced by PNS::SHOVE::AddLockedSpringbackNode(), PNS::DIFF_PAIR_PLACER::attemptWalk(), PNS::DRAGGER::bestAnchorForPoint(), PNS::LINE_PLACER::buildInitialLine(), PNS::SHOVE::checkShoveDirection(), PNS::LINE_PLACER::clipAndCheckCollisions(), PNS::MEANDER_PLACER::doMove(), PNS::COMPONENT_DRAGGER::Drag(), PNS::MULTI_DRAGGER::Drag(), PNS::DRAGGER::dragShove(), PNS::DRAGGER::dragWalkaround(), PNS::DIFF_PAIR_PLACER::FindDpPrimitivePair(), PNS::MULTI_DRAGGER::findNewLeaderSegment(), PNS::DIFF_PAIR_PLACER::FixRoute(), PNS::SHOVE::fixupViaCollisions(), PNS::LINE_PLACER::handlePullback(), PNS::DIFF_PAIR_PLACER::initPlacement(), PNS::LINE_PLACER::mergeHead(), PNS::DIFF_PAIR_PLACER::Move(), PNS::DP_MEANDER_PLACER::Move(), PNS::MEANDER_SKEW_PLACER::Move(), PNS::MULTI_DRAGGER::multidragShove(), PNS::MULTI_DRAGGER::multidragWalkaround(), PNS::SHOVE::onCollidingArc(), PNS::SHOVE::onCollidingLine(), PNS::SHOVE::onCollidingSegment(), PNS::SHOVE::onCollidingSolid(), PNS::SHOVE::onCollidingVia(), PNS::SHOVE::onReverseCollidingVia(), PNS::DRAGGER::optimizeAndUpdateDraggedLine(), PNS::LINE_PLACER::optimizeTailHeadTransition(), PNS::SHOVE::preShoveCleanup(), PNS::SHOVE::pruneLineFromOptimizerQueue(), PNS::SHOVE::pruneRootLines(), PNS::SHOVE::pushLineStack(), PNS::SHOVE::pushOrShoveVia(), PNS::SHOVE::pushSpringback(), PNS::SHOVE::reconstructHeads(), PNS::SHOVE::reduceSpringback(), PNS::LINE_PLACER::reduceTail(), PNS::PLACEMENT_ALGO::removeLoops(), PNS::SHOVE::replaceItems(), PNS::SHOVE::replaceLine(), PNS::LINE_PLACER::rhShoveOnly(), PNS::LINE_PLACER::rhWalkBase(), PNS::LINE_PLACER::rhWalkOnly(), PNS::WALKAROUND::Route(), PNS::DIFF_PAIR_PLACER::routeHead(), PNS::LINE_PLACER::routeStep(), PNS::SHOVE::Run(), PNS::SHOVE::runOptimizer(), PNS::SHOVE::shoveIteration(), PNS::SHOVE::shoveLineToHullSet(), PNS::SHOVE::shoveMainLoop(), PNS::SHOVE::ShoveObstacleLine(), PNS::PLACEMENT_ALGO::simplifyNewLine(), PNS::WALKAROUND::singleStep(), PNS::LINE_PLACER::splitHeadTail(), PNS::DRAGGER::Start(), PNS::LINE_PLACER::Start(), PNS::MULTI_DRAGGER::Start(), PNS::SHOVE::touchRootLine(), PNS::SHOVE::touchRootLine(), PNS::LINE_PLACER::Trace(), PNS::DRAGGER::tryWalkaround(), and PNS::MULTI_DRAGGER::tryWalkaround().

◆ FixRoute()

virtual bool PNS::PLACEMENT_ALGO::FixRoute ( const VECTOR2I & aP,
ITEM * aEndItem,
bool aForceFinish = false )
pure virtualinherited

Function FixRoute()

Commits the currently routed items to the parent node, taking aP as the final end point and aEndItem as the final anchor (if provided).

Returns
true, if route has been committed. May return false if the routing result is violating design rules - in such case, the track is only committed if Settings.CanViolateDRC() is on.

Implemented in PNS::DIFF_PAIR_PLACER, PNS::DP_MEANDER_PLACER, PNS::LINE_PLACER, and PNS::MEANDER_PLACER.

◆ FlipPosture()

virtual void PNS::PLACEMENT_ALGO::FlipPosture ( )
inlinevirtualinherited

Function FlipPosture()

Toggles the current posture (straight/diagonal) of the trace head.

Reimplemented in PNS::DIFF_PAIR_PLACER, and PNS::LINE_PLACER.

Definition at line 167 of file pns_placement_algo.h.

◆ GetModifiedNets()

virtual void PNS::PLACEMENT_ALGO::GetModifiedNets ( std::vector< NET_HANDLE > & aNets) const
inlinevirtualinherited

Function GetModifiedNets.

Returns the nets of all currently routed trace(s)

Reimplemented in PNS::DIFF_PAIR_PLACER, and PNS::LINE_PLACER.

Definition at line 198 of file pns_placement_algo.h.

◆ HasBaseline()

bool PNS::MEANDER_PLACER_BASE::HasBaseline ( ) const
inline

Definition at line 68 of file pns_meander_placer_base.h.

References m_hasBaseline.

Referenced by BOOST_AUTO_TEST_CASE(), and BOOST_AUTO_TEST_CASE().

◆ HasPlacedAnything()

virtual bool PNS::PLACEMENT_ALGO::HasPlacedAnything ( ) const
inlinevirtualinherited

Reimplemented in PNS::DIFF_PAIR_PLACER, PNS::DP_MEANDER_PLACER, PNS::LINE_PLACER, and PNS::MEANDER_PLACER.

Definition at line 87 of file pns_placement_algo.h.

◆ initChainExtras()

void PNS::MEANDER_PLACER_BASE::initChainExtras ( )
protected

Cache the per-session chain-extras length/delay (other nets in the same chain) so per-Move use does not re-walk the live BOARD.

Called from Start() of each derived placer.

Definition at line 51 of file pns_meander_placer_base.cpp.

References PNS::PLACEMENT_ALGO::CurrentNets(), m_chainExtrasDelay, m_chainExtrasLength, m_chainExtrasValid, and PNS::ALGO_BASE::Router().

Referenced by PNS::DP_MEANDER_PLACER::Start(), PNS::MEANDER_PLACER::Start(), and PNS::MEANDER_SKEW_PLACER::Start().

◆ IsPlacingVia()

virtual bool PNS::PLACEMENT_ALGO::IsPlacingVia ( ) const
inlinevirtualinherited

Function IsPlacingVia()

Returns true if the placer is placing a via (or more vias).

Reimplemented in PNS::DIFF_PAIR_PLACER, and PNS::LINE_PLACER.

Definition at line 104 of file pns_placement_algo.h.

◆ lineDelay()

int64_t PNS::MEANDER_PLACER_BASE::lineDelay ( const ITEM_SET & aLine,
const SOLID * aStartPad,
const SOLID * aEndPad ) const
protected

Calculate the total delay of the line represented by an item set (tracks and vias)

Parameters
aLine
Returns

Definition at line 317 of file pns_meander_placer_base.cpp.

References PNS::ROUTER_IFACE::CalculateRoutedPathDelay(), PNS::ITEM_SET::Empty(), PNS::ROUTER::GetInterface(), m_settings, and PNS::ALGO_BASE::Router().

Referenced by PNS::MEANDER_PLACER::doMove(), PNS::DP_MEANDER_PLACER::origPathDelay(), PNS::MEANDER_PLACER::origPathDelay(), PNS::MEANDER_SKEW_PLACER::origPathDelay(), and PNS::MEANDER_SKEW_PLACER::Start().

◆ lineLength()

long long int PNS::MEANDER_PLACER_BASE::lineLength ( const ITEM_SET & aLine,
const SOLID * aStartPad,
const SOLID * aEndPad ) const
protected

Calculate the total length of the line represented by an item set (tracks and vias)

Parameters
aLine
Returns

Definition at line 307 of file pns_meander_placer_base.cpp.

References PNS::ROUTER_IFACE::CalculateRoutedPathLength(), PNS::ITEM_SET::Empty(), PNS::ROUTER::GetInterface(), m_settings, and PNS::ALGO_BASE::Router().

Referenced by PNS::DP_MEANDER_PLACER::origPathLength(), PNS::MEANDER_PLACER::origPathLength(), PNS::MEANDER_SKEW_PLACER::origPathLength(), and PNS::MEANDER_SKEW_PLACER::Start().

◆ Logger()

LOGGER * PNS::ALGO_BASE::Logger ( )
virtualinherited

Definition at line 34 of file pns_algo_base.cpp.

References m_logger.

Referenced by PNS::LINE_PLACER::rhShoveOnly(), PNS::LINE_PLACER::rhWalkBase(), PNS::DRAGGER::Start(), PNS::MULTI_DRAGGER::Start(), PNS::DRAGGER::tryWalkaround(), and PNS::MULTI_DRAGGER::tryWalkaround().

◆ MeanderSettings()

const MEANDER_SETTINGS & PNS::MEANDER_PLACER_BASE::MeanderSettings ( ) const
virtual

Return the current meandering configuration.

Returns
the settings

Definition at line 301 of file pns_meander_placer_base.cpp.

References m_settings.

Referenced by PCB_TUNING_PATTERN::Update().

◆ Move()

virtual bool PNS::PLACEMENT_ALGO::Move ( const VECTOR2I & aP,
ITEM * aEndItem )
pure virtualinherited

Function Move()

Moves the end of the currently routed primtive(s) to the point aP, taking aEndItem as the anchor (if not NULL). (unless NULL).

Implemented in PNS::DIFF_PAIR_PLACER, PNS::DP_MEANDER_PLACER, PNS::LINE_PLACER, PNS::MEANDER_PLACER, and PNS::MEANDER_SKEW_PLACER.

◆ removeLoops()

bool PNS::PLACEMENT_ALGO::removeLoops ( NODE * aNode,
LINE & aLatest )
protectedvirtualinherited

Definition at line 2096 of file pns_line_placer.cpp.

References PNS::NODE::Add(), PNS::NODE::AssembleLine(), SHAPE_LINE_CHAIN::CLastPoint(), PNS::LINK_HOLDER::ClearLinks(), PNS::LINE::CLine(), SHAPE_LINE_CHAIN::CPoint(), PNS::ALGO_BASE::Dbg(), PNS::NODE::FindLineEnds(), PNS::NODE::FindLinesBetweenJoints(), PNS::LINK_HOLDER::GetLink(), PNS::LINK_HOLDER::LinkCount(), PNS_DBG, PNS::NODE::Remove(), and PNS::LINE::SegmentCount().

Referenced by PNS::DIFF_PAIR_PLACER::Move(), and PNS::LINE_PLACER::Move().

◆ Router()

ROUTER * PNS::ALGO_BASE::Router ( ) const
inlineinherited

Return current router settings.

Definition at line 54 of file pns_algo_base.h.

References m_router.

Referenced by PNS::DIFF_PAIR_PLACER::attemptWalk(), PNS::MEANDER_PLACER_BASE::chainNarrowingOffset(), PNS::MEANDER_PLACER_BASE::Clearance(), PNS::DIFF_PAIR_PLACER::CommitPlacement(), PNS::DP_MEANDER_PLACER::CommitPlacement(), PNS::LINE_PLACER::CommitPlacement(), PNS::MEANDER_PLACER::CommitPlacement(), PNS::COMPONENT_DRAGGER::FixRoute(), PNS::DIFF_PAIR_PLACER::FixRoute(), PNS::DRAGGER::FixRoute(), PNS::MULTI_DRAGGER::FixRoute(), PNS::MEANDER_PLACER_BASE::initChainExtras(), PNS::DIFF_PAIR_PLACER::initPlacement(), PNS::LINE_PLACER::initPlacement(), PNS::MEANDER_PLACER_BASE::lineDelay(), PNS::MEANDER_PLACER_BASE::lineLength(), PNS::DIFF_PAIR_PLACER::makeVia(), PNS::LINE_PLACER::makeVia(), PNS::MULTI_DRAGGER::multidragShove(), PNS::SHOVE::onCollidingSolid(), PNS::SHOVE::reconstructHeads(), PNS::LINE_PLACER::rhWalkBase(), PNS::DIFF_PAIR_PLACER::routeHead(), PNS::SHOVE::Run(), PNS::SHOVE::shoveIteration(), PNS::DIFF_PAIR_PLACER::Start(), PNS::DP_MEANDER_PLACER::Start(), PNS::DRAGGER::Start(), PNS::LINE_PLACER::Start(), PNS::MEANDER_PLACER::Start(), PNS::MEANDER_SKEW_PLACER::Start(), PNS::MULTI_DRAGGER::Start(), PNS::DRAGGER::startDragArc(), PNS::DRAGGER::tryWalkaround(), and PNS::MULTI_DRAGGER::tryWalkaround().

◆ SetDebugDecorator()

void PNS::ALGO_BASE::SetDebugDecorator ( DEBUG_DECORATOR * aDecorator)
inlineinherited

Assign a debug decorator allowing this algo to draw extra graphics for visual debugging.

Definition at line 73 of file pns_algo_base.h.

References m_debugDecorator.

Referenced by PNS::DIFF_PAIR_PLACER::attemptWalk(), PNS::SHOVE::onCollidingSolid(), PNS::LINE_PLACER::rhWalkBase(), PNS::SHOVE::SHOVE(), PNS::DRAGGER::tryWalkaround(), and PNS::MULTI_DRAGGER::tryWalkaround().

◆ SetLayer()

virtual bool PNS::PLACEMENT_ALGO::SetLayer ( int aLayer)
inlinevirtualinherited

Function SetLayer()

Sets the current routing layer.

Reimplemented in PNS::DIFF_PAIR_PLACER, and PNS::LINE_PLACER.

Definition at line 114 of file pns_placement_algo.h.

◆ SetLogger()

void PNS::ALGO_BASE::SetLogger ( LOGGER * aLogger)
inlineinherited

Definition at line 65 of file pns_algo_base.h.

References m_logger.

Referenced by PNS::LINE_PLACER::rhWalkBase(), PNS::DRAGGER::tryWalkaround(), and PNS::MULTI_DRAGGER::tryWalkaround().

◆ SetOrthoMode()

virtual void PNS::PLACEMENT_ALGO::SetOrthoMode ( bool aOrthoMode)
inlinevirtualinherited

Function SetOrthoMode()

Forces the router to place a straight 90/45 degree trace (with the end as near to the cursor as possible) instead of a standard 135 degree two-segment bend.

Reimplemented in PNS::DIFF_PAIR_PLACER, and PNS::LINE_PLACER.

Definition at line 189 of file pns_placement_algo.h.

◆ Settings()

ROUTING_SETTINGS & PNS::ALGO_BASE::Settings ( ) const
inherited

Return the logger object, allowing to dump geometry to a file.

Definition at line 28 of file pns_algo_base.cpp.

References m_router.

Referenced by PNS::DIFF_PAIR_PLACER::attemptWalk(), PNS::LINE_PLACER::buildInitialLine(), PNS::LINE_PLACER::CommitPlacement(), PNS::MULTI_DRAGGER::Drag(), PNS::DRAGGER::dragMarkObstacles(), PNS::DRAGGER::dragShove(), PNS::DRAGGER::dragWalkaround(), PNS::COMPONENT_DRAGGER::FixRoute(), PNS::DIFF_PAIR_PLACER::FixRoute(), PNS::LINE_PLACER::FixRoute(), PNS::MULTI_DRAGGER::FixRoute(), PNS::DIFF_PAIR_PLACER::Move(), PNS::LINE_PLACER::Move(), PNS::SHOVE::onCollidingSolid(), PNS::DRAGGER::optimizeAndUpdateDraggedLine(), PNS::DIFF_PAIR_PLACER::propagateDpHeadForces(), PNS::DRAGGER::propagateViaForces(), PNS::SHOVE::pushOrShoveVia(), PNS::LINE_PLACER::rhMarkObstacles(), PNS::LINE_PLACER::rhShoveOnly(), PNS::LINE_PLACER::rhWalkBase(), PNS::LINE_PLACER::rhWalkOnly(), PNS::DIFF_PAIR_PLACER::route(), PNS::LINE_PLACER::routeHead(), PNS::LINE_PLACER::routeStep(), PNS::SHOVE::runOptimizer(), PNS::SHOVE::shoveMainLoop(), PNS::WALKAROUND::singleStep(), PNS::DRAGGER::Start(), PNS::LINE_PLACER::Start(), PNS::MULTI_DRAGGER::Start(), PNS::DRAGGER::tryWalkaround(), PNS::MULTI_DRAGGER::tryWalkaround(), PNS::LINE_PLACER::UnfixRoute(), and PNS::WALKAROUND::WALKAROUND().

◆ simplifyNewLine()

bool PNS::PLACEMENT_ALGO::simplifyNewLine ( NODE * aNode,
LINKED_ITEM * aLatest )
protectedvirtualinherited

Assemble a line starting from segment or arc aLatest, removes collinear segments and redundant vertices.

If a simplification has been found, replaces the old line with the simplified one in aNode.

Definition at line 1773 of file pns_line_placer.cpp.

References PNS::NODE::Add(), PNS::ITEM::ARC_T, PNS::NODE::AssembleLine(), PNS::ITEM_SET::CItems(), PNS::LINE::CLine(), PNS::JOINT::CLinks(), SEG::Contains(), PNS::ALGO_BASE::Dbg(), PNS::NODE::FindJoint(), PNS::NODE::GetUpdatedItems(), PNS::JOINT::IsLineCorner(), PNS::JOINT::LinkCount(), PNS::OPTIMIZER::MERGE_COLINEAR, PNS::ITEM::OfKind(), PNS::OPTIMIZER::Optimize(), PNS_DBG, PNS::LINE::PointCount(), SHAPE_LINE_CHAIN::PointCount(), RED, PNS::NODE::Remove(), PNS::ITEM::SEGMENT_T, PNS::LINE::SetShape(), and SHAPE_LINE_CHAIN::Simplify().

Referenced by PNS::LINE_PLACER::FixRoute().

◆ SpacingStep()

void PNS::MEANDER_PLACER_BASE::SpacingStep ( int aSign)
virtual

Increase/decrease the current meandering spacing by one step.

Parameters
aSigndirection (negative = decrease, positive = increase).

Definition at line 105 of file pns_meander_placer_base.cpp.

References Clearance(), m_currentWidth, and m_settings.

◆ Start()

virtual bool PNS::PLACEMENT_ALGO::Start ( const VECTOR2I & aP,
ITEM * aStartItem )
pure virtualinherited

Function Start()

Starts placement/drag operation at point aP, taking item aStartItem as anchor (unless NULL).

Implemented in PNS::DIFF_PAIR_PLACER, PNS::DP_MEANDER_PLACER, PNS::LINE_PLACER, PNS::MEANDER_PLACER, and PNS::MEANDER_SKEW_PLACER.

◆ ToggleVia()

virtual bool PNS::PLACEMENT_ALGO::ToggleVia ( bool aEnabled)
inlinevirtualinherited

Function ToggleVia()

Enables/disables a via at the end of currently routed trace.

Reimplemented in PNS::DIFF_PAIR_PLACER, and PNS::LINE_PLACER.

Definition at line 94 of file pns_placement_algo.h.

◆ Traces()

virtual const ITEM_SET PNS::PLACEMENT_ALGO::Traces ( )
pure virtualinherited

Function Traces()

Returns all routed/tuned traces.

Implemented in PNS::DIFF_PAIR_PLACER, PNS::DP_MEANDER_PLACER, PNS::LINE_PLACER, and PNS::MEANDER_PLACER.

Referenced by BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), PNS::MEANDER_PLACER_BASE::Clearance(), PNS::ROUTER::ContinueFromEnd(), PNS::ROUTER::Finish(), and PNS::ROUTER::GetNearestRatnestAnchor().

◆ TunedPath()

virtual const ITEM_SET PNS::MEANDER_PLACER_BASE::TunedPath ( )
pure virtual

Implemented in PNS::DP_MEANDER_PLACER, and PNS::MEANDER_PLACER.

◆ tuneLineLength()

void PNS::MEANDER_PLACER_BASE::tuneLineLength ( MEANDERED_LINE & aTuned,
long long int aElongation )
protected

Take a set of meanders in aTuned and tunes their length to extend the original line length by aElongation.

Definition at line 203 of file pns_meander_placer_base.cpp.

References end, PNS::findAmplitudeForLength(), PNS::MEANDERED_LINE::Meanders(), PNS::MT_ARC, PNS::MT_CORNER, PNS::MT_EMPTY, PNS::MT_FINISH, PNS::MT_SINGLE, and PNS::MT_START.

Referenced by PNS::MEANDER_PLACER::doMove(), and PNS::DP_MEANDER_PLACER::Move().

◆ TuningDelayDelta()

int64_t PNS::MEANDER_PLACER_BASE::TuningDelayDelta ( ) const
inline

Definition at line 71 of file pns_meander_placer_base.h.

References m_baselineDelay, and TuningDelayResult().

◆ TuningDelayResult()

virtual int64_t PNS::MEANDER_PLACER_BASE::TuningDelayResult ( ) const
inlinevirtual

Return the resultant delay or skew of the tuned traces.

Reimplemented in PNS::DP_MEANDER_PLACER, PNS::MEANDER_PLACER, and PNS::MEANDER_SKEW_PLACER.

Definition at line 66 of file pns_meander_placer_base.h.

Referenced by TuningDelayDelta().

◆ TuningLengthDelta()

long long int PNS::MEANDER_PLACER_BASE::TuningLengthDelta ( ) const
inline

Definition at line 70 of file pns_meander_placer_base.h.

References m_baselineLength, and TuningLengthResult().

Referenced by BOOST_AUTO_TEST_CASE(), and BOOST_AUTO_TEST_CASE().

◆ TuningLengthResult()

virtual long long int PNS::MEANDER_PLACER_BASE::TuningLengthResult ( ) const
pure virtual

Return the resultant length or skew of the tuned traces.

Implemented in PNS::DP_MEANDER_PLACER, PNS::MEANDER_PLACER, and PNS::MEANDER_SKEW_PLACER.

Referenced by TuningLengthDelta(), and PCB_TUNING_PATTERN::Update().

◆ TuningStatus()

virtual TUNING_STATUS PNS::MEANDER_PLACER_BASE::TuningStatus ( ) const
pure virtual

Return the tuning status (too short, too long, etc.) of the trace(s) being tuned.

Implemented in PNS::DP_MEANDER_PLACER, and PNS::MEANDER_PLACER.

Referenced by PCB_TUNING_PATTERN::Update().

◆ UnfixRoute()

virtual std::optional< VECTOR2I > PNS::PLACEMENT_ALGO::UnfixRoute ( )
inlinevirtualinherited

Reimplemented in PNS::LINE_PLACER.

Definition at line 81 of file pns_placement_algo.h.

◆ UpdateSettings()

void PNS::MEANDER_PLACER_BASE::UpdateSettings ( const MEANDER_SETTINGS & aSettings)
virtual

Definition at line 131 of file pns_meander_placer_base.cpp.

References m_settings.

Referenced by PCB_TUNING_PATTERN::Update().

◆ UpdateSizes()

virtual void PNS::PLACEMENT_ALGO::UpdateSizes ( const SIZES_SETTINGS & aSizes)
inlinevirtualinherited

Function UpdateSizes()

Performs on-the-fly update of the width, via diameter & drill size from a settings class. Used to dynamically change these parameters as the track is routed.

Reimplemented in PNS::DIFF_PAIR_PLACER, and PNS::LINE_PLACER.

Definition at line 178 of file pns_placement_algo.h.

◆ VisibleViewArea()

const BOX2I & PNS::ALGO_BASE::VisibleViewArea ( ) const
inherited

Definition at line 40 of file pns_algo_base.cpp.

References m_router.

Referenced by PNS::SHOVE::runOptimizer().

Member Data Documentation

◆ m_baselineDelay

int64_t PNS::MEANDER_PLACER_BASE::m_baselineDelay = 0
protected

Definition at line 167 of file pns_meander_placer_base.h.

Referenced by PNS::DP_MEANDER_PLACER::Start(), PNS::MEANDER_PLACER::Start(), PNS::MEANDER_SKEW_PLACER::Start(), and TuningDelayDelta().

◆ m_baselineLength

long long int PNS::MEANDER_PLACER_BASE::m_baselineLength = 0
protected

Definition at line 166 of file pns_meander_placer_base.h.

Referenced by PNS::DP_MEANDER_PLACER::Start(), PNS::MEANDER_PLACER::Start(), PNS::MEANDER_SKEW_PLACER::Start(), and TuningLengthDelta().

◆ m_chainExtrasDelay

long long int PNS::MEANDER_PLACER_BASE::m_chainExtrasDelay = 0
protected

Definition at line 177 of file pns_meander_placer_base.h.

Referenced by initChainExtras(), PNS::DP_MEANDER_PLACER::Move(), and PNS::MEANDER_PLACER::Move().

◆ m_chainExtrasLength

long long int PNS::MEANDER_PLACER_BASE::m_chainExtrasLength = 0
protected

Definition at line 176 of file pns_meander_placer_base.h.

Referenced by chainNarrowingOffset(), and initChainExtras().

◆ m_chainExtrasValid

bool PNS::MEANDER_PLACER_BASE::m_chainExtrasValid = false
protected

Pointer to world to search colliding items.

Definition at line 178 of file pns_meander_placer_base.h.

Referenced by chainNarrowingOffset(), initChainExtras(), PNS::DP_MEANDER_PLACER::Move(), and PNS::MEANDER_PLACER::Move().

◆ m_currentEnd

VECTOR2I PNS::MEANDER_PLACER_BASE::m_currentEnd
protected

Definition at line 190 of file pns_meander_placer_base.h.

Referenced by PNS::DP_MEANDER_PLACER::CurrentEnd(), PNS::MEANDER_PLACER::CurrentEnd(), PNS::MEANDER_PLACER::Start(), and PNS::MEANDER_SKEW_PLACER::Start().

◆ m_currentWidth

int PNS::MEANDER_PLACER_BASE::m_currentWidth
protected

Meander settings.

Definition at line 184 of file pns_meander_placer_base.h.

Referenced by PNS::MEANDER_PLACER::calculateTimeDomainTargets(), Clearance(), PNS::MEANDER_PLACER::doMove(), MEANDER_PLACER_BASE(), SpacingStep(), PNS::DP_MEANDER_PLACER::Start(), PNS::MEANDER_PLACER::Start(), and PNS::MEANDER_SKEW_PLACER::Start().

◆ m_debugDecorator

DEBUG_DECORATOR* PNS::ALGO_BASE::m_debugDecorator
protectedinherited

Definition at line 86 of file pns_algo_base.h.

Referenced by ALGO_BASE(), Dbg(), and SetDebugDecorator().

◆ m_endPad_n

SOLID* PNS::MEANDER_PLACER_BASE::m_endPad_n
protected

Definition at line 195 of file pns_meander_placer_base.h.

Referenced by MEANDER_PLACER_BASE(), PNS::DP_MEANDER_PLACER::origPathDelay(), PNS::MEANDER_PLACER::origPathDelay(), PNS::MEANDER_SKEW_PLACER::origPathDelay(), PNS::DP_MEANDER_PLACER::origPathLength(), PNS::MEANDER_PLACER::origPathLength(), PNS::MEANDER_SKEW_PLACER::origPathLength(), PNS::DP_MEANDER_PLACER::Start(), PNS::MEANDER_PLACER::Start(), and PNS::MEANDER_SKEW_PLACER::Start().

◆ m_endPad_p

SOLID* PNS::MEANDER_PLACER_BASE::m_endPad_p
protected

Definition at line 193 of file pns_meander_placer_base.h.

Referenced by MEANDER_PLACER_BASE(), PNS::DP_MEANDER_PLACER::origPathDelay(), PNS::MEANDER_SKEW_PLACER::origPathDelay(), PNS::DP_MEANDER_PLACER::origPathLength(), PNS::MEANDER_SKEW_PLACER::origPathLength(), PNS::DP_MEANDER_PLACER::Start(), and PNS::MEANDER_SKEW_PLACER::Start().

◆ m_hasBaseline

bool PNS::MEANDER_PLACER_BASE::m_hasBaseline = false
protected

Active path length at Start().

Definition at line 168 of file pns_meander_placer_base.h.

Referenced by HasBaseline(), PNS::DP_MEANDER_PLACER::Start(), PNS::MEANDER_PLACER::Start(), and PNS::MEANDER_SKEW_PLACER::Start().

◆ m_logger

LOGGER* PNS::ALGO_BASE::m_logger
protectedinherited

Definition at line 88 of file pns_algo_base.h.

Referenced by ALGO_BASE(), Logger(), and SetLogger().

◆ m_router

ROUTER* PNS::ALGO_BASE::m_router
protectedinherited

Definition at line 87 of file pns_algo_base.h.

Referenced by ALGO_BASE(), PNS::DP_MEANDER_PLACER::calculateTimeDomainTargets(), PNS::MEANDER_PLACER::calculateTimeDomainTargets(), PNS::MEANDER_SKEW_PLACER::calculateTimeDomainTargets(), PNS::MEANDER_PLACER::doMove(), PNS::LINE_PLACER::FixRoute(), PNS::DP_MEANDER_PLACER::Move(), PNS::MEANDER_SKEW_PLACER::Move(), Router(), Settings(), PNS::DIFF_PAIR_PLACER::updateLeadingRatLine(), PNS::LINE_PLACER::updateLeadingRatLine(), and VisibleViewArea().

◆ m_settings

MEANDER_SETTINGS PNS::MEANDER_PLACER_BASE::m_settings
protected

The current end point.

Definition at line 187 of file pns_meander_placer_base.h.

Referenced by AmplitudeStep(), PNS::DP_MEANDER_PLACER::calculateTimeDomainTargets(), PNS::MEANDER_PLACER::calculateTimeDomainTargets(), PNS::MEANDER_SKEW_PLACER::calculateTimeDomainTargets(), PNS::MEANDER_PLACER::CheckFit(), PNS::MEANDER_PLACER::doMove(), lineDelay(), lineLength(), MeanderSettings(), PNS::DP_MEANDER_PLACER::Move(), PNS::MEANDER_PLACER::Move(), PNS::MEANDER_SKEW_PLACER::Move(), PNS::MEANDER_PLACER::origPathDelay(), PNS::MEANDER_PLACER::origPathLength(), SpacingStep(), PNS::DP_MEANDER_PLACER::Start(), PNS::MEANDER_PLACER::Start(), PNS::MEANDER_SKEW_PLACER::Start(), and UpdateSettings().

◆ m_startPad_n

SOLID* PNS::MEANDER_PLACER_BASE::m_startPad_n
protected

Definition at line 194 of file pns_meander_placer_base.h.

Referenced by MEANDER_PLACER_BASE(), PNS::DP_MEANDER_PLACER::origPathDelay(), PNS::MEANDER_PLACER::origPathDelay(), PNS::MEANDER_SKEW_PLACER::origPathDelay(), PNS::DP_MEANDER_PLACER::origPathLength(), PNS::MEANDER_PLACER::origPathLength(), PNS::MEANDER_SKEW_PLACER::origPathLength(), PNS::DP_MEANDER_PLACER::Start(), PNS::MEANDER_PLACER::Start(), and PNS::MEANDER_SKEW_PLACER::Start().

◆ m_startPad_p

SOLID* PNS::MEANDER_PLACER_BASE::m_startPad_p
protected

Definition at line 192 of file pns_meander_placer_base.h.

Referenced by MEANDER_PLACER_BASE(), PNS::DP_MEANDER_PLACER::origPathDelay(), PNS::MEANDER_SKEW_PLACER::origPathDelay(), PNS::DP_MEANDER_PLACER::origPathLength(), PNS::MEANDER_SKEW_PLACER::origPathLength(), PNS::DP_MEANDER_PLACER::Start(), and PNS::MEANDER_SKEW_PLACER::Start().

◆ m_startPathLength

long long int PNS::MEANDER_PLACER_BASE::m_startPathLength = 0
protected

Aggregate length/delay of other nets in the same chain, cached at Start().

The non-edited members of a chain don't change during a tuning session, so we avoid walking the live BOARD on every Move event.

Definition at line 171 of file pns_meander_placer_base.h.

Referenced by chainNarrowingOffset(), PNS::DP_MEANDER_PLACER::Start(), PNS::MEANDER_PLACER::Start(), and PNS::MEANDER_SKEW_PLACER::Start().

◆ m_world

NODE* PNS::MEANDER_PLACER_BASE::m_world
protected

Width of the meandered trace(s).

Definition at line 181 of file pns_meander_placer_base.h.

Referenced by PNS::DP_MEANDER_PLACER::AbortPlacement(), PNS::MEANDER_PLACER::AbortPlacement(), PNS::DP_MEANDER_PLACER::CurrentNode(), PNS::MEANDER_PLACER::CurrentNode(), PNS::MEANDER_PLACER::doMove(), PNS::DP_MEANDER_PLACER::DP_MEANDER_PLACER(), MEANDER_PLACER_BASE(), PNS::DP_MEANDER_PLACER::Move(), PNS::DP_MEANDER_PLACER::Start(), PNS::MEANDER_PLACER::Start(), and PNS::MEANDER_SKEW_PLACER::Start().

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