KiCad PCB EDA Suite
PNS::DP_MEANDER_PLACER Class Reference

Differential Pair length-matching/meandering tool. More...

#include <pns_dp_meander_placer.h>

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

Public Types

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

Public Member Functions

 DP_MEANDER_PLACER (ROUTER *aRouter)
 
 ~DP_MEANDER_PLACER ()
 
bool Start (const VECTOR2I &aP, ITEM *aStartItem) override
 Start routing a single track at point aP, taking item aStartItem as anchor (unless NULL). More...
 
bool Move (const VECTOR2I &aP, ITEM *aEndItem) override
 Move the end of the currently routed trace to the point aP, taking aEndItem as anchor (if not NULL). More...
 
bool FixRoute (const VECTOR2I &aP, ITEM *aEndItem, bool aForceFinish=false) override
 Commit the currently routed track to the parent node, taking aP as the final end point and aEndItem as the final anchor (if provided). More...
 
bool CommitPlacement () override
 
bool AbortPlacement () override
 
bool HasPlacedAnything () const override
 
const LINE Trace () const
 
NODECurrentNode (bool aLoopsRemoved=false) const override
 Return the most recent world state. More...
 
const ITEM_SET Traces () override
 Function Traces() More...
 
const VECTOR2ICurrentEnd () const override
 Function CurrentEnd() More...
 
const std::vector< int > CurrentNets () const override
 Function CurrentNets() More...
 
int CurrentLayer () const override
 Function CurrentLayer() More...
 
long long int totalLength ()
 
const wxString TuningInfo (EDA_UNITS aUnits) const override
 Return a string describing the status and length of the tuned traces. More...
 
TUNING_STATUS TuningStatus () const override
 Return the tuning status (too short, too long, etc.) of the trace(s) being tuned. More...
 
bool CheckFit (MEANDER_SHAPE *aShape) override
 Checks if it's OK to place the shape aShape (i.e. More...
 
virtual void AmplitudeStep (int aSign)
 Increase/decreases the current meandering amplitude by one step. More...
 
virtual void SpacingStep (int aSign)
 Increase/decrease the current meandering spacing by one step. More...
 
virtual int Clearance ()
 Return the clearance of the track(s) being length tuned. More...
 
virtual const MEANDER_SETTINGSMeanderSettings () const
 Return the current meandering configuration. More...
 
virtual void UpdateSettings (const MEANDER_SETTINGS &aSettings)
 
int GetTotalPadToDieLength (const LINE &aLine) const
 
virtual bool UnfixRoute ()
 
virtual bool ToggleVia (bool aEnabled)
 Function ToggleVia() More...
 
virtual bool IsPlacingVia () const
 Function IsPlacingVia() More...
 
virtual bool SetLayer (int aLayer)
 Function SetLayer() More...
 
virtual void FlipPosture ()
 Function FlipPosture() More...
 
virtual void UpdateSizes (const SIZES_SETTINGS &aSizes)
 Function UpdateSizes() More...
 
virtual void SetOrthoMode (bool aOrthoMode)
 Function SetOrthoMode() More...
 
virtual void GetModifiedNets (std::vector< int > &aNets) const
 Function GetModifiedNets. More...
 
ROUTERRouter () const
 Return current router settings. More...
 
ROUTING_SETTINGSSettings () const
 Return the logger object, allowing to dump geometry to a file. More...
 
virtual LOGGERLogger ()
 
void SetLogger (LOGGER *aLogger)
 
void SetDebugDecorator (DEBUG_DECORATOR *aDecorator)
 Assign a debug decorator allowing this algo to draw extra graphics for visual debugging. More...
 
DEBUG_DECORATORDbg () const
 
const BOX2IVisibleViewArea () const
 

Protected Member Functions

void cutTunedLine (const SHAPE_LINE_CHAIN &aOrigin, const VECTOR2I &aTuneStart, const VECTOR2I &aCursorPos, SHAPE_LINE_CHAIN &aPre, SHAPE_LINE_CHAIN &aTuned, SHAPE_LINE_CHAIN &aPost)
 Extract the part of a track to be meandered, depending on the starting point and the cursor position. More...
 
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. More...
 
int compareWithTolerance (long long int aValue, long long int aExpected, long long int aTolerance=0) const
 Compare aValue against aExpected with given tolerance. More...
 
VECTOR2I getSnappedStartPoint (LINKED_ITEM *aStartItem, VECTOR2I aStartPoint)
 
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) More...
 

Protected Attributes

NODEm_world
 Total length added by pad to die size. More...
 
int m_padToDieLength
 Width of the meandered trace(s). More...
 
int m_currentWidth
 Meander settings. More...
 
MEANDER_SETTINGS m_settings
 The current end point. More...
 
VECTOR2I m_currentEnd
 
SOLIDm_startPad_p
 
SOLIDm_endPad_p
 
SOLIDm_startPad_n
 
SOLIDm_endPad_n
 
DEBUG_DECORATORm_debugDecorator
 
ROUTERm_router
 
LOGGERm_logger
 

Private Member Functions

void meanderSegment (const SEG &aBase)
 
const SEG baselineSegment (const DIFF_PAIR::COUPLED_SEGMENTS &aCoupledSegs)
 
bool pairOrientation (const DIFF_PAIR::COUPLED_SEGMENTS &aPair)
 
void setWorld (NODE *aWorld)
 
void release ()
 
long long int origPathLength () const
 Current routing start point (end of tail, beginning of head). More...
 

Private Attributes

VECTOR2I m_currentStart
 Current world state. More...
 
NODEm_currentNode
 
DIFF_PAIR m_originPair
 
DIFF_PAIR::COUPLED_SEGMENTS_VEC m_coupledSegments
 
LINE m_currentTraceN
 
LINE m_currentTraceP
 
ITEM_SET m_tunedPath
 
ITEM_SET m_tunedPathP
 
ITEM_SET m_tunedPathN
 
SHAPE_LINE_CHAIN m_finalShapeP
 
SHAPE_LINE_CHAIN m_finalShapeN
 
MEANDERED_LINE m_result
 
LINKED_ITEMm_initialSegment
 
long long int m_lastLength
 
int m_padToDieP
 
int m_padToDieN
 
TUNING_STATUS m_lastStatus
 

Friends

class MEANDER_SHAPE
 

Detailed Description

Differential Pair length-matching/meandering tool.

Definition at line 48 of file pns_dp_meander_placer.h.

Member Enumeration Documentation

◆ 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

◆ DP_MEANDER_PLACER()

PNS::DP_MEANDER_PLACER::DP_MEANDER_PLACER ( ROUTER aRouter)

Definition at line 36 of file pns_dp_meander_placer.cpp.

36 :
37 MEANDER_PLACER_BASE( aRouter )
38{
39 m_world = nullptr;
40 m_currentNode = nullptr;
41
42 m_padToDieP = 0;
43 m_padToDieN = 0;
44
45 // Init temporary variables (do not leave uninitialized members)
46 m_initialSegment = nullptr;
47 m_lastLength = 0;
49}
NODE * m_world
Total length added by pad to die size.

References m_currentNode, m_initialSegment, m_lastLength, m_lastStatus, m_padToDieN, m_padToDieP, PNS::MEANDER_PLACER_BASE::m_world, and PNS::MEANDER_PLACER_BASE::TOO_SHORT.

◆ ~DP_MEANDER_PLACER()

PNS::DP_MEANDER_PLACER::~DP_MEANDER_PLACER ( )

Definition at line 52 of file pns_dp_meander_placer.cpp.

53{
54}

Member Function Documentation

◆ AbortPlacement()

bool PNS::DP_MEANDER_PLACER::AbortPlacement ( )
overridevirtual

Reimplemented from PNS::PLACEMENT_ALGO.

Definition at line 361 of file pns_dp_meander_placer.cpp.

362{
364 return true;
365}
void KillChildren()
Definition: pns_node.cpp:1451

References PNS::NODE::KillChildren(), and PNS::MEANDER_PLACER_BASE::m_world.

◆ AmplitudeStep()

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

Increase/decreases the current meandering amplitude by one step.

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

Definition at line 48 of file pns_meander_placer_base.cpp.

49{
51 a = std::max( a, m_settings.m_minAmplitude );
52
54}
MEANDER_SETTINGS m_settings
The current end point.
int m_minAmplitude
Maximum meandering amplitude.
Definition: pns_meander.h:77
int m_step
Length PadToDie.
Definition: pns_meander.h:86
int m_maxAmplitude
Meandering period/spacing (see dialog picture for explanation).
Definition: pns_meander.h:80

References PNS::MEANDER_SETTINGS::m_maxAmplitude, PNS::MEANDER_SETTINGS::m_minAmplitude, PNS::MEANDER_PLACER_BASE::m_settings, and PNS::MEANDER_SETTINGS::m_step.

◆ baselineSegment()

const SEG PNS::DP_MEANDER_PLACER::baselineSegment ( const DIFF_PAIR::COUPLED_SEGMENTS aCoupledSegs)
private

Definition at line 147 of file pns_dp_meander_placer.cpp.

148{
149 const VECTOR2I a( ( aCoupledSegs.coupledP.A + aCoupledSegs.coupledN.A ) / 2 );
150 const VECTOR2I b( ( aCoupledSegs.coupledP.B + aCoupledSegs.coupledN.B ) / 2 );
151
152 return SEG( a, b );
153}
Definition: seg.h:42

References SEG::A, SEG::B, PNS::DIFF_PAIR::COUPLED_SEGMENTS::coupledN, and PNS::DIFF_PAIR::COUPLED_SEGMENTS::coupledP.

Referenced by Move().

◆ CheckFit()

bool PNS::DP_MEANDER_PLACER::CheckFit ( MEANDER_SHAPE aShape)
overridevirtual

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 from PNS::MEANDER_PLACER_BASE.

Definition at line 384 of file pns_dp_meander_placer.cpp.

385{
386 LINE l1( m_originPair.PLine(), aShape->CLine( 0 ) );
387 LINE l2( m_originPair.NLine(), aShape->CLine( 1 ) );
388
389 if( m_currentNode->CheckColliding( &l1 ) )
390 return false;
391
392 if( m_currentNode->CheckColliding( &l2 ) )
393 return false;
394
395 int w = aShape->Width();
396 int clearance = w + m_settings.m_spacing;
397
398 return m_result.CheckSelfIntersections( aShape, clearance );
399}
const SHAPE_LINE_CHAIN & CLine() const
Definition: pns_line.h:137
bool CheckSelfIntersections(MEANDER_SHAPE *aShape, int aClearance)
Check if the given shape is intersecting with any other meander in the current line.
int m_spacing
Amplitude/spacing adjustment step.
Definition: pns_meander.h:83
OPT_OBSTACLE CheckColliding(const ITEM *aItem, int aKindMask=ITEM::ANY_T)
Check if the item collides with anything else in the world, and if found, returns the obstacle.
Definition: pns_node.cpp:468

References PNS::NODE::CheckColliding(), PNS::MEANDERED_LINE::CheckSelfIntersections(), PNS::MEANDER_SHAPE::CLine(), m_currentNode, m_originPair, m_result, PNS::MEANDER_PLACER_BASE::m_settings, PNS::MEANDER_SETTINGS::m_spacing, PNS::DIFF_PAIR::NLine(), PNS::DIFF_PAIR::PLine(), and PNS::MEANDER_SHAPE::Width().

◆ Clearance()

int PNS::MEANDER_PLACER_BASE::Clearance ( )
virtualinherited

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

Returns
clearance value in internal units

Definition at line 66 of file pns_meander_placer_base.cpp.

67{
68 // Assumption: All tracks are part of the same net class.
69 // It shouldn't matter which track we pick. They should all have the same clearance if
70 // they are part of the same net class. Therefore, pick the first one on the list.
71 ITEM* itemToCheck = Traces().CItems().front().item;
72 PNS::CONSTRAINT constraint;
73
75 nullptr, CurrentLayer(), &constraint );
76
77 wxCHECK_MSG( constraint.m_Value.HasMin(), m_currentWidth, wxT( "No minimum clearance?" ) );
78
79 return constraint.m_Value.Min();
80}
T Min() const
Definition: minoptmax.h:33
bool HasMin() const
Definition: minoptmax.h:37
ROUTER * Router() const
Return current router settings.
Definition: pns_algo_base.h:54
const ENTRIES & CItems() const
Definition: pns_itemset.h:136
int m_currentWidth
Meander settings.
virtual const ITEM_SET Traces()=0
Function Traces()
virtual int CurrentLayer() const =0
Function CurrentLayer()
RULE_RESOLVER * GetRuleResolver() const
Definition: pns_router.h:170
virtual bool QueryConstraint(CONSTRAINT_TYPE aType, const PNS::ITEM *aItemA, const PNS::ITEM *aItemB, int aLayer, PNS::CONSTRAINT *aConstraint)=0
MINOPTMAX< int > m_Value
Definition: pns_node.h:70

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

Referenced by PNS::MEANDER_SHAPE::spacing(), and PNS::MEANDER_PLACER_BASE::SpacingStep().

◆ CommitPlacement()

bool PNS::DP_MEANDER_PLACER::CommitPlacement ( )
overridevirtual

Reimplemented from PNS::PLACEMENT_ALGO.

Definition at line 374 of file pns_dp_meander_placer.cpp.

375{
376 if( m_currentNode )
378
379 m_currentNode = nullptr;
380 return true;
381}
void CommitRouting()
Definition: pns_router.cpp:728

References PNS::ROUTER::CommitRouting(), m_currentNode, and PNS::ALGO_BASE::Router().

Referenced by FixRoute().

◆ compareWithTolerance()

int PNS::MEANDER_PLACER_BASE::compareWithTolerance ( long long int  aValue,
long long int  aExpected,
long long int  aTolerance = 0 
) const
protectedinherited

Compare aValue against aExpected with given tolerance.

Definition at line 249 of file pns_meander_placer_base.cpp.

251{
252 if( aValue < aExpected - aTolerance )
253 return -1;
254 else if( aValue > aExpected + aTolerance )
255 return 1;
256 else
257 return 0;
258}

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

◆ CurrentEnd()

const VECTOR2I & PNS::DP_MEANDER_PLACER::CurrentEnd ( ) const
overridevirtual

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.

Implements PNS::PLACEMENT_ALGO.

Definition at line 416 of file pns_dp_meander_placer.cpp.

417{
418 return m_currentEnd;
419}

References PNS::MEANDER_PLACER_BASE::m_currentEnd.

◆ CurrentLayer()

int PNS::DP_MEANDER_PLACER::CurrentLayer ( ) const
overridevirtual

Function CurrentLayer()

Returns the layer of currently routed track.

Implements PNS::PLACEMENT_ALGO.

Definition at line 422 of file pns_dp_meander_placer.cpp.

423{
424 return m_initialSegment->Layers().Start();
425}
int Start() const
Definition: pns_layerset.h:82
const LAYER_RANGE & Layers() const
Definition: pns_item.h:154

References PNS::ITEM::Layers(), m_initialSegment, and LAYER_RANGE::Start().

◆ CurrentNets()

const std::vector< int > PNS::DP_MEANDER_PLACER::CurrentNets ( ) const
overridevirtual

Function CurrentNets()

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

Implements PNS::PLACEMENT_ALGO.

Definition at line 463 of file pns_dp_meander_placer.cpp.

464{
465 std::vector<int> rv;
466 rv.push_back( m_originPair.NetP() );
467 rv.push_back( m_originPair.NetN() );
468 return rv;
469}
int NetN() const
int NetP() const

References m_originPair, PNS::DIFF_PAIR::NetN(), and PNS::DIFF_PAIR::NetP().

◆ CurrentNode()

NODE * PNS::DP_MEANDER_PLACER::CurrentNode ( bool  aLoopsRemoved = false) const
overridevirtual

Return the most recent world state.

Implements PNS::PLACEMENT_ALGO.

Definition at line 63 of file pns_dp_meander_placer.cpp.

64{
65 if( !m_currentNode )
66 return m_world;
67
68 return m_currentNode;
69}

References m_currentNode, and PNS::MEANDER_PLACER_BASE::m_world.

◆ cutTunedLine()

void PNS::MEANDER_PLACER_BASE::cutTunedLine ( const SHAPE_LINE_CHAIN aOrigin,
const VECTOR2I aTuneStart,
const VECTOR2I aCursorPos,
SHAPE_LINE_CHAIN aPre,
SHAPE_LINE_CHAIN aTuned,
SHAPE_LINE_CHAIN aPost 
)
protectedinherited

Extract the part of a track to be meandered, depending on the starting point and the cursor position.

Parameters
aOriginthe original line.
aTuneStartpoint where we start meandering (start click coordinates).
aCursorPoscurrent cursor position.
aPrepart before the beginning of meanders.
aTunedpart to be meandered.
aPostpart after the end of meanders.

Definition at line 89 of file pns_meander_placer_base.cpp.

92{
93 VECTOR2I cp ( aCursorPos );
94
95 if( cp == aTuneStart ) // we don't like tuning segments with 0 length
96 {
97 int idx = aOrigin.FindSegment( cp );
98
99 if( idx >= 0 )
100 {
101 const SEG& s = aOrigin.CSegment( idx );
102 cp += ( s.B - s.A ).Resize( 2 );
103 }
104 else
105 {
106 cp += VECTOR2I( 2, 5 ); // some arbitrary value that is not 45 degrees oriented
107 }
108 }
109
110 VECTOR2I n = aOrigin.NearestPoint( cp, false );
111 VECTOR2I m = aOrigin.NearestPoint( aTuneStart, false );
112
113 SHAPE_LINE_CHAIN l( aOrigin );
114 l.Split( n );
115 l.Split( m );
116
117 int i_start = l.Find( m );
118 int i_end = l.Find( n );
119
120 if( i_start > i_end )
121 {
122 l = l.Reverse();
123 i_start = l.Find( m );
124 i_end = l.Find( n );
125 }
126
127 aPre = l.Slice( 0, i_start );
128 aPost = l.Slice( i_end, -1 );
129 aTuned = l.Slice( i_start, i_end );
130
131 aTuned.Simplify();
132}
VECTOR2I A
Definition: seg.h:49
VECTOR2I B
Definition: seg.h:50
Represent a polyline containing arcs as well as line segments: A chain of connected line and/or arc s...
SHAPE_LINE_CHAIN & Simplify(bool aRemoveColinear=true)
Simplify the line chain by removing colinear adjacent segments and duplicate vertices.
int FindSegment(const VECTOR2I &aP, int aThreshold=1) const
Search for segment containing point aP.
const SHAPE_LINE_CHAIN Slice(int aStartIndex, int aEndIndex=-1) const
Return a subset of this line chain containing the [start_index, end_index] range of points.
const VECTOR2I NearestPoint(const VECTOR2I &aP, bool aAllowInternalShapePoints=true) const
Find a point on the line chain that is closest to point aP.
const SEG CSegment(int aIndex) const
Return a constant copy of the aIndex segment in the line chain.
VECTOR2< int > VECTOR2I
Definition: vector2d.h:607

References SEG::A, SEG::B, SHAPE_LINE_CHAIN::CSegment(), SHAPE_LINE_CHAIN::Find(), SHAPE_LINE_CHAIN::FindSegment(), SHAPE_LINE_CHAIN::NearestPoint(), SHAPE_LINE_CHAIN::Reverse(), SHAPE_LINE_CHAIN::Simplify(), SHAPE_LINE_CHAIN::Slice(), and SHAPE_LINE_CHAIN::Split().

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

◆ Dbg()

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

◆ FixRoute()

bool PNS::DP_MEANDER_PLACER::FixRoute ( const VECTOR2I aP,
ITEM aEndItem,
bool  aForceFinish = false 
)
overridevirtual

Commit the currently routed track 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 cases, the track is only committed if Settings.CanViolateDRC() is on.

Implements PNS::PLACEMENT_ALGO.

Definition at line 347 of file pns_dp_meander_placer.cpp.

348{
351
352 m_currentNode->Add( lP );
353 m_currentNode->Add( lN );
354
356
357 return true;
358}
bool Add(std::unique_ptr< SEGMENT > aSegment, bool aAllowRedundant=false)
Add an item to the current node.
Definition: pns_node.cpp:656

References PNS::NODE::Add(), CommitPlacement(), m_currentNode, m_finalShapeN, m_finalShapeP, m_originPair, PNS::DIFF_PAIR::NLine(), and PNS::DIFF_PAIR::PLine().

◆ 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 160 of file pns_placement_algo.h.

161 {
162 }

◆ GetModifiedNets()

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

Function GetModifiedNets.

Returns the net codes of all currently routed trace(s)

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

Definition at line 191 of file pns_placement_algo.h.

192 {
193 }

◆ getSnappedStartPoint()

VECTOR2I PNS::MEANDER_PLACER_BASE::getSnappedStartPoint ( LINKED_ITEM aStartItem,
VECTOR2I  aStartPoint 
)
protectedinherited

Definition at line 261 of file pns_meander_placer_base.cpp.

262{
263 if( aStartItem->Kind() == ITEM::SEGMENT_T )
264 {
265 return static_cast<SEGMENT*>( aStartItem )->Seg().NearestPoint( aStartPoint );
266 }
267 else
268 {
269 wxASSERT( aStartItem->Kind() == ITEM::ARC_T );
270 ARC* arc = static_cast<ARC*>( aStartItem );
271
272 if( ( VECTOR2I( arc->Anchor( 0 ) - aStartPoint ) ).SquaredEuclideanNorm() <=
273 ( VECTOR2I( arc->Anchor( 1 ) - aStartPoint ) ).SquaredEuclideanNorm() )
274 {
275 return arc->Anchor( 0 );
276 }
277 else
278 {
279 return arc->Anchor( 1 );
280 }
281 }
282}
@ SEGMENT_T
Definition: pns_item.h:66

References PNS::ARC::Anchor(), PNS::ITEM::ARC_T, PNS::ITEM::Kind(), and PNS::ITEM::SEGMENT_T.

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

◆ GetTotalPadToDieLength()

int PNS::MEANDER_PLACER_BASE::GetTotalPadToDieLength ( const LINE aLine) const
inherited

Definition at line 205 of file pns_meander_placer_base.cpp.

206{
207 int length = 0;
208 JOINT start;
209 JOINT end;
210
211 m_world->FindLineEnds( aLine, start, end );
212
213 // Extract the length of the pad to die for start and end pads
214 for( auto& link : start.LinkList() )
215 {
216 if( const SOLID* solid = dynamic_cast<const SOLID*>( link.item ) )
217 {
218 // If there are overlapping pads, choose the first with a non-zero length
219 if( solid->GetPadToDie() > 0 )
220 {
221 length += solid->GetPadToDie();
222 break;
223 }
224 }
225 }
226
227 for( auto& link : end.LinkList() )
228 {
229 if( const SOLID* solid = dynamic_cast<const SOLID*>( link.item ) )
230 {
231 if( solid->GetPadToDie() > 0 )
232 {
233 length += solid->GetPadToDie();
234 break;
235 }
236 }
237 }
238
239 return length;
240}
void FindLineEnds(const LINE &aLine, JOINT &aA, JOINT &aB)
Destroy all child nodes. Applicable only to the root node.
Definition: pns_node.cpp:1069

References PNS::NODE::FindLineEnds(), PNS::JOINT::LinkList(), and PNS::MEANDER_PLACER_BASE::m_world.

◆ HasPlacedAnything()

bool PNS::DP_MEANDER_PLACER::HasPlacedAnything ( ) const
overridevirtual

Reimplemented from PNS::PLACEMENT_ALGO.

Definition at line 368 of file pns_dp_meander_placer.cpp.

369{
370 return m_originPair.CP().SegmentCount() > 0 || m_originPair.CN().SegmentCount() > 0;
371}
const SHAPE_LINE_CHAIN & CN() const
const SHAPE_LINE_CHAIN & CP() const
int SegmentCount() const
Return the number of segments in this line chain.

References PNS::DIFF_PAIR::CN(), PNS::DIFF_PAIR::CP(), m_originPair, and SHAPE_LINE_CHAIN::SegmentCount().

◆ 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.

105 {
106 return false;
107 }

◆ lineLength()

long long int PNS::MEANDER_PLACER_BASE::lineLength ( const ITEM_SET aLine,
const SOLID aStartPad,
const SOLID aEndPad 
) const
protectedinherited

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

Parameters
aLine
Returns
Pointer to world to search colliding items.

If there is a start pad but the pad's layers do not overlap the first track layer, then there must be a fanout via on the line. If there isn't, we still need to have the via back to the pad, so count the distance in the line tuning

Definition at line 285 of file pns_meander_placer_base.cpp.

286{
287 long long int total = 0;
288
289 if( aLine.Empty() )
290 return 0;
291
292 const ITEM* start_item = aLine[0];
293 const ITEM* end_item = aLine[aLine.Size() - 1];
294 bool start_via = false;
295 bool end_via = false;
296
297
303 start_via = aStartPad && ( !aStartPad->LayersOverlap( start_item ) );
304 end_via = aEndPad && ( !aEndPad->LayersOverlap( end_item ) );
305
306 for( int idx = 0; idx < aLine.Size(); idx++ )
307 {
308 const ITEM* item = aLine[idx];
309
310 if( const LINE* l = dyn_cast<const LINE*>( item ) )
311 {
312 total += l->CLine().Length();
313 }
314 else if( item->OfKind( ITEM::VIA_T ) && idx > 0 && idx < aLine.Size() - 1 )
315 {
316 int layerPrev = aLine[idx - 1]->Layer();
317 int layerNext = aLine[idx + 1]->Layer();
318
319 if( layerPrev != layerNext )
320 total += m_router->GetInterface()->StackupHeight( layerPrev, layerNext );
321 }
322 }
323
324 if( start_via )
325 {
326 int layerPrev = aStartPad->Layer();
327 int layerNext = start_item->Layer();
328
329 total += m_router->GetInterface()->StackupHeight( layerPrev, layerNext );
330 }
331
332 if( end_via )
333 {
334 int layerPrev = end_item->Layer();
335 int layerNext = aEndPad->Layer();
336
337 total += m_router->GetInterface()->StackupHeight( layerPrev, layerNext );
338 }
339
340 return total;
341}
ROUTER * m_router
Definition: pns_algo_base.h:87
virtual int StackupHeight(int aFirstLayer, int aSecondLayer) const =0
ROUTER_IFACE * GetInterface() const
Definition: pns_router.h:208

References PNS::ITEM_SET::Empty(), PNS::ROUTER::GetInterface(), PNS::ITEM::Layer(), PNS::ITEM::LayersOverlap(), PNS::ALGO_BASE::m_router, PNS::ITEM::OfKind(), PNS::ITEM_SET::Size(), PNS::ROUTER_IFACE::StackupHeight(), and PNS::ITEM::VIA_T.

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

◆ Logger()

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

Reimplemented in PNS::SHOVE.

Definition at line 34 of file pns_algo_base.cpp.

35{
36 return nullptr;
37}

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

◆ meanderSegment()

void PNS::DP_MEANDER_PLACER::meanderSegment ( const SEG aBase)
private

◆ MeanderSettings()

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

Return the current meandering configuration.

Returns
the settings

Definition at line 243 of file pns_meander_placer_base.cpp.

244{
245 return m_settings;
246}

References PNS::MEANDER_PLACER_BASE::m_settings.

Referenced by PNS::MEANDER_SHAPE::makeMiterShape(), LENGTH_TUNER_TOOL::meanderSettingsDialog(), PNS::MEANDER_SHAPE::Settings(), and PNS::MEANDERED_LINE::Settings().

◆ Move()

bool PNS::DP_MEANDER_PLACER::Move ( const VECTOR2I aP,
ITEM aEndItem 
)
overridevirtual

Move the end of the currently routed trace to the point aP, taking aEndItem as anchor (if not NULL).

Implements PNS::PLACEMENT_ALGO.

Definition at line 166 of file pns_dp_meander_placer.cpp.

167{
168// return false;
169
170 DIFF_PAIR::COUPLED_SEGMENTS_VEC coupledSegments;
171
172 if( m_currentNode )
173 delete m_currentNode;
174
176
177 SHAPE_LINE_CHAIN preP, tunedP, postP;
178 SHAPE_LINE_CHAIN preN, tunedN, postN;
179
180 cutTunedLine( m_originPair.CP(), m_currentStart, aP, preP, tunedP, postP );
181 cutTunedLine( m_originPair.CN(), m_currentStart, aP, preN, tunedN, postN );
182
183 DIFF_PAIR tuned( m_originPair );
184
185 tuned.SetShape( tunedP, tunedN );
186
187 tuned.CoupledSegmentPairs( coupledSegments );
188
189 if( coupledSegments.size() == 0 )
190 return false;
191
192 m_result = MEANDERED_LINE( this, true );
193 m_result.SetWidth( tuned.Width() );
194
195 int offset = ( tuned.Gap() + tuned.Width() ) / 2;
196
197 if( pairOrientation( coupledSegments[0] ) )
198 offset *= -1;
199
200 m_result.SetBaselineOffset( offset );
201
202 for( const ITEM* item : m_tunedPathP.CItems() )
203 {
204 if( const LINE* l = dyn_cast<const LINE*>( item ) )
205 PNS_DBG( Dbg(), AddShape, &l->CLine(), YELLOW, 10000, wxT( "tuned-path-p" ) );
206 }
207
208 for( const ITEM* item : m_tunedPathN.CItems() )
209 {
210 if( const LINE* l = dyn_cast<const LINE*>( item ) )
211 PNS_DBG( Dbg(), AddShape, &l->CLine(), YELLOW, 10000, wxT( "tuned-path-n" ) );
212 }
213
214 int curIndexP = 0, curIndexN = 0;
215
216 for( const DIFF_PAIR::COUPLED_SEGMENTS& sp : coupledSegments )
217 {
218 SEG base = baselineSegment( sp );
219
220 PNS_DBG( Dbg(), AddShape, base, GREEN, 10000, wxT( "dp-baseline" ) );
221
222 while( sp.indexP >= curIndexP && curIndexP != -1 )
223 {
224 if( tunedP.IsArcSegment( curIndexP ) )
225 {
226 ssize_t arcIndex = tunedP.ArcIndex( curIndexP );
227
228 m_result.AddArcAndPt( tunedP.Arc( arcIndex ), tunedN.CPoint( curIndexN ) );
229 }
230 else
231 {
232 m_result.AddCorner( tunedP.CPoint( curIndexP ), tunedN.CPoint( curIndexN ) );
233 }
234
235 curIndexP = tunedP.NextShape( curIndexP );
236 }
237
238 while( sp.indexN >= curIndexN && curIndexN != -1 )
239 {
240 if( tunedN.IsArcSegment( curIndexN ) )
241 {
242 ssize_t arcIndex = tunedN.ArcIndex( curIndexN );
243
244 m_result.AddPtAndArc( tunedP.CPoint( sp.indexP ), tunedN.Arc( arcIndex ) );
245 }
246 else
247 {
248 m_result.AddCorner( tunedP.CPoint( sp.indexP ), tunedN.CPoint( curIndexN ) );
249 }
250
251 curIndexN = tunedN.NextShape( curIndexN );
252 }
253
254 m_result.MeanderSegment( base, base.Side( aP ) < 0 );
255 }
256
257 while( curIndexP < tunedP.PointCount() && curIndexP != -1 )
258 {
259 if( tunedP.IsArcSegment( curIndexP ) )
260 {
261 ssize_t arcIndex = tunedP.ArcIndex( curIndexP );
262
263 m_result.AddArcAndPt( tunedP.Arc( arcIndex ), tunedN.CPoint( curIndexN ) );
264 }
265 else
266 {
267 m_result.AddCorner( tunedP.CPoint( curIndexP ), tunedN.CPoint( curIndexN ) );
268 }
269
270 curIndexP = tunedP.NextShape( curIndexP );
271 }
272
273 while( curIndexN < tunedN.PointCount() && curIndexN != -1 )
274 {
275 if( tunedN.IsArcSegment( curIndexN ) )
276 {
277 ssize_t arcIndex = tunedN.ArcIndex( curIndexN );
278
279 m_result.AddPtAndArc( tunedP.CPoint( -1 ), tunedN.Arc( arcIndex ) );
280 }
281 else
282 {
283 m_result.AddCorner( tunedP.CPoint( -1 ), tunedN.CPoint( curIndexN ) );
284 }
285
286 curIndexN = tunedN.NextShape( curIndexN );
287 }
288
289 long long int dpLen = origPathLength();
290
292
294 {
296 m_lastLength = dpLen;
297 }
298 else
299 {
300 m_lastLength = dpLen - std::max( tunedP.Length(), tunedN.Length() );
302 }
303
304 if( m_lastStatus != TOO_LONG )
305 {
306 tunedP.Clear();
307 tunedN.Clear();
308
309 for( MEANDER_SHAPE* m : m_result.Meanders() )
310 {
311 if( m->Type() != MT_EMPTY )
312 {
313 tunedP.Append( m->CLine( 0 ) );
314 tunedN.Append( m->CLine( 1 ) );
315 }
316 }
317
318 m_lastLength += std::max( tunedP.Length(), tunedN.Length() );
319
322
323 if( comp > 0 )
325 else if( comp < 0 )
327 else
329 }
330
332 m_finalShapeP.Append( preP );
333 m_finalShapeP.Append( tunedP );
334 m_finalShapeP.Append( postP );
336
338 m_finalShapeN.Append( preN );
339 m_finalShapeN.Append( tunedN );
340 m_finalShapeN.Append( postN );
342
343 return true;
344}
DEBUG_DECORATOR * Dbg() const
Definition: pns_algo_base.h:78
std::vector< COUPLED_SEGMENTS > COUPLED_SEGMENTS_VEC
bool pairOrientation(const DIFF_PAIR::COUPLED_SEGMENTS &aPair)
VECTOR2I m_currentStart
Current world state.
const SEG baselineSegment(const DIFF_PAIR::COUPLED_SEGMENTS &aCoupledSegs)
long long int origPathLength() const
Current routing start point (end of tail, beginning of head).
void SetBaselineOffset(int aOffset)
Set the parallel offset between the base segment and the meandered line.
Definition: pns_meander.h:481
void SetWidth(int aWidth)
Set the line width.
Definition: pns_meander.h:466
void AddCorner(const VECTOR2I &aA, const VECTOR2I &aB=VECTOR2I(0, 0))
Create a dummy meander shape representing a line corner.
void MeanderSegment(const SEG &aSeg, bool aSide, int aBaseIndex=0)
Fit maximum amplitude meanders on a given segment and adds to the current line.
Definition: pns_meander.cpp:45
void AddArcAndPt(const SHAPE_ARC &aArc1, const VECTOR2I &aPt2)
Create a dummy meander shape representing an arc corner.
std::vector< MEANDER_SHAPE * > & Meanders()
Definition: pns_meander.h:489
void AddPtAndArc(const VECTOR2I &aPt1, const SHAPE_ARC &aArc2)
Create a dummy meander shape representing an arc corner.
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 aElonga...
void cutTunedLine(const SHAPE_LINE_CHAIN &aOrigin, const VECTOR2I &aTuneStart, const VECTOR2I &aCursorPos, SHAPE_LINE_CHAIN &aPre, SHAPE_LINE_CHAIN &aTuned, SHAPE_LINE_CHAIN &aPost)
Extract the part of a track to be meandered, depending on the starting point and the cursor position.
int compareWithTolerance(long long int aValue, long long int aExpected, long long int aTolerance=0) const
Compare aValue against aExpected with given tolerance.
long long int m_targetLength
Type of corners for the meandered line.
Definition: pns_meander.h:92
int m_lengthTolerance
Target skew value for diff pair de-skewing.
Definition: pns_meander.h:101
NODE * Branch()
Create a lightweight copy (called branch) of self that tracks the changes (added/removed items) wrs t...
Definition: pns_node.cpp:139
int Side(const VECTOR2I &aP) const
Determine on which side of directed line passing via segment ends point aP lies.
Definition: seg.h:143
const SHAPE_ARC & Arc(size_t aArc) const
int NextShape(int aPointIndex, bool aForwards=true) const
Return the vertex index of the next shape in the chain, or -1 if aPointIndex is the last shape.
int PointCount() const
Return the number of points (vertices) in this line chain.
ssize_t ArcIndex(size_t aSegment) const
Return the arc index for the given segment index.
void Clear()
Remove all points from the line chain.
void Append(int aX, int aY, bool aAllowDuplication=false)
Append a new point at the end of the line chain.
const VECTOR2I & CPoint(int aIndex) const
Return a reference to a given point in the line chain.
bool IsArcSegment(size_t aSegment) const
long long int Length() const
Return length of the line chain in Euclidean metric.
@ GREEN
Definition: color4d.h:57
@ YELLOW
Definition: color4d.h:67
@ MT_EMPTY
Definition: pns_meander.h:46
#define PNS_DBG(dbg, method,...)

References PNS::MEANDERED_LINE::AddArcAndPt(), PNS::MEANDERED_LINE::AddCorner(), PNS::MEANDERED_LINE::AddPtAndArc(), SHAPE_LINE_CHAIN::Append(), SHAPE_LINE_CHAIN::Arc(), SHAPE_LINE_CHAIN::ArcIndex(), baselineSegment(), PNS::NODE::Branch(), PNS::ITEM_SET::CItems(), SHAPE_LINE_CHAIN::Clear(), PNS::DIFF_PAIR::CN(), PNS::MEANDER_PLACER_BASE::compareWithTolerance(), PNS::DIFF_PAIR::CoupledSegmentPairs(), PNS::DIFF_PAIR::CP(), SHAPE_LINE_CHAIN::CPoint(), PNS::MEANDER_PLACER_BASE::cutTunedLine(), PNS::ALGO_BASE::Dbg(), PNS::DIFF_PAIR::Gap(), GREEN, SHAPE_LINE_CHAIN::IsArcSegment(), SHAPE_LINE_CHAIN::Length(), m_currentNode, m_currentStart, m_finalShapeN, m_finalShapeP, m_lastLength, m_lastStatus, PNS::MEANDER_SETTINGS::m_lengthTolerance, m_originPair, m_result, PNS::MEANDER_PLACER_BASE::m_settings, PNS::MEANDER_SETTINGS::m_targetLength, m_tunedPathN, m_tunedPathP, PNS::MEANDER_PLACER_BASE::m_world, PNS::MEANDERED_LINE::Meanders(), PNS::MEANDERED_LINE::MeanderSegment(), PNS::MT_EMPTY, SHAPE_LINE_CHAIN::NextShape(), origPathLength(), pairOrientation(), PNS_DBG, SHAPE_LINE_CHAIN::PointCount(), PNS::MEANDERED_LINE::SetBaselineOffset(), PNS::DIFF_PAIR::SetShape(), PNS::MEANDERED_LINE::SetWidth(), SEG::Side(), SHAPE_LINE_CHAIN::Simplify(), PNS::MEANDER_PLACER_BASE::TOO_LONG, PNS::MEANDER_PLACER_BASE::TOO_SHORT, PNS::MEANDER_PLACER_BASE::TUNED, PNS::MEANDER_PLACER_BASE::tuneLineLength(), PNS::DIFF_PAIR::Width(), and YELLOW.

◆ origPathLength()

long long int PNS::DP_MEANDER_PLACER::origPathLength ( ) const
private

Current routing start point (end of tail, beginning of head).

Definition at line 139 of file pns_dp_meander_placer.cpp.

140{
141 long long int totalP = m_padToDieLength + lineLength( m_tunedPathP, m_startPad_p, m_endPad_p );
142 long long int totalN = m_padToDieLength + lineLength( m_tunedPathN, m_startPad_n, m_endPad_n );
143 return std::max( totalP, totalN );
144}
int m_padToDieLength
Width of the meandered trace(s).
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)

References PNS::MEANDER_PLACER_BASE::lineLength(), PNS::MEANDER_PLACER_BASE::m_endPad_n, PNS::MEANDER_PLACER_BASE::m_endPad_p, PNS::MEANDER_PLACER_BASE::m_padToDieLength, PNS::MEANDER_PLACER_BASE::m_startPad_n, PNS::MEANDER_PLACER_BASE::m_startPad_p, m_tunedPathN, and m_tunedPathP.

Referenced by Move().

◆ pairOrientation()

bool PNS::DP_MEANDER_PLACER::pairOrientation ( const DIFF_PAIR::COUPLED_SEGMENTS aPair)
private

Definition at line 156 of file pns_dp_meander_placer.cpp.

157{
158 VECTOR2I midp = ( aPair.coupledP.A + aPair.coupledN.A ) / 2;
159
160 //DrawDebugPoint(midp, 6);
161
162 return aPair.coupledP.Side( midp ) > 0;
163}

References SEG::A, PNS::DIFF_PAIR::COUPLED_SEGMENTS::coupledN, PNS::DIFF_PAIR::COUPLED_SEGMENTS::coupledP, and SEG::Side().

Referenced by Move().

◆ release()

void PNS::DP_MEANDER_PLACER::release ( )
private

Definition at line 134 of file pns_dp_meander_placer.cpp.

135{
136}

◆ Router()

◆ 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.

74 {
75 m_debugDecorator = aDecorator;
76 }

References PNS::ALGO_BASE::m_debugDecorator.

Referenced by PNS::SHOVE::onCollidingSolid(), PNS::LINE_PLACER::rhShoveOnly(), PNS::LINE_PLACER::rhWalkOnly(), PNS::SHOVE::SHOVE(), and PNS::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.

115 {
116 return false;
117 }

◆ SetLogger()

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

Definition at line 65 of file pns_algo_base.h.

66 {
67 m_logger = aLogger;
68 }
LOGGER * m_logger
Definition: pns_algo_base.h:88

References PNS::ALGO_BASE::m_logger.

Referenced by PNS::LINE_PLACER::rhShoveOnly(), PNS::LINE_PLACER::rhWalkOnly(), and PNS::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 182 of file pns_placement_algo.h.

183 {
184 }

◆ Settings()

◆ setWorld()

void PNS::DP_MEANDER_PLACER::setWorld ( NODE aWorld)
private

◆ SpacingStep()

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

Increase/decrease the current meandering spacing by one step.

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

Definition at line 57 of file pns_meander_placer_base.cpp.

58{
59 int s = m_settings.m_spacing + aSign * m_settings.m_step;
60 s = std::max( s, m_currentWidth + Clearance() );
61
63}
virtual int Clearance()
Return the clearance of the track(s) being length tuned.

References PNS::MEANDER_PLACER_BASE::Clearance(), PNS::MEANDER_PLACER_BASE::m_currentWidth, PNS::MEANDER_PLACER_BASE::m_settings, PNS::MEANDER_SETTINGS::m_spacing, and PNS::MEANDER_SETTINGS::m_step.

◆ Start()

bool PNS::DP_MEANDER_PLACER::Start ( const VECTOR2I aP,
ITEM aStartItem 
)
overridevirtual

Start routing a single track at point aP, taking item aStartItem as anchor (unless NULL).

Implements PNS::PLACEMENT_ALGO.

Definition at line 72 of file pns_dp_meander_placer.cpp.

73{
74 if( !aStartItem || !aStartItem->OfKind( ITEM::SEGMENT_T | ITEM::ARC_T ) )
75 {
76 Router()->SetFailureReason( _( "Please select a track whose length you want to tune." ) );
77 return false;
78 }
79
80 m_initialSegment = static_cast<LINKED_ITEM*>( aStartItem );
81 m_currentNode = nullptr;
83
84 m_world = Router()->GetWorld()->Branch();
85
86 TOPOLOGY topo( m_world );
87
88 if( !topo.AssembleDiffPair( m_initialSegment, m_originPair ) )
89 {
90 Router()->SetFailureReason( _( "Unable to find complementary differential pair "
91 "net for length tuning. Make sure the names of the nets "
92 "belonging to a differential pair end with either _N/_P "
93 "or +/-." ) );
94 return false;
95 }
96
97 if( m_originPair.Gap() < 0 )
98 m_originPair.SetGap( Router()->Sizes().DiffPairGap() );
99
101 return false;
102
103 m_tunedPathP = topo.AssembleTuningPath( m_originPair.PLine().GetLink( 0 ), &m_startPad_p, &m_endPad_p );
104
105 m_padToDieP = 0;
106
107 if( m_startPad_p )
109
110 if( m_endPad_p )
112
113 m_tunedPathN = topo.AssembleTuningPath( m_originPair.NLine().GetLink( 0 ), &m_startPad_n, &m_endPad_n );
114
115 m_padToDieN = 0;
116
117 if( m_startPad_n )
119
120 if( m_endPad_n )
122
124
127
129
130 return true;
131}
int Width() const
int Gap() const
void SetGap(int aGap)
int SegmentCount() const
Definition: pns_line.h:139
VECTOR2I getSnappedStartPoint(LINKED_ITEM *aStartItem, VECTOR2I aStartPoint)
void Remove(ARC *aArc)
Remove an item from this branch.
Definition: pns_node.cpp:873
void SetFailureReason(const wxString &aReason)
Definition: pns_router.h:203
NODE * GetWorld() const
Definition: pns_router.h:154
int GetPadToDie() const
Definition: pns_solid.h:103
#define _(s)

References _, PNS::ITEM::ARC_T, PNS::TOPOLOGY::AssembleDiffPair(), PNS::TOPOLOGY::AssembleTuningPath(), PNS::NODE::Branch(), PNS::DIFF_PAIR::Gap(), PNS::LINK_HOLDER::GetLink(), PNS::SOLID::GetPadToDie(), PNS::MEANDER_PLACER_BASE::getSnappedStartPoint(), PNS::ROUTER::GetWorld(), m_currentNode, m_currentStart, PNS::MEANDER_PLACER_BASE::m_currentWidth, PNS::MEANDER_PLACER_BASE::m_endPad_n, PNS::MEANDER_PLACER_BASE::m_endPad_p, m_initialSegment, m_originPair, PNS::MEANDER_PLACER_BASE::m_padToDieLength, m_padToDieN, m_padToDieP, PNS::MEANDER_PLACER_BASE::m_startPad_n, PNS::MEANDER_PLACER_BASE::m_startPad_p, m_tunedPathN, m_tunedPathP, PNS::MEANDER_PLACER_BASE::m_world, PNS::DIFF_PAIR::NLine(), PNS::ITEM::OfKind(), PNS::DIFF_PAIR::PLine(), PNS::NODE::Remove(), PNS::ALGO_BASE::Router(), PNS::ITEM::SEGMENT_T, PNS::LINE::SegmentCount(), PNS::ROUTER::SetFailureReason(), PNS::DIFF_PAIR::SetGap(), and PNS::DIFF_PAIR::Width().

◆ 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.

95 {
96 return false;
97 }

◆ totalLength()

long long int PNS::DP_MEANDER_PLACER::totalLength ( )

◆ Trace()

const LINE PNS::DP_MEANDER_PLACER::Trace ( ) const

Definition at line 57 of file pns_dp_meander_placer.cpp.

58{
59 return m_currentTraceP;
60}

References m_currentTraceP.

◆ Traces()

const ITEM_SET PNS::DP_MEANDER_PLACER::Traces ( )
overridevirtual

Function Traces()

Returns all routed/tuned traces.

Implements PNS::PLACEMENT_ALGO.

Definition at line 402 of file pns_dp_meander_placer.cpp.

403{
406
407 ITEM_SET traces;
408
409 traces.Add( &m_currentTraceP );
410 traces.Add( &m_currentTraceN );
411
412 return traces;
413}

References PNS::ITEM_SET::Add(), m_currentTraceN, m_currentTraceP, m_finalShapeN, m_finalShapeP, m_originPair, PNS::DIFF_PAIR::NLine(), and PNS::DIFF_PAIR::PLine().

◆ tuneLineLength()

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

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

Definition at line 135 of file pns_meander_placer_base.cpp.

136{
137 long long int remaining = aElongation;
138 bool finished = false;
139
140 for( MEANDER_SHAPE* m : aTuned.Meanders() )
141 {
142 if( m->Type() != MT_CORNER && m->Type() != MT_ARC )
143 {
144 if( remaining >= 0 )
145 remaining -= m->MaxTunableLength() - m->BaselineLength();
146
147 if( remaining < 0 )
148 {
149 if( !finished )
150 {
151 MEANDER_TYPE newType;
152
153 if( m->Type() == MT_START || m->Type() == MT_SINGLE )
154 newType = MT_SINGLE;
155 else
156 newType = MT_FINISH;
157
158 m->SetType( newType );
159 m->Recalculate();
160
161 finished = true;
162 }
163 else
164 {
165 m->MakeEmpty();
166 }
167 }
168 }
169 }
170
171 remaining = aElongation;
172 int meanderCount = 0;
173
174 for( MEANDER_SHAPE* m : aTuned.Meanders() )
175 {
176 if( m->Type() != MT_CORNER && m->Type() != MT_ARC && m->Type() != MT_EMPTY )
177 {
178 if(remaining >= 0)
179 {
180 remaining -= m->MaxTunableLength() - m->BaselineLength();
181 meanderCount ++;
182 }
183 }
184 }
185
186 long long int balance = 0;
187
188 if( meanderCount )
189 balance = -remaining / meanderCount;
190
191 if( balance >= 0 )
192 {
193 for( MEANDER_SHAPE* m : aTuned.Meanders() )
194 {
195 if( m->Type() != MT_CORNER && m->Type() != MT_ARC && m->Type() != MT_EMPTY )
196 {
197 m->Resize( std::max( m->Amplitude() - balance / 2,
198 (long long int) m_settings.m_minAmplitude ) );
199 }
200 }
201 }
202}
MEANDER_TYPE
Shapes of available meanders.
Definition: pns_meander.h:37
@ MT_ARC
Definition: pns_meander.h:45
@ MT_START
Definition: pns_meander.h:39
@ MT_FINISH
Definition: pns_meander.h:40
@ MT_CORNER
Definition: pns_meander.h:44
@ MT_SINGLE
Definition: pns_meander.h:38

References PNS::MEANDER_SETTINGS::m_minAmplitude, PNS::MEANDER_PLACER_BASE::m_settings, 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 Move().

◆ TuningInfo()

const wxString PNS::DP_MEANDER_PLACER::TuningInfo ( EDA_UNITS  aUnits) const
overridevirtual

Return a string describing the status and length of the tuned traces.

Implements PNS::MEANDER_PLACER_BASE.

Definition at line 428 of file pns_dp_meander_placer.cpp.

429{
430 wxString status;
431
432 switch( m_lastStatus )
433 {
434 case TOO_LONG:
435 status = _( "Too long: " );
436 break;
437 case TOO_SHORT:
438 status = _("Too short: " );
439 break;
440 case TUNED:
441 status = _( "Tuned: " );
442 break;
443 default:
444 return _( "?" );
445 }
446
447 status += ::MessageTextFromValue( aUnits, m_lastLength );
448 status += wxT( "/" );
450 status += wxT( " (gap: " );
451 status += ::MessageTextFromValue( aUnits, m_originPair.Gap() );
452 status += wxT( ")" );
453
454 return status;
455}
wxString MessageTextFromValue(EDA_UNITS aUnits, int aValue, bool aAddUnitLabel, EDA_DATA_TYPE aType)
Convert a value to a string using double notation.
Definition: base_units.cpp:103

References _, PNS::DIFF_PAIR::Gap(), m_lastLength, m_lastStatus, m_originPair, PNS::MEANDER_PLACER_BASE::m_settings, PNS::MEANDER_SETTINGS::m_targetLength, MessageTextFromValue(), PNS::MEANDER_PLACER_BASE::TOO_LONG, PNS::MEANDER_PLACER_BASE::TOO_SHORT, and PNS::MEANDER_PLACER_BASE::TUNED.

◆ TuningStatus()

DP_MEANDER_PLACER::TUNING_STATUS PNS::DP_MEANDER_PLACER::TuningStatus ( ) const
overridevirtual

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

Implements PNS::MEANDER_PLACER_BASE.

Definition at line 458 of file pns_dp_meander_placer.cpp.

459{
460 return m_lastStatus;
461}

References m_lastStatus.

◆ UnfixRoute()

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

Reimplemented in PNS::LINE_PLACER.

Definition at line 81 of file pns_placement_algo.h.

81{ return false; };

◆ UpdateSettings()

void PNS::MEANDER_PLACER_BASE::UpdateSettings ( const MEANDER_SETTINGS aSettings)
virtualinherited

◆ 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 171 of file pns_placement_algo.h.

172 {
173 }

◆ VisibleViewArea()

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

Definition at line 40 of file pns_algo_base.cpp.

41{
42 return m_router->VisibleViewArea();
43}
const BOX2I & VisibleViewArea() const
Definition: pns_router.h:211

References PNS::ALGO_BASE::m_router, and PNS::ROUTER::VisibleViewArea().

Referenced by PNS::DRAGGER::optimizeAndUpdateDraggedLine(), and PNS::SHOVE::runOptimizer().

Friends And Related Function Documentation

◆ MEANDER_SHAPE

friend class MEANDER_SHAPE
friend

Definition at line 110 of file pns_dp_meander_placer.h.

Member Data Documentation

◆ m_coupledSegments

DIFF_PAIR::COUPLED_SEGMENTS_VEC PNS::DP_MEANDER_PLACER::m_coupledSegments
private

Definition at line 132 of file pns_dp_meander_placer.h.

◆ m_currentEnd

VECTOR2I PNS::MEANDER_PLACER_BASE::m_currentEnd
protectedinherited

◆ m_currentNode

NODE* PNS::DP_MEANDER_PLACER::m_currentNode
private

◆ m_currentStart

VECTOR2I PNS::DP_MEANDER_PLACER::m_currentStart
private

Current world state.

Definition at line 126 of file pns_dp_meander_placer.h.

Referenced by Move(), and Start().

◆ m_currentTraceN

LINE PNS::DP_MEANDER_PLACER::m_currentTraceN
private

Definition at line 134 of file pns_dp_meander_placer.h.

Referenced by Traces().

◆ m_currentTraceP

LINE PNS::DP_MEANDER_PLACER::m_currentTraceP
private

Definition at line 134 of file pns_dp_meander_placer.h.

Referenced by Trace(), and Traces().

◆ m_currentWidth

◆ m_debugDecorator

DEBUG_DECORATOR* PNS::ALGO_BASE::m_debugDecorator
protectedinherited

Definition at line 86 of file pns_algo_base.h.

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

◆ m_endPad_n

◆ m_endPad_p

◆ m_finalShapeN

SHAPE_LINE_CHAIN PNS::DP_MEANDER_PLACER::m_finalShapeN
private

Definition at line 137 of file pns_dp_meander_placer.h.

Referenced by FixRoute(), Move(), and Traces().

◆ m_finalShapeP

SHAPE_LINE_CHAIN PNS::DP_MEANDER_PLACER::m_finalShapeP
private

Definition at line 137 of file pns_dp_meander_placer.h.

Referenced by FixRoute(), Move(), and Traces().

◆ m_initialSegment

LINKED_ITEM* PNS::DP_MEANDER_PLACER::m_initialSegment
private

Definition at line 139 of file pns_dp_meander_placer.h.

Referenced by CurrentLayer(), DP_MEANDER_PLACER(), and Start().

◆ m_lastLength

long long int PNS::DP_MEANDER_PLACER::m_lastLength
private

Definition at line 141 of file pns_dp_meander_placer.h.

Referenced by DP_MEANDER_PLACER(), Move(), and TuningInfo().

◆ m_lastStatus

TUNING_STATUS PNS::DP_MEANDER_PLACER::m_lastStatus
private

Definition at line 144 of file pns_dp_meander_placer.h.

Referenced by DP_MEANDER_PLACER(), Move(), TuningInfo(), and TuningStatus().

◆ m_logger

LOGGER* PNS::ALGO_BASE::m_logger
protectedinherited

Definition at line 88 of file pns_algo_base.h.

Referenced by PNS::ALGO_BASE::SetLogger().

◆ m_originPair

DIFF_PAIR PNS::DP_MEANDER_PLACER::m_originPair
private

◆ m_padToDieLength

int PNS::MEANDER_PLACER_BASE::m_padToDieLength
protectedinherited

◆ m_padToDieN

int PNS::DP_MEANDER_PLACER::m_padToDieN
private

Definition at line 143 of file pns_dp_meander_placer.h.

Referenced by DP_MEANDER_PLACER(), and Start().

◆ m_padToDieP

int PNS::DP_MEANDER_PLACER::m_padToDieP
private

Definition at line 142 of file pns_dp_meander_placer.h.

Referenced by DP_MEANDER_PLACER(), and Start().

◆ m_result

MEANDERED_LINE PNS::DP_MEANDER_PLACER::m_result
private

Definition at line 138 of file pns_dp_meander_placer.h.

Referenced by CheckFit(), and Move().

◆ m_router

◆ m_settings

◆ m_startPad_n

◆ m_startPad_p

SOLID* PNS::MEANDER_PLACER_BASE::m_startPad_p
protectedinherited

◆ m_tunedPath

ITEM_SET PNS::DP_MEANDER_PLACER::m_tunedPath
private

Definition at line 135 of file pns_dp_meander_placer.h.

◆ m_tunedPathN

ITEM_SET PNS::DP_MEANDER_PLACER::m_tunedPathN
private

Definition at line 135 of file pns_dp_meander_placer.h.

Referenced by Move(), origPathLength(), and Start().

◆ m_tunedPathP

ITEM_SET PNS::DP_MEANDER_PLACER::m_tunedPathP
private

Definition at line 135 of file pns_dp_meander_placer.h.

Referenced by Move(), origPathLength(), and Start().

◆ m_world


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