#include <pns_placement_algo.h>

Inheritance diagram for PNS::PLACEMENT_ALGO:

Public Member Functions
	PLACEMENT_ALGO (ROUTER *aRouter)

virtual	~PLACEMENT_ALGO ()

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 std::optional< VECTOR2I >	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 &	CurrentStart () const =0
	Function CurrentStart()

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

virtual const std::vector< NET_HANDLE >	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< NET_HANDLE > &aNets) const
	Function GetModifiedNets.

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

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

Definition at line 45 of file pns_placement_algo.h.

Constructor & Destructor Documentation

◆ PLACEMENT_ALGO()

PNS::PLACEMENT_ALGO::PLACEMENT_ALGO ( ROUTER * aRouter )

inline

Definition at line 48 of file pns_placement_algo.h.

◆ ~PLACEMENT_ALGO()

virtual PNS::PLACEMENT_ALGO::~PLACEMENT_ALGO ( )

inlinevirtual

Definition at line 51 of file pns_placement_algo.h.

Member Function Documentation

◆ AbortPlacement()

virtual bool PNS::PLACEMENT_ALGO::AbortPlacement ( )

inlinevirtual

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

Definition at line 85 of file pns_placement_algo.h.

◆ CommitPlacement()

virtual bool PNS::PLACEMENT_ALGO::CommitPlacement ( )

inlinevirtual

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

Definition at line 83 of file pns_placement_algo.h.

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

Referenced by PNS::ROUTER::ContinueFromEnd(), PNS::ROUTER::Finish(), and ROUTER_TOOL::performRouting().

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

Referenced by PNS::MEANDER_PLACER_BASE::Clearance(), and PNS::ROUTER::getNearestRatnestAnchor().

◆ CurrentNets()

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

pure virtual

Function CurrentNets()

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

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

Referenced by PNS::ROUTER::getNearestRatnestAnchor().

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

Referenced by PNS::ROUTER::getNearestRatnestAnchor().

◆ CurrentStart()

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

pure virtual

Function CurrentStart()

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

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

Referenced by PNS::ROUTER::getNearestRatnestAnchor(), and ROUTER_TOOL::performRouting().

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

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

Definition at line 167 of file pns_placement_algo.h.

◆ GetModifiedNets()

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

inlinevirtual

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.

◆ HasPlacedAnything()

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

inlinevirtual

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

Definition at line 87 of file pns_placement_algo.h.

Referenced by ROUTER_TOOL::performRouting().

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

Definition at line 104 of file pns_placement_algo.h.

◆ 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(), PNS::MULTI_DRAGGER::Start(), PNS::DRAGGER::tryWalkaround(), and PNS::MULTI_DRAGGER::tryWalkaround().

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

◆ Router()

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

inlineinherited

Return current router settings.

Definition at line 54 of file pns_algo_base.h.

References PNS::ALGO_BASE::m_router.

Referenced by PNS::DIFF_PAIR_PLACER::attemptWalk(), PNS::MEANDER_PLACER_BASE::Clearance(), PNS::DIFF_PAIR_PLACER::CommitPlacement(), PNS::DP_MEANDER_PLACER::CommitPlacement(), PNS::LINE_PLACER::CommitPlacement(), PNS::MEANDER_PLACER::CommitPlacement(), PNS::COMPONENT_DRAGGER::FixRoute(), PNS::DRAGGER::FixRoute(), PNS::MULTI_DRAGGER::FixRoute(), PNS::DIFF_PAIR_PLACER::initPlacement(), PNS::LINE_PLACER::initPlacement(), PNS::LINE_PLACER::makeVia(), PNS::MULTI_DRAGGER::multidragShove(), PNS::SHOVE::onCollidingSolid(), PNS::SHOVE::reconstructHeads(), PNS::SHOVE::removeHeads(), PNS::LINE_PLACER::rhWalkBase(), PNS::SHOVE::Run(), PNS::SHOVE::runOptimizer(), PNS::SHOVE::shoveIteration(), PNS::DIFF_PAIR_PLACER::Start(), PNS::DP_MEANDER_PLACER::Start(), PNS::LINE_PLACER::Start(), PNS::MEANDER_PLACER::Start(), PNS::MEANDER_SKEW_PLACER::Start(), PNS::DRAGGER::Start(), PNS::MULTI_DRAGGER::Start(), PNS::DRAGGER::tryWalkaround(), and PNS::MULTI_DRAGGER::tryWalkaround().

◆ 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(), PNS::DRAGGER::tryWalkaround(), and PNS::MULTI_DRAGGER::tryWalkaround().

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

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(), PNS::DRAGGER::tryWalkaround(), and PNS::MULTI_DRAGGER::tryWalkaround().

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

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

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

Definition at line 94 of file pns_placement_algo.h.

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

Referenced by PNS::MEANDER_PLACER_BASE::Clearance(), PNS::ROUTER::ContinueFromEnd(), PNS::ROUTER::Finish(), PNS::ROUTER::getNearestRatnestAnchor(), and ROUTER_TOOL::UpdateMessagePanel().

◆ UnfixRoute()

virtual std::optional< VECTOR2I > PNS::PLACEMENT_ALGO::UnfixRoute ( )

inlinevirtual

Reimplemented in PNS::LINE_PLACER.

Definition at line 81 of file pns_placement_algo.h.

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

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::SHOVE::runOptimizer().

Member Data Documentation

◆ 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::Logger(), and PNS::ALGO_BASE::SetLogger().

◆ m_router

ROUTER* PNS::ALGO_BASE::m_router

protectedinherited

Definition at line 87 of file pns_algo_base.h.

Referenced by PNS::MEANDER_PLACER::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::DIFF_PAIR_PLACER::updateLeadingRatLine(), PNS::LINE_PLACER::updateLeadingRatLine(), and PNS::ALGO_BASE::VisibleViewArea().

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

pns_placement_algo.h

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PLACEMENT_ALGO()

◆ ~PLACEMENT_ALGO()

Member Function Documentation

◆ AbortPlacement()

◆ CommitPlacement()

◆ CurrentEnd()

◆ CurrentLayer()

◆ CurrentNets()

◆ CurrentNode()

◆ CurrentStart()

◆ Dbg()

◆ FixRoute()

◆ FlipPosture()

◆ GetModifiedNets()

◆ HasPlacedAnything()

◆ IsPlacingVia()

◆ Logger()

◆ Move()

◆ Router()

◆ SetDebugDecorator()

◆ SetLayer()

◆ SetLogger()

◆ SetOrthoMode()

◆ Settings()

◆ Start()

◆ ToggleVia()

◆ Traces()

◆ UnfixRoute()

◆ UpdateSizes()

◆ VisibleViewArea()

Member Data Documentation

◆ m_debugDecorator

◆ m_logger

◆ m_router