#include <pns_placement_algo.h>

Inheritance diagram for PNS::PLACEMENT_ALGO:

Public Member Functions
	PLACEMENT_ALGO (ROUTER *aRouter)
virtual bool	Start (const VECTOR2I &aP, ITEM *aStartItem)=0
	Function Start().
virtual bool	Move (const VECTOR2I &aP, ITEM *aEndItem)=0
	Function Move().
virtual bool	FixRoute (const VECTOR2I &aP, ITEM *aEndItem, bool aForceFinish=false)=0
	Function FixRoute().
virtual bool	UnfixRoute ()
virtual bool	CommitPlacement ()
virtual bool	AbortPlacement ()
virtual bool	HasPlacedAnything () const
virtual bool	ToggleVia (bool aEnabled)
	Function ToggleVia().
virtual bool	IsPlacingVia () const
	Function IsPlacingVia().
virtual bool	SetLayer (int aLayer)
	Function SetLayer().
virtual const ITEM_SET	Traces ()=0
	Function Traces().
virtual const VECTOR2I &	CurrentEnd () const =0
	Function CurrentEnd().
virtual const std::vector< int >	CurrentNets () const =0
	Function CurrentNets().
virtual int	CurrentLayer () const =0
	Function CurrentLayer().
virtual NODE *	CurrentNode (bool aLoopsRemoved=false) const =0
	Function CurrentNode().
virtual void	FlipPosture ()
	Function FlipPosture().
virtual void	UpdateSizes (const SIZES_SETTINGS &aSizes)
	Function UpdateSizes().
virtual void	SetOrthoMode (bool aOrthoMode)
	Function SetOrthoMode().
virtual void	GetModifiedNets (std::vector< int > &aNets) const
	Function GetModifiedNets.
Public Member Functions inherited from PNS::ALGO_BASE
	ALGO_BASE (ROUTER *aRouter)
virtual	~ALGO_BASE ()
	Return the instance of our router.
ROUTER *	Router () const
	Return current router settings.
ROUTING_SETTINGS &	Settings () const
	Return the logger object, allowing to dump geometry to a file.
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.
DEBUG_DECORATOR *	Dbg () const
const BOX2I &	VisibleViewArea () const

Additional Inherited Members
Protected Attributes inherited from PNS::ALGO_BASE
DEBUG_DECORATOR *	m_debugDecorator
ROUTER *	m_router
LOGGER *	m_logger

Detailed Description

PLACEMENT_ALGO.

Abstract class for a P&S placement/dragging algorithm. All subtools (drag, single/diff pair routing and meandering) are derived from it.

Member Function Documentation

◆ AbortPlacement()

virtual bool PNS::PLACEMENT_ALGO::AbortPlacement ( )

inlinevirtual

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

◆ CommitPlacement()

virtual bool PNS::PLACEMENT_ALGO::CommitPlacement ( )

inlinevirtual

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

◆ CurrentEnd()

virtual const VECTOR2I & PNS::PLACEMENT_ALGO::CurrentEnd ( ) const

pure virtual

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

◆ CurrentLayer()

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

pure virtual

Function CurrentLayer().

Returns the layer of currently routed track.

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

◆ CurrentNets()

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

pure virtual

Function CurrentNets().

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

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

◆ CurrentNode()

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

pure virtual

Function CurrentNode().

Returns the most recent board state.

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

◆ FixRoute()

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

pure virtual

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

◆ FlipPosture()

virtual void PNS::PLACEMENT_ALGO::FlipPosture ( )

inlinevirtual

Function FlipPosture().

Toggles the current posture (straight/diagonal) of the trace head.

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

◆ GetModifiedNets()

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

inlinevirtual

Function GetModifiedNets.

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

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

◆ HasPlacedAnything()

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

inlinevirtual

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

◆ IsPlacingVia()

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

inlinevirtual

Function IsPlacingVia().

Returns true if the placer is placing a via (or more vias).

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

◆ Move()

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

pure virtual

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

◆ SetLayer()

virtual bool PNS::PLACEMENT_ALGO::SetLayer ( int aLayer )

inlinevirtual

Function SetLayer().

Sets the current routing layer.

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

◆ SetOrthoMode()

virtual void PNS::PLACEMENT_ALGO::SetOrthoMode ( bool aOrthoMode )

inlinevirtual

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.

◆ Start()

virtual bool PNS::PLACEMENT_ALGO::Start	(	const VECTOR2I &	aP,
		ITEM *	aStartItem )

pure virtual

Function Start().

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

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

◆ ToggleVia()

virtual bool PNS::PLACEMENT_ALGO::ToggleVia ( bool aEnabled )

inlinevirtual

Function ToggleVia().

Enables/disables a via at the end of currently routed trace.

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

◆ Traces()

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

pure virtual

Function Traces().

Returns all routed/tuned traces.

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

◆ UpdateSizes()

virtual void PNS::PLACEMENT_ALGO::UpdateSizes ( const SIZES_SETTINGS & aSizes )

inlinevirtual

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.

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

3rd_party/router/router/pns_placement_algo.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ AbortPlacement()

◆ CommitPlacement()

◆ CurrentEnd()

◆ CurrentLayer()

◆ CurrentNets()

◆ CurrentNode()

◆ FixRoute()

◆ FlipPosture()

◆ GetModifiedNets()

◆ HasPlacedAnything()

◆ IsPlacingVia()

◆ Move()

◆ SetLayer()

◆ SetOrthoMode()

◆ Start()

◆ ToggleVia()

◆ Traces()

◆ UpdateSizes()