#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

Public Member Functions
	MEANDER_PLACER_BASE (ROUTER *aRouter)

virtual const std::string	TuningInfo () const =0
	Function TuningInfo() More...

virtual TUNING_STATUS	TuningStatus () const =0
	Function TuningStatus() More...

virtual void	AmplitudeStep (int aSign)
	Function AmplitudeStep() More...

virtual void	SpacingStep (int aSign)
	Function SpacingStep() More...

virtual const MEANDER_SETTINGS &	MeanderSettings () const
	Function MeanderSettings() More...

virtual void	UpdateSettings (const MEANDER_SETTINGS &aSettings)

virtual bool	CheckFit (MEANDER_SHAPE *aShape)
	Function CheckFit() More...

Public Member Functions inherited from PNS::PLACEMENT_ALGO
	PLACEMENT_ALGO (ROUTER *aRouter)

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

Public Member Functions inherited from PNS::ALGO_BASE
	ALGO_BASE (ROUTER *aRouter)

ROUTER *	Router () const
	Returns the instance of our router

ROUTING_SETTINGS &	Settings () const
	Returns current router settings

virtual LOGGER *	Logger ()
	Returns the logger object, allowing to dump geometry to a file.

void	SetDebugDecorator (DEBUG_DECORATOR *aDecorator)
	Function SetDebugDecorator. More...

DEBUG_DECORATOR *	Dbg () 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)
	Function cutTunedLine() More...

void	tuneLineLength (MEANDERED_LINE &aTuned, int aElongation)
	Function tuneLineLength() More...

int	compareWithTolerance (int aValue, int aExpected, int aTolerance=0) const
	Function compareWithTolerance() More...

Protected Attributes
int	m_currentWidth
	width of the meandered trace(s)

MEANDER_SETTINGS	m_settings
	meandering settings

VECTOR2I	m_currentEnd
	current end point

Detailed Description

Class MEANDER_PLACER_BASE.

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

Member Function Documentation

◆ AmplitudeStep()

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

virtual

Function AmplitudeStep()

Increases/decreases the current meandering amplitude by one step.

Parameters

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

◆ CheckFit()

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

inlinevirtual

Function CheckFit()

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

◆ compareWithTolerance()

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

protected

Function compareWithTolerance()

Compares aValue against aExpected with given tolerance.

◆ 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

Function cutTunedLine()

Extracts 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 coorinates)
aCursorPos	current cursor position
aPre	part before the beginning of meanders
aTuned	part to be meandered
aPost	part after the end of meanders

◆ MeanderSettings()

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

virtual

Function MeanderSettings()

Returns the current meandering configuration.

Returns: the settings

◆ SpacingStep()

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

virtual

Function SpacingStep()

Increases/decreases the current meandering spcing by one step.

Parameters

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

◆ tuneLineLength()

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

protected

Function tuneLineLength()

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

◆ TuningInfo()

virtual const std::string PNS::MEANDER_PLACER_BASE::TuningInfo ( ) const

pure virtual

Function TuningInfo()

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

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

◆ TuningStatus()

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

pure virtual

Function TuningStatus()

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

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

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

3rd_party/router/router/pns_meander_placer_base.h
3rd_party/router/router/pns_meander_placer_base.cpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ AmplitudeStep()

◆ CheckFit()

◆ compareWithTolerance()

◆ cutTunedLine()

◆ MeanderSettings()

◆ SpacingStep()

◆ tuneLineLength()

◆ TuningInfo()

◆ TuningStatus()