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:

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 const wxString	TuningInfo (EDA_UNITS aUnits) const =0
	Return a string describing the status and length of the tuned traces. More...

virtual TUNING_STATUS	TuningStatus () const =0
	Return the tuning status (too short, too long, etc.) of the trace(s) being tuned. 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_SETTINGS &	MeanderSettings () const
	Return the current meandering configuration. More...

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

int	GetTotalPadToDieLength (const LINE &aLine) const

virtual bool	Start (const VECTOR2I &aP, ITEM *aStartItem)=0
	Function Start() More...

virtual bool	Move (const VECTOR2I &aP, ITEM *aEndItem)=0
	Function Move() More...

virtual bool	FixRoute (const VECTOR2I &aP, ITEM *aEndItem, bool aForceFinish=false)=0
	Function FixRoute() More...

virtual bool	UnfixRoute ()

virtual bool	CommitPlacement ()

virtual bool	AbortPlacement ()

virtual bool	HasPlacedAnything () const

virtual bool	ToggleVia (bool aEnabled)
	Function ToggleVia() More...

virtual bool	IsPlacingVia () const
	Function IsPlacingVia() More...

virtual bool	SetLayer (int aLayer)
	Function SetLayer() More...

virtual const ITEM_SET	Traces ()=0
	Function Traces() More...

virtual const VECTOR2I &	CurrentEnd () const =0
	Function CurrentEnd() More...

virtual const std::vector< int >	CurrentNets () const =0
	Function CurrentNets() More...

virtual int	CurrentLayer () const =0
	Function CurrentLayer() More...

virtual NODE *	CurrentNode (bool aLoopsRemoved=false) const =0
	Function CurrentNode() 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...

ROUTER *	Router () const
	Return current router settings. More...

ROUTING_SETTINGS &	Settings () const
	Return the logger object, allowing to dump geometry to a file. More...

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

DEBUG_DECORATOR *	Dbg () const

const BOX2I &	VisibleViewArea () 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
	Calculate the total length of the line represented by an item set (tracks and vias) More...

Protected Attributes
NODE *	m_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

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.

                        {
         TOO_SHORT = 0,
         TOO_LONG,
         TUNED
     };

Constructor & Destructor Documentation

◆ MEANDER_PLACER_BASE()

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

Definition at line 30 of file pns_meander_placer_base.cpp.

                                                           :
         PLACEMENT_ALGO( aRouter )
 {
     m_world = nullptr;
     m_currentWidth = 0;
     m_padToDieLength = 0;
 }

References m_currentWidth, m_padToDieLength, and m_world.

◆ ~MEANDER_PLACER_BASE()

PNS::MEANDER_PLACER_BASE::~MEANDER_PLACER_BASE ( )

virtual

Definition at line 39 of file pns_meander_placer_base.cpp.

40 {

41 }

Member Function Documentation

◆ AbortPlacement()

virtual bool PNS::PLACEMENT_ALGO::AbortPlacement ( )

inlinevirtualinherited

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

Definition at line 85 of file pns_placement_algo.h.

85 { return false; };

◆ AmplitudeStep()

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

virtual

Increase/decreases the current meandering amplitude by one step.

Parameters

aSign direction (negative = decrease, positive = increase).

Definition at line 44 of file pns_meander_placer_base.cpp.

 {
     int a = m_settings.m_maxAmplitude + aSign * m_settings.m_step;
     a = std::max( a,  m_settings.m_minAmplitude );
 
     m_settings.m_maxAmplitude = a;
 }

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

◆ 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

aShape the shape to check.

Returns: true if the shape fits.

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

Definition at line 110 of file pns_meander_placer_base.h.

     {
         return false;
     }

Referenced by PNS::MEANDER_SHAPE::Fit().

◆ 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 62 of file pns_meander_placer_base.cpp.

 {
     // Assumption: All tracks are part of the same net class.
     // It shouldn't matter which track we pick. They should all have the same clearance if
     // they are part of the same net class. Therefore, pick the first one on the list.
     ITEM*           itemToCheck = Traces().CItems().front().item;
     PNS::CONSTRAINT constraint;
 
     Router()->GetRuleResolver()->QueryConstraint( PNS::CONSTRAINT_TYPE::CT_CLEARANCE, itemToCheck,
                                                   nullptr, CurrentLayer(), &constraint );
 
     wxCHECK_MSG( constraint.m_Value.HasMin(), m_currentWidth, "No minimum clearance?" );
 
     return constraint.m_Value.Min();
 }

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 PNS::MEANDER_SHAPE::spacing(), and SpacingStep().

◆ CommitPlacement()

virtual bool PNS::PLACEMENT_ALGO::CommitPlacement ( )

inlinevirtualinherited

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

Definition at line 83 of file pns_placement_algo.h.

83 { return false; };

◆ compareWithTolerance()

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

protected

Compare aValue against aExpected with given tolerance.

Definition at line 245 of file pns_meander_placer_base.cpp.

 {
     if( aValue < aExpected - aTolerance )
         return -1;
     else if( aValue > aExpected + aTolerance )
         return 1;
     else
         return 0;
 }

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

◆ 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::LINE_PLACER, PNS::DIFF_PAIR_PLACER, PNS::DP_MEANDER_PLACER, and PNS::MEANDER_PLACER.

◆ CurrentLayer()

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

pure virtualinherited

Function CurrentLayer()

Returns the layer of currently routed track.

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

Referenced by Clearance().

◆ CurrentNets()

virtual const std::vector<int> PNS::PLACEMENT_ALGO::CurrentNets ( ) const

pure virtualinherited

Function CurrentNets()

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

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

◆ CurrentNode()

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

pure virtualinherited

Function CurrentNode()

Returns the most recent board state.

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

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

protected

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

Parameters

aOrigin	the original line.
aTuneStart	point where we start meandering (start click coordinates).
aCursorPos	current cursor position.
aPre	part before the beginning of meanders.
aTuned	part to be meandered.
aPost	part after the end of meanders.

Definition at line 85 of file pns_meander_placer_base.cpp.

 {
     VECTOR2I cp ( aCursorPos );
 
     if( cp == aTuneStart ) // we don't like tuning segments with 0 length
     {
         int idx = aOrigin.FindSegment( cp );
 
         if( idx >= 0 )
         {
             const SEG& s = aOrigin.CSegment( idx );
             cp += (s.B - s.A).Resize(2);
         }
         else
         {
             cp += VECTOR2I (2, 5); // some arbitrary value that is not 45 degrees oriented
         }
     }
 
     VECTOR2I n = aOrigin.NearestPoint( cp, false );
     VECTOR2I m = aOrigin.NearestPoint( aTuneStart, false );
 
     SHAPE_LINE_CHAIN l( aOrigin );
     l.Split( n );
     l.Split( m );
 
     int i_start = l.Find( m );
     int i_end = l.Find( n );
 
     if( i_start > i_end )
     {
         l = l.Reverse();
         i_start = l.Find( m );
         i_end = l.Find( n );
     }
 
     aPre = l.Slice( 0, i_start );
     aPost = l.Slice( i_end, -1 );
     aTuned = l.Slice( i_start, i_end );
 
     aTuned.Simplify();
 }

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 PNS::DP_MEANDER_PLACER::Move().

◆ Dbg()

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

inlineinherited

Definition at line 78 of file pns_algo_base.h.

     {
         return m_debugDecorator;
     }

References PNS::ALGO_BASE::m_debugDecorator.

Referenced by PNS::MEANDER_PLACER::doMove(), PNS::COMPONENT_DRAGGER::Drag(), PNS::DRAGGER::dragShove(), PNS::DRAGGER::dragWalkaround(), PNS::MEANDER_SKEW_PLACER::Move(), PNS::DP_MEANDER_PLACER::Move(), PNS::SHOVE::onCollidingArc(), PNS::SHOVE::onCollidingLine(), PNS::SHOVE::onCollidingSegment(), PNS::SHOVE::onCollidingSolid(), PNS::SHOVE::onCollidingVia(), PNS::DRAGGER::optimizeAndUpdateDraggedLine(), PNS::LINE_PLACER::optimizeTailHeadTransition(), PNS::SHOVE::pushOrShoveVia(), PNS::SHOVE::replaceLine(), PNS::LINE_PLACER::rhShoveOnly(), PNS::LINE_PLACER::rhWalkOnly(), PNS::LINE_PLACER::routeStep(), PNS::SHOVE::runOptimizer(), PNS::SHOVE::shoveIteration(), PNS::SHOVE::ShoveLines(), PNS::SHOVE::shoveLineToHullSet(), PNS::SHOVE::shoveMainLoop(), PNS::SHOVE::ShoveMultiLines(), PNS::SHOVE::ShoveObstacleLine(), PNS::WALKAROUND::singleStep(), PNS::DRAGGER::Start(), and PNS::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::LINE_PLACER, PNS::DIFF_PAIR_PLACER, PNS::DP_MEANDER_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::LINE_PLACER, and PNS::DIFF_PAIR_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::LINE_PLACER, and PNS::DIFF_PAIR_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
	)

protected

Definition at line 257 of file pns_meander_placer_base.cpp.

 {
     if( aStartItem->Kind() == ITEM::SEGMENT_T )
     {
         return static_cast<SEGMENT*>( aStartItem )->Seg().NearestPoint( aStartPoint );
     }
     else
     {
         wxASSERT( aStartItem->Kind() == ITEM::ARC_T );
         ARC* arc = static_cast<ARC*>( aStartItem );
 
         if( ( VECTOR2I( arc->Anchor( 0 ) - aStartPoint ) ).SquaredEuclideanNorm() <=
             ( VECTOR2I( arc->Anchor( 1 ) - aStartPoint ) ).SquaredEuclideanNorm() )
         {
             return arc->Anchor( 0 );
         }
         else
         {
             return arc->Anchor( 1 );
         }
     }
 }

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

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

◆ GetTotalPadToDieLength()

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

Definition at line 201 of file pns_meander_placer_base.cpp.

 {
     int   length = 0;
     JOINT start;
     JOINT end;
 
     m_world->FindLineEnds( aLine, start, end );
 
     // Extract the length of the pad to die for start and end pads
     for( auto& link : start.LinkList() )
     {
         if( const SOLID* solid = dynamic_cast<const SOLID*>( link.item ) )
         {
             // If there are overlapping pads, choose the first with a non-zero length
             if( solid->GetPadToDie() > 0 )
             {
                 length += solid->GetPadToDie();
                 break;
             }
         }
     }
 
     for( auto& link : end.LinkList() )
     {
         if( const SOLID* solid = dynamic_cast<const SOLID*>( link.item ) )
         {
             if( solid->GetPadToDie() > 0 )
             {
                 length += solid->GetPadToDie();
                 break;
             }
         }
     }
 
     return length;
 }

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

◆ HasPlacedAnything()

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

inlinevirtualinherited

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

Definition at line 87 of file pns_placement_algo.h.

87 { return false; }

◆ 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::LINE_PLACER, and PNS::DIFF_PAIR_PLACER.

Definition at line 104 of file pns_placement_algo.h.

     {
         return false;
     }

◆ lineLength()

long long int PNS::MEANDER_PLACER_BASE::lineLength ( const ITEM_SET & aLine ) const

protected

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

Parameters

aLine @returnPointer to world to search colliding items.

Definition at line 281 of file pns_meander_placer_base.cpp.

 {
     long long int total = 0;
 
     for( int idx = 0; idx < aLine.Size(); idx++ )
     {
         const ITEM* item = aLine[idx];
 
         if( const LINE* l = dyn_cast<const LINE*>( item ) )
         {
             total += l->CLine().Length();
         }
         else if( item->OfKind( ITEM::VIA_T ) && idx > 0 && idx < aLine.Size() - 1 )
         {
             int layerPrev = aLine[idx - 1]->Layer();
             int layerNext = aLine[idx + 1]->Layer();
 
             if( layerPrev != layerNext )
                 total += m_router->GetInterface()->StackupHeight( layerPrev, layerNext );
         }
     }
 
     return total;
 }

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

Referenced by PNS::MEANDER_SKEW_PLACER::origPathLength(), PNS::MEANDER_PLACER::origPathLength(), PNS::DP_MEANDER_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.

 {
     return nullptr;
 }

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

◆ MeanderSettings()

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

virtual

Return the current meandering configuration.

Returns: the settings

Definition at line 239 of file pns_meander_placer_base.cpp.

 {
     return m_settings;
 }

References m_settings.

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

◆ 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::LINE_PLACER, PNS::DIFF_PAIR_PLACER, PNS::DP_MEANDER_PLACER, PNS::MEANDER_PLACER, and PNS::MEANDER_SKEW_PLACER.

◆ Router()

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

inlineinherited

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

     {
         m_debugDecorator = aDecorator;
     }

References PNS::ALGO_BASE::m_debugDecorator.

Referenced by 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::LINE_PLACER, and PNS::DIFF_PAIR_PLACER.

Definition at line 114 of file pns_placement_algo.h.

     {
         return false;
     }

◆ SetLogger()

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

inlineinherited

Definition at line 65 of file pns_algo_base.h.

     {
         m_logger = aLogger;
     }

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::LINE_PLACER, and PNS::DIFF_PAIR_PLACER.

Definition at line 182 of file pns_placement_algo.h.

183 {

184 }

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

 {
     return m_router->Settings();
 }

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

◆ SpacingStep()

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

virtual

Increase/decrease the current meandering spacing by one step.

Parameters

aSign direction (negative = decrease, positive = increase).

Definition at line 53 of file pns_meander_placer_base.cpp.

 {
     int s = m_settings.m_spacing + aSign * m_settings.m_step;
     s = std::max( s, m_currentWidth + Clearance() );
 
     m_settings.m_spacing = s;
 }

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

◆ 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::LINE_PLACER, PNS::DIFF_PAIR_PLACER, PNS::DP_MEANDER_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::LINE_PLACER, and PNS::DIFF_PAIR_PLACER.

Definition at line 94 of file pns_placement_algo.h.

     {
         return false;
     }

◆ Traces()

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

pure virtualinherited

Function Traces()

Returns all routed/tuned traces.

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

Referenced by Clearance().

◆ 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 131 of file pns_meander_placer_base.cpp.

 {
     long long int remaining = aElongation;
     bool finished = false;
 
     for( MEANDER_SHAPE* m : aTuned.Meanders() )
     {
         if( m->Type() != MT_CORNER && m->Type() != MT_ARC )
         {
             if( remaining >= 0 )
                 remaining -= m->MaxTunableLength() - m->BaselineLength();
 
             if( remaining < 0 )
             {
                 if( !finished )
                 {
                     MEANDER_TYPE newType;
 
                     if( m->Type() == MT_START || m->Type() == MT_SINGLE )
                         newType = MT_SINGLE;
                     else
                         newType = MT_FINISH;
 
                     m->SetType( newType );
                     m->Recalculate();
 
                     finished = true;
                 }
                 else
                 {
                     m->MakeEmpty();
                 }
             }
         }
     }
 
     remaining = aElongation;
     int meanderCount = 0;
 
     for( MEANDER_SHAPE* m : aTuned.Meanders() )
     {
         if( m->Type() != MT_CORNER && m->Type() != MT_ARC && m->Type() != MT_EMPTY )
         {
             if(remaining >= 0)
             {
                 remaining -= m->MaxTunableLength() - m->BaselineLength();
                 meanderCount ++;
             }
         }
     }
 
     long long int balance = 0;
 
     if( meanderCount )
         balance = -remaining / meanderCount;
 
     if( balance >= 0 )
     {
         for( MEANDER_SHAPE* m : aTuned.Meanders() )
         {
             if( m->Type() != MT_CORNER && m->Type() != MT_ARC && m->Type() != MT_EMPTY )
             {
                 m->Resize( std::max( m->Amplitude() - balance / 2,
                            (long long int) m_settings.m_minAmplitude ) );
             }
         }
     }
 }

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

◆ TuningInfo()

virtual const wxString PNS::MEANDER_PLACER_BASE::TuningInfo ( EDA_UNITS aUnits ) const

pure virtual

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

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

Referenced by PNS_TUNE_STATUS_POPUP::UpdateStatus().

◆ 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 PNS_TUNE_STATUS_POPUP::UpdateStatus().

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

virtual

Definition at line 79 of file pns_meander_placer_base.cpp.

 {
     m_settings = aSettings;
 }

References m_settings.

Referenced by LENGTH_TUNER_TOOL::meanderSettingsDialog().

◆ 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::LINE_PLACER, and PNS::DIFF_PAIR_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.

 {
     return m_router->VisibleViewArea();
 }

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

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

Member Data Documentation

◆ m_currentEnd

VECTOR2I PNS::MEANDER_PLACER_BASE::m_currentEnd

protected

Definition at line 167 of file pns_meander_placer_base.h.

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

◆ m_currentWidth

int PNS::MEANDER_PLACER_BASE::m_currentWidth

protected

Meander settings.

Definition at line 161 of file pns_meander_placer_base.h.

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

◆ 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_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_padToDieLength

int PNS::MEANDER_PLACER_BASE::m_padToDieLength

protected

Width of the meandered trace(s).

Definition at line 158 of file pns_meander_placer_base.h.

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

◆ m_router

ROUTER* PNS::ALGO_BASE::m_router

protectedinherited

Definition at line 87 of file pns_algo_base.h.

Referenced by lineLength(), PNS::ALGO_BASE::Router(), PNS::ALGO_BASE::Settings(), PNS::DIFF_PAIR_PLACER::updateLeadingRatLine(), PNS::LINE_PLACER::updateLeadingRatLine(), and PNS::ALGO_BASE::VisibleViewArea().

◆ m_settings

MEANDER_SETTINGS PNS::MEANDER_PLACER_BASE::m_settings

protected

The current end point.

Definition at line 164 of file pns_meander_placer_base.h.

Referenced by AmplitudeStep(), PNS::MEANDER_PLACER::CheckFit(), PNS::DP_MEANDER_PLACER::CheckFit(), PNS::MEANDER_PLACER::doMove(), MeanderSettings(), PNS::MEANDER_SKEW_PLACER::Move(), PNS::MEANDER_PLACER::Move(), PNS::DP_MEANDER_PLACER::Move(), SpacingStep(), tuneLineLength(), PNS::MEANDER_SKEW_PLACER::TuningInfo(), PNS::MEANDER_PLACER::TuningInfo(), PNS::DP_MEANDER_PLACER::TuningInfo(), and UpdateSettings().

◆ m_world

NODE* PNS::MEANDER_PLACER_BASE::m_world

protected

Total length added by pad to die size.

Definition at line 155 of file pns_meander_placer_base.h.

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

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

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ TUNING_STATUS

Constructor & Destructor Documentation

◆ MEANDER_PLACER_BASE()

◆ ~MEANDER_PLACER_BASE()

Member Function Documentation

◆ AbortPlacement()

◆ AmplitudeStep()

◆ CheckFit()

◆ Clearance()

◆ CommitPlacement()

◆ compareWithTolerance()

◆ CurrentEnd()

◆ CurrentLayer()

◆ CurrentNets()

◆ CurrentNode()

◆ cutTunedLine()

◆ Dbg()

◆ FixRoute()

◆ FlipPosture()

◆ GetModifiedNets()

◆ getSnappedStartPoint()

◆ GetTotalPadToDieLength()

◆ HasPlacedAnything()

◆ IsPlacingVia()

◆ lineLength()

◆ Logger()

◆ MeanderSettings()

◆ Move()

◆ Router()

◆ SetDebugDecorator()

◆ SetLayer()

◆ SetLogger()

◆ SetOrthoMode()

◆ Settings()

◆ SpacingStep()

◆ Start()

◆ ToggleVia()

◆ Traces()

◆ tuneLineLength()

◆ TuningInfo()

◆ TuningStatus()

◆ UnfixRoute()

◆ UpdateSettings()

◆ UpdateSizes()

◆ VisibleViewArea()

Member Data Documentation

◆ m_currentEnd

◆ m_currentWidth

◆ m_debugDecorator

◆ m_logger

◆ m_padToDieLength

◆ m_router

◆ m_settings

◆ m_world