Single track length matching/meandering tool. More...

#include <pns_meander_placer.h>

Inheritance diagram for PNS::MEANDER_PLACER:

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

Public Member Functions
	MEANDER_PLACER (ROUTER *aRouter)

virtual	~MEANDER_PLACER ()

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

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

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

bool	CommitPlacement () override

bool	AbortPlacement () override

bool	HasPlacedAnything () const override

NODE *	CurrentNode (bool aLoopsRemoved=false) const override
	Function CurrentNode() More...

const ITEM_SET	Traces () override
	Function Traces() More...

const VECTOR2I &	CurrentStart () const override
	Function CurrentStart() More...

const VECTOR2I &	CurrentEnd () const override
	Function CurrentEnd() More...

const std::vector< NET_HANDLE >	CurrentNets () const override
	Function CurrentNets() More...

int	CurrentLayer () const override
	Function CurrentLayer() More...

virtual const wxString	TuningInfo (EDA_UNITS aUnits) const override
	Return a string describing the status and length of the tuned traces. More...

virtual 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_SETTINGS &	MeanderSettings () const
	Return the current meandering configuration. More...

virtual void	UpdateSettings (const MEANDER_SETTINGS &aSettings)

int	GetTotalPadToDieLength (const LINE &aLine) const

virtual std::optional< VECTOR2I >	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< NET_HANDLE > &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
bool	doMove (const VECTOR2I &aP, ITEM *aEndItem, long long int aTargetLength)

void	setWorld (NODE *aWorld)

virtual long long int	origPathLength () const
	current routing start point (end of tail, beginning of head) More...

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
VECTOR2I	m_currentStart
	Current world state. More...

NODE *	m_currentNode

LINE	m_originLine

LINE	m_currentTrace

ITEM_SET	m_tunedPath

SHAPE_LINE_CHAIN	m_finalShape

MEANDERED_LINE	m_result

LINKED_ITEM *	m_initialSegment
	Total length added by pad to die size. More...

int	m_padToDieLength

long long int	m_lastLength

TUNING_STATUS	m_lastStatus

NODE *	m_world
	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

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

Single track length matching/meandering tool.

Definition at line 45 of file pns_meander_placer.h.

Member Enumeration Documentation

◆ TUNING_STATUS

enum PNS::MEANDER_PLACER_BASE::TUNING_STATUS

inherited

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

PNS::MEANDER_PLACER::MEANDER_PLACER ( ROUTER * aRouter )

Definition at line 34 of file pns_meander_placer.cpp.

References m_currentNode, m_initialSegment, m_lastLength, m_lastStatus, m_padToDieLength, and PNS::MEANDER_PLACER_BASE::TOO_SHORT.

◆ ~MEANDER_PLACER()

PNS::MEANDER_PLACER::~MEANDER_PLACER ( )

virtual

Definition at line 47 of file pns_meander_placer.cpp.

Member Function Documentation

◆ AbortPlacement()

bool PNS::MEANDER_PLACER::AbortPlacement ( )

overridevirtual

Reimplemented from PNS::PLACEMENT_ALGO.

Definition at line 215 of file pns_meander_placer.cpp.

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

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

Definition at line 49 of file pns_meander_placer_base.cpp.

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

◆ CheckFit()

bool PNS::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

aShape the shape to check.

Returns: true if the shape fits.

Reimplemented from PNS::MEANDER_PLACER_BASE.

Definition at line 238 of file pns_meander_placer.cpp.

References PNS::NODE::CheckColliding(), PNS::MEANDERED_LINE::CheckSelfIntersections(), PNS::MEANDER_SHAPE::CLine(), m_currentNode, m_originLine, m_result, PNS::MEANDER_PLACER_BASE::m_settings, PNS::MEANDER_SETTINGS::m_spacing, 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 67 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(), 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::MEANDER_PLACER::CommitPlacement ( )

overridevirtual

Reimplemented from PNS::PLACEMENT_ALGO.

Definition at line 228 of file pns_meander_placer.cpp.

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

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

◆ CurrentEnd()

const VECTOR2I & PNS::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 263 of file pns_meander_placer.cpp.

References PNS::MEANDER_PLACER_BASE::m_currentEnd.

◆ CurrentLayer()

int PNS::MEANDER_PLACER::CurrentLayer ( ) const

overridevirtual

Function CurrentLayer()

Returns the layer of currently routed track.

Implements PNS::PLACEMENT_ALGO.

Definition at line 268 of file pns_meander_placer.cpp.

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

◆ CurrentNets()

const std::vector< NET_HANDLE > PNS::MEANDER_PLACER::CurrentNets ( ) const

inlineoverridevirtual

Function CurrentNets()

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

Implements PNS::PLACEMENT_ALGO.

Definition at line 83 of file pns_meander_placer.h.

References m_originLine, and PNS::ITEM::Net().

◆ CurrentNode()

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

overridevirtual

Function CurrentNode()

Returns the most recent board state.

Implements PNS::PLACEMENT_ALGO.

Definition at line 52 of file pns_meander_placer.cpp.

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

◆ CurrentStart()

const VECTOR2I & PNS::MEANDER_PLACER::CurrentStart ( ) const

overridevirtual

Function CurrentStart()

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

Implements PNS::PLACEMENT_ALGO.

Definition at line 258 of file pns_meander_placer.cpp.

References m_currentStart.

◆ 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

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

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

References PNS::ALGO_BASE::m_debugDecorator.

◆ doMove()

bool PNS::MEANDER_PLACER::doMove	(	const VECTOR2I &	aP,
		ITEM *	aEndItem,
		long long int	aTargetLength
	)

protected

Definition at line 108 of file pns_meander_placer.cpp.

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

◆ FixRoute()

bool PNS::MEANDER_PLACER::FixRoute	(	const VECTOR2I &	aP,
		ITEM *	aEndItem,
		bool	aForceFinish = `false`
	)

overridevirtual

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.

Implements PNS::PLACEMENT_ALGO.

Definition at line 202 of file pns_meander_placer.cpp.

References PNS::NODE::Add(), CommitPlacement(), m_currentNode, m_currentTrace, m_finalShape, and m_originLine.

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

◆ getSnappedStartPoint()

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

protectedinherited

Definition at line 356 of file pns_meander_placer_base.cpp.

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

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

◆ GetTotalPadToDieLength()

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

inherited

Definition at line 300 of file pns_meander_placer_base.cpp.

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

◆ HasPlacedAnything()

bool PNS::MEANDER_PLACER::HasPlacedAnything ( ) const

overridevirtual

Reimplemented from PNS::PLACEMENT_ALGO.

Definition at line 222 of file pns_meander_placer.cpp.

References m_currentTrace, and PNS::LINE::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.

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

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 PNS::DP_MEANDER_PLACER::origPathLength(), 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 PNS::ALGO_BASE::m_logger.

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

◆ MeanderSettings()

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

virtualinherited

Return the current meandering configuration.

Returns: the settings

Definition at line 338 of file pns_meander_placer_base.cpp.

References PNS::MEANDER_PLACER_BASE::m_settings.

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

◆ Move()

bool PNS::MEANDER_PLACER::Move	(	const VECTOR2I &	aP,
		ITEM *	aEndItem
	)

overridevirtual

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

Implements PNS::PLACEMENT_ALGO.

Reimplemented in PNS::MEANDER_SKEW_PLACER.

Definition at line 102 of file pns_meander_placer.cpp.

References doMove(), PNS::MEANDER_PLACER_BASE::m_settings, and PNS::MEANDER_SETTINGS::m_targetLength.

◆ origPathLength()

long long int PNS::MEANDER_PLACER::origPathLength ( ) const

protectedvirtual

current routing start point (end of tail, beginning of head)

Reimplemented in PNS::MEANDER_SKEW_PLACER.

Definition at line 96 of file pns_meander_placer.cpp.

References PNS::MEANDER_PLACER_BASE::lineLength(), PNS::MEANDER_PLACER_BASE::m_endPad_n, m_padToDieLength, PNS::MEANDER_PLACER_BASE::m_startPad_n, and m_tunedPath.

Referenced by doMove().

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

References PNS::ALGO_BASE::m_debugDecorator.

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

◆ SetLogger()

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

inlineinherited

Definition at line 65 of file pns_algo_base.h.

References PNS::ALGO_BASE::m_logger.

Referenced by PNS::LINE_PLACER::rhWalkBase(), 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 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 PNS::ALGO_BASE::m_router, and PNS::ROUTER::Settings().

◆ setWorld()

void PNS::MEANDER_PLACER::setWorld ( NODE * aWorld )

protected

◆ SpacingStep()

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

virtualinherited

Increase/decrease the current meandering spacing by one step.

Parameters

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

Definition at line 58 of file pns_meander_placer_base.cpp.

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::MEANDER_PLACER::Start	(	const VECTOR2I &	aP,
		ITEM *	aStartItem
	)

overridevirtual

Function Start()

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

Implements PNS::PLACEMENT_ALGO.

Reimplemented in PNS::MEANDER_SKEW_PLACER.

Definition at line 61 of file pns_meander_placer.cpp.

References _, PNS::ITEM::ARC_T, PNS::NODE::AssembleLine(), PNS::TOPOLOGY::AssembleTuningPath(), PNS::NODE::Branch(), PNS::SOLID::GetPadToDie(), PNS::MEANDER_PLACER_BASE::getSnappedStartPoint(), PNS::ROUTER::GetWorld(), PNS::MEANDER_PLACER_BASE::m_currentEnd, m_currentNode, m_currentStart, PNS::MEANDER_PLACER_BASE::m_currentWidth, PNS::MEANDER_PLACER_BASE::m_endPad_n, m_initialSegment, m_originLine, m_padToDieLength, PNS::MEANDER_PLACER_BASE::m_startPad_n, m_tunedPath, PNS::MEANDER_PLACER_BASE::m_world, PNS::ITEM::OfKind(), PNS::NODE::Remove(), PNS::ALGO_BASE::Router(), PNS::ITEM::SEGMENT_T, PNS::ROUTER::SetFailureReason(), and PNS::LINE::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.

◆ Traces()

const ITEM_SET PNS::MEANDER_PLACER::Traces ( )

overridevirtual

Function Traces()

Returns all routed/tuned traces.

Implements PNS::PLACEMENT_ALGO.

Definition at line 252 of file pns_meander_placer.cpp.

References m_currentTrace, m_finalShape, and m_originLine.

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

References PNS::MEANDER_SHAPE::BaselineLength(), PNS::MEANDER_SHAPE::CurrentLength(), PNS::findAmplitudeForLength(), PNS::MEANDERED_LINE::Meanders(), PNS::MT_ARC, PNS::MT_CORNER, PNS::MT_EMPTY, PNS::MT_FINISH, PNS::MT_SINGLE, PNS::MT_START, PNS::MEANDER_SHAPE::Recalculate(), and PNS::MEANDER_SHAPE::SetType().

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

◆ TuningInfo()

const wxString PNS::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.

Reimplemented in PNS::MEANDER_SKEW_PLACER.

Definition at line 274 of file pns_meander_placer.cpp.

References _, m_lastLength, m_lastStatus, PNS::MEANDER_PLACER_BASE::m_settings, PNS::MEANDER_SETTINGS::m_targetLength, EDA_UNIT_UTILS::UI::MessageTextFromValue(), pcbIUScale, PNS::MEANDER_PLACER_BASE::TOO_LONG, PNS::MEANDER_PLACER_BASE::TOO_SHORT, and PNS::MEANDER_PLACER_BASE::TUNED.

◆ TuningStatus()

MEANDER_PLACER::TUNING_STATUS PNS::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 301 of file pns_meander_placer.cpp.

References m_lastStatus.

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

virtualinherited

Definition at line 84 of file pns_meander_placer_base.cpp.

References PNS::MEANDER_PLACER_BASE::m_settings.

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

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

protectedinherited

Definition at line 164 of file pns_meander_placer_base.h.

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

◆ m_currentNode

NODE* PNS::MEANDER_PLACER::m_currentNode

protected

Definition at line 111 of file pns_meander_placer.h.

Referenced by CheckFit(), CommitPlacement(), CurrentNode(), doMove(), FixRoute(), MEANDER_PLACER(), Start(), and PNS::MEANDER_SKEW_PLACER::Start().

◆ m_currentStart

VECTOR2I PNS::MEANDER_PLACER::m_currentStart

protected

Current world state.

Definition at line 108 of file pns_meander_placer.h.

Referenced by CurrentStart(), doMove(), Start(), and PNS::MEANDER_SKEW_PLACER::Start().

◆ m_currentTrace

LINE PNS::MEANDER_PLACER::m_currentTrace

protected

Definition at line 114 of file pns_meander_placer.h.

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

◆ m_currentWidth

int PNS::MEANDER_PLACER_BASE::m_currentWidth

protectedinherited

Meander settings.

Definition at line 158 of file pns_meander_placer_base.h.

Referenced by PNS::MEANDER_PLACER_BASE::Clearance(), PNS::MEANDER_PLACER_BASE::MEANDER_PLACER_BASE(), PNS::MEANDER_PLACER_BASE::SpacingStep(), PNS::DP_MEANDER_PLACER::Start(), 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 PNS::ALGO_BASE::Dbg(), and PNS::ALGO_BASE::SetDebugDecorator().

◆ m_endPad_n

SOLID* PNS::MEANDER_PLACER_BASE::m_endPad_n

protectedinherited

Definition at line 169 of file pns_meander_placer_base.h.

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

◆ m_endPad_p

SOLID* PNS::MEANDER_PLACER_BASE::m_endPad_p

protectedinherited

Definition at line 167 of file pns_meander_placer_base.h.

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

◆ m_finalShape

SHAPE_LINE_CHAIN PNS::MEANDER_PLACER::m_finalShape

protected

Definition at line 117 of file pns_meander_placer.h.

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

◆ m_initialSegment

LINKED_ITEM* PNS::MEANDER_PLACER::m_initialSegment

protected

Total length added by pad to die size.

Definition at line 119 of file pns_meander_placer.h.

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

◆ m_lastLength

long long int PNS::MEANDER_PLACER::m_lastLength

protected

Definition at line 124 of file pns_meander_placer.h.

Referenced by PNS::MEANDER_SKEW_PLACER::currentSkew(), doMove(), MEANDER_PLACER(), TuningInfo(), and PNS::MEANDER_SKEW_PLACER::TuningInfo().

◆ m_lastStatus

TUNING_STATUS PNS::MEANDER_PLACER::m_lastStatus

protected

Definition at line 125 of file pns_meander_placer.h.

Referenced by doMove(), MEANDER_PLACER(), TuningInfo(), PNS::MEANDER_SKEW_PLACER::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::Logger(), and PNS::ALGO_BASE::SetLogger().

◆ m_originLine

LINE PNS::MEANDER_PLACER::m_originLine

protected

Definition at line 113 of file pns_meander_placer.h.

Referenced by CheckFit(), CurrentNets(), doMove(), FixRoute(), PNS::MEANDER_SKEW_PLACER::Move(), PNS::MEANDER_SKEW_PLACER::origPathLength(), Start(), PNS::MEANDER_SKEW_PLACER::Start(), and Traces().

◆ m_padToDieLength

int PNS::MEANDER_PLACER::m_padToDieLength

protected

Definition at line 122 of file pns_meander_placer.h.

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

◆ m_result

MEANDERED_LINE PNS::MEANDER_PLACER::m_result

protected

Definition at line 118 of file pns_meander_placer.h.

Referenced by CheckFit(), and doMove().

◆ m_router

ROUTER* PNS::ALGO_BASE::m_router

protectedinherited

Definition at line 87 of file pns_algo_base.h.

Referenced by doMove(), PNS::LINE_PLACER::FixRoute(), PNS::MEANDER_PLACER_BASE::lineLength(), PNS::DP_MEANDER_PLACER::Move(), PNS::MEANDER_SKEW_PLACER::Move(), PNS::ALGO_BASE::Router(), PNS::ALGO_BASE::Settings(), PNS::SHOVE::ShoveObstacleLine(), PNS::DIFF_PAIR_PLACER::updateLeadingRatLine(), PNS::LINE_PLACER::updateLeadingRatLine(), and PNS::ALGO_BASE::VisibleViewArea().

◆ m_settings

MEANDER_SETTINGS PNS::MEANDER_PLACER_BASE::m_settings

protectedinherited

The current end point.

Definition at line 161 of file pns_meander_placer_base.h.

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

◆ m_startPad_n

SOLID* PNS::MEANDER_PLACER_BASE::m_startPad_n

protectedinherited

Definition at line 168 of file pns_meander_placer_base.h.

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

◆ m_startPad_p

SOLID* PNS::MEANDER_PLACER_BASE::m_startPad_p

protectedinherited

Definition at line 166 of file pns_meander_placer_base.h.

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

◆ m_tunedPath

ITEM_SET PNS::MEANDER_PLACER::m_tunedPath

protected

Definition at line 115 of file pns_meander_placer.h.

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

◆ m_world

NODE* PNS::MEANDER_PLACER_BASE::m_world

protectedinherited

Width of the meandered trace(s).

Definition at line 155 of file pns_meander_placer_base.h.

Referenced by PNS::DP_MEANDER_PLACER::AbortPlacement(), AbortPlacement(), PNS::DP_MEANDER_PLACER::CurrentNode(), CurrentNode(), doMove(), PNS::DP_MEANDER_PLACER::DP_MEANDER_PLACER(), PNS::MEANDER_PLACER_BASE::GetTotalPadToDieLength(), PNS::MEANDER_PLACER_BASE::MEANDER_PLACER_BASE(), PNS::DP_MEANDER_PLACER::Move(), PNS::DP_MEANDER_PLACER::Start(), Start(), and PNS::MEANDER_SKEW_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()

◆ ~MEANDER_PLACER()

Member Function Documentation

◆ AbortPlacement()

◆ AmplitudeStep()

◆ CheckFit()

◆ Clearance()

◆ CommitPlacement()

◆ compareWithTolerance()

◆ CurrentEnd()

◆ CurrentLayer()

◆ CurrentNets()

◆ CurrentNode()

◆ CurrentStart()

◆ cutTunedLine()

◆ Dbg()

◆ doMove()

◆ FixRoute()

◆ FlipPosture()

◆ GetModifiedNets()

◆ getSnappedStartPoint()

◆ GetTotalPadToDieLength()

◆ HasPlacedAnything()

◆ IsPlacingVia()

◆ lineLength()

◆ Logger()

◆ MeanderSettings()

◆ Move()

◆ origPathLength()

◆ Router()

◆ SetDebugDecorator()

◆ SetLayer()

◆ SetLogger()

◆ SetOrthoMode()

◆ Settings()

◆ setWorld()

◆ SpacingStep()

◆ Start()

◆ ToggleVia()

◆ Traces()

◆ tuneLineLength()

◆ TuningInfo()

◆ TuningStatus()

◆ UnfixRoute()

◆ UpdateSettings()

◆ UpdateSizes()

◆ VisibleViewArea()

Member Data Documentation

◆ m_currentEnd

◆ m_currentNode

◆ m_currentStart

◆ m_currentTrace

◆ m_currentWidth

◆ m_debugDecorator

◆ m_endPad_n

◆ m_endPad_p

◆ m_finalShape

◆ m_initialSegment

◆ m_lastLength

◆ m_lastStatus

◆ m_logger

◆ m_originLine

◆ m_padToDieLength

◆ m_result

◆ m_router

◆ m_settings

◆ m_startPad_n

◆ m_startPad_p

◆ m_tunedPath

◆ m_world