#include <pns_meander_placer.h>

Inheritance diagram for PNS::MEANDER_PLACER:

Public Member Functions
	MEANDER_PLACER (ROUTER *aRouter)

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

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

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

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

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

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

virtual const std::string	TuningInfo () const override
	Function TuningInfo() More...

virtual TUNING_STATUS	TuningStatus () const override
	Function TuningStatus() More...

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

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

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)

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

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

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
bool	doMove (const VECTOR2I &aP, ITEM *aEndItem, int aTargetLength)

void	setWorld (NODE *aWorld)

virtual int	origPathLength () const

Protected Member Functions inherited from PNS::MEANDER_PLACER_BASE
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
NODE *	m_world
	pointer to world to search colliding items

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

NODE *	m_currentNode
	Current world state

LINE	m_originLine

LINE	m_currentTrace

ITEM_SET	m_tunedPath

SHAPE_LINE_CHAIN	m_finalShape

MEANDERED_LINE	m_result

SEGMENT *	m_initialSegment

int	m_lastLength

TUNING_STATUS	m_lastStatus

Protected Attributes inherited from PNS::MEANDER_PLACER_BASE
int	m_currentWidth
	width of the meandered trace(s)

MEANDER_SETTINGS	m_settings
	meandering settings

VECTOR2I	m_currentEnd
	current end point

Additional Inherited Members
Public Types inherited from PNS::MEANDER_PLACER_BASE
enum	TUNING_STATUS { TOO_SHORT = 0 , TOO_LONG , TUNED }
	Result of the length tuning operation

Detailed Description

Class MEANDER_PLACER.

Single track length matching/meandering tool.

Member Function Documentation

◆ CheckFit()

bool PNS::MEANDER_PLACER::CheckFit ( MEANDER_SHAPE * aShape )

overridevirtual

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

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

◆ CurrentLayer()

int PNS::MEANDER_PLACER::CurrentLayer ( ) const

overridevirtual

Function CurrentLayer()

Returns the layer of currently routed track.

Implements PNS::PLACEMENT_ALGO.

◆ CurrentNets()

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

inlineoverridevirtual

Function CurrentNets()

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

Implements PNS::PLACEMENT_ALGO.

◆ CurrentNode()

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

overridevirtual

Function CurrentNode()

Returns the most recent board state.

Implements PNS::PLACEMENT_ALGO.

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