#include <pns_topology.h>

Classes
struct	CLUSTER

struct	PATH_RESULT

struct	WALK_RESULT

Public Types
typedef std::set< const JOINT * >	JOINT_SET

Public Member Functions
	TOPOLOGY (NODE aNode, ROUTER_IFACE aIface=nullptr)

	~TOPOLOGY ()

bool	SimplifyLine (LINE *aLine)

ITEM *	NearestUnconnectedItem (const JOINT aStart, int aAnchor=nullptr, int aKindMask=ITEM::ANY_T)

bool	NearestUnconnectedAnchorPoint (const LINE aTrack, VECTOR2I &aPoint, PNS_LAYER_RANGE &aLayers, ITEM &aItem)

bool	LeadingRatLine (const LINE *aTrack, SHAPE_LINE_CHAIN &aRatLine)

const JOINT_SET	ConnectedJoints (const JOINT *aStart)

const ITEM_SET	ConnectedItems (const JOINT *aStart, int aKindMask=ITEM::ANY_T)

const ITEM_SET	ConnectedItems (ITEM *aStart, int aKindMask=ITEM::ANY_T)

int64_t	ShortestConnectionLength (ITEM aFrom, ITEM aTo)

const ITEM_SET	AssembleTrivialPath (ITEM aStart, std::pair< const JOINT , const JOINT * > *aTerminalJoints=nullptr, bool aFollowLockedSegments=false)
	Assemble a trivial path between two joints given a starting item.

const ITEM_SET	AssembleTuningPath (ROUTER_IFACE aRouterIface, ITEM aStart, SOLID aStartPad=nullptr, SOLID aEndPad=nullptr)
	Like AssembleTrivialPath, but follows the track length algorithm, which discards segments that are fully inside pads, and truncates segments that cross into a pad (adding a straight- line segment from the intersection to the pad anchor).

const DIFF_PAIR	AssembleDiffPair (SEGMENT *aStart)

bool	AssembleDiffPair (ITEM *aStart, DIFF_PAIR &aPair)

const CLUSTER	AssembleCluster (ITEM *aStart, int aLayer, double aAreaExpansionLimit=0.0, NET_HANDLE aExcludedNet=nullptr, int aOverrideClearance=0)

Private Member Functions
std::vector< LINE >	findLinesFromVia (ROUTER_IFACE aRouterIface, VIA aVia, const std::set< ITEM * > &aVisited)

WALK_RESULT	walkTuningPath (ROUTER_IFACE aRouterIface, LINE &aStartLine, bool aStartFromBack, const std::set< ITEM > &aVisited)

PATH_RESULT	followBranch (const JOINT aStartJoint, LINKED_ITEM aPrev, std::set< ITEM * > &aVisited, bool aFollowLockedSegments)

ITEM_SET	followTrivialPath (LINE aLine, const JOINT aTerminalJointA, const JOINT *aTerminalJointB, bool aFollowLockedSegments=false)

Private Attributes
NODE *	m_world

ROUTER_IFACE *	m_iface

Detailed Description

Definition at line 42 of file pns_topology.h.

Member Typedef Documentation

◆ JOINT_SET

typedef std::set<const JOINT*> PNS::TOPOLOGY::JOINT_SET

Definition at line 52 of file pns_topology.h.

Constructor & Destructor Documentation

◆ TOPOLOGY()

PNS::TOPOLOGY::TOPOLOGY	(	NODE *	aNode,
		ROUTER_IFACE *	aIface = nullptr )

inline

Parameters

aNode
aIface	if given, lets board connections the router does not model, such as zones, count when searching for unconnected items.

Definition at line 59 of file pns_topology.h.

References m_iface, and m_world.

Referenced by NearestUnconnectedAnchorPoint().

◆ ~TOPOLOGY()

PNS::TOPOLOGY::~TOPOLOGY ( )

inline

Definition at line 64 of file pns_topology.h.

Member Function Documentation

◆ AssembleCluster()

const TOPOLOGY::CLUSTER PNS::TOPOLOGY::AssembleCluster	(	ITEM *	aStart,
		int	aLayer,
		double	aAreaExpansionLimit = 0.0,
		NET_HANDLE	aExcludedNet = nullptr,
		int	aOverrideClearance = 0 )

Definition at line 1192 of file pns_topology.cpp.

References PNS::ITEM::ARC_T, SHAPE::BBox(), BOX2< Vec >::GetArea(), PNS::COLLISION_SEARCH_OPTIONS::m_differentNetsOnly, PNS::TOPOLOGY::CLUSTER::m_items, PNS::COLLISION_SEARCH_OPTIONS::m_overrideClearance, m_world, BOX2< Vec >::Merge(), PNS::MK_HEAD, PNS::ITEM::SEGMENT_T, PNS::ITEM::Shape(), and top().

Referenced by PNS::SHOVE::onCollidingSolid(), and PNS::WALKAROUND::singleStep().

◆ AssembleDiffPair() [1/2]

bool PNS::TOPOLOGY::AssembleDiffPair	(	ITEM *	aStart,
		DIFF_PAIR &	aPair )

◆ AssembleDiffPair() [2/2]

const DIFF_PAIR PNS::TOPOLOGY::AssembleDiffPair ( SEGMENT * aStart )

Referenced by BOOST_FIXTURE_TEST_CASE(), PNS::DIFF_PAIR_PLACER::findDpMidtraceIntersection(), DIFF_PHASE_SKEW_TOOL::getNetPaths(), PNS_KICAD_IFACE_BASE::inheritTrackWidthAndDpGap(), PNS::DP_MEANDER_PLACER::Start(), PNS::MEANDER_SKEW_PLACER::Start(), and PNS::MULTI_DRAGGER::tryAssembleDiffPair().

◆ AssembleTrivialPath()

const ITEM_SET PNS::TOPOLOGY::AssembleTrivialPath	(	ITEM *	aStart,
		std::pair< const JOINT , const JOINT > *	aTerminalJoints = nullptr,
		bool	aFollowLockedSegments = false )

Assemble a trivial path between two joints given a starting item.

Parameters

aStart	is the item to assemble from.
aTerminalJoints	will be filled with the start and end points of the assembled path.
aFollowLockedSegments	if true will assemble a path including locked segments

Returns: a set of items in the path.

Definition at line 468 of file pns_topology.cpp.

References PNS::ITEM::ARC_T, PNS::LINE::CLine(), PNS::JOINT::CLinks(), followTrivialPath(), PNS::JOINT::IsNonFanoutVia(), PNS::ITEM::Kind(), PNS::ITEM::KindStr(), SHAPE_LINE_CHAIN::Length(), m_world, PNS::ITEM::OfKind(), path, PNS::JOINT::Pos(), PNS::ITEM::SEGMENT_T, PNS::LINE::SegmentCount(), via, PNS::ITEM::VIA_T, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by PNS::MEANDER_SKEW_PLACER::Start().

◆ AssembleTuningPath()

const ITEM_SET PNS::TOPOLOGY::AssembleTuningPath	(	ROUTER_IFACE *	aRouterIface,
		ITEM *	aStart,
		SOLID **	aStartPad = nullptr,
		SOLID **	aEndPad = nullptr )

Like AssembleTrivialPath, but follows the track length algorithm, which discards segments that are fully inside pads, and truncates segments that cross into a pad (adding a straight- line segment from the intersection to the pad anchor).

Note: When changing this, sync with BOARD::GetTrackLength()

Parameters

aRouterIface	is the router interface.
aStart	is the item to assemble a path from.
aStartPad	will be filled with the starting pad of the path, if found.
aEndPad	will be filled with the ending pad of the path, if found.

Returns: an item set containing all the items in the path.

Definition at line 794 of file pns_topology.cpp.

References PNS::ITEM::ARC_T, PNS::LINE::CLastPoint(), PNS::LINE::CLine(), PNS::JOINT::CLinks(), PNS::LINE::CPoint(), delta, findLinesFromVia(), PNS::ROUTER_IFACE::GetBoardLayerFromPNSLayer(), PNS::JOINT::IsNonFanoutVia(), PNS::ITEM::Kind(), PNS::ITEM::KindStr(), PNS::ITEM::Layer(), left, SHAPE_LINE_CHAIN::Length(), PNS::LINE::Line(), PNS::ITEM::LINE_T, PNS::LINK_HOLDER::Links(), m_world, PNS::ITEM::Net(), PNS::ITEM::OfKind(), LENGTH_DELAY_CALCULATION::OptimiseTraceInPad(), LENGTH_DELAY_CALCULATION::OptimiseTraceInVia(), PNS::ITEM::Parent(), path, PCB_PAD_T, PCB_VIA_T, right, PNS::ITEM::SEGMENT_T, PNS::LINE::SegmentCount(), PNS::ITEM::SOLID_T, EDA_ITEM::Type(), via, PNS::ITEM::VIA_T, walkTuningPath(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by BOOST_FIXTURE_TEST_CASE(), DIFF_PHASE_SKEW_TOOL::getNetPaths(), PNS::DP_MEANDER_PLACER::Start(), PNS::MEANDER_PLACER::Start(), and PNS::MEANDER_SKEW_PLACER::Start().

◆ ConnectedItems() [1/2]

const ITEM_SET PNS::TOPOLOGY::ConnectedItems	(	const JOINT *	aStart,
		int	aKindMask = ITEM::ANY_T )

Definition at line 1028 of file pns_topology.cpp.

◆ ConnectedItems() [2/2]

const ITEM_SET PNS::TOPOLOGY::ConnectedItems	(	ITEM *	aStart,
		int	aKindMask = ITEM::ANY_T )

Definition at line 1034 of file pns_topology.cpp.

◆ ConnectedJoints()

const TOPOLOGY::JOINT_SET PNS::TOPOLOGY::ConnectedJoints ( const JOINT * aStart )

Definition at line 73 of file pns_topology.cpp.

References PNS::ITEM::ARC_T, PNS::JOINT::LinkList(), m_world, next(), and PNS::ITEM::SEGMENT_T.

Referenced by NearestUnconnectedItem().

◆ findLinesFromVia()

std::vector< LINE > PNS::TOPOLOGY::findLinesFromVia	(	ROUTER_IFACE *	aRouterIface,
		VIA *	aVia,
		const std::set< ITEM * > &	aVisited )

private

◆ followBranch()

TOPOLOGY::PATH_RESULT PNS::TOPOLOGY::followBranch	(	const JOINT *	aStartJoint,
		LINKED_ITEM *	aPrev,
		std::set< ITEM * > &	aVisited,
		bool	aFollowLockedSegments )

private

◆ followTrivialPath()

ITEM_SET PNS::TOPOLOGY::followTrivialPath	(	LINE *	aLine,
		const JOINT **	aTerminalJointA,
		const JOINT **	aTerminalJointB,
		bool	aFollowLockedSegments = false )

private

Definition at line 370 of file pns_topology.cpp.

References PNS::ITEM::ARC_T, PNS::LINE::CLastPoint(), PNS::LINE::CLine(), PNS::LINE::CPoint(), followBranch(), PNS::LINK_HOLDER::IsLinked(), left, SHAPE_LINE_CHAIN::Length(), PNS::LINK_HOLDER::Links(), m_world, PNS::ITEM::OfKind(), path, PNS::JOINT::Pos(), right, PNS::ITEM::SEGMENT_T, PNS::LINE::SegmentCount(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by AssembleTrivialPath().

◆ LeadingRatLine()

bool PNS::TOPOLOGY::LeadingRatLine	(	const LINE *	aTrack,
		SHAPE_LINE_CHAIN &	aRatLine )

Definition at line 168 of file pns_topology.cpp.

References SHAPE_LINE_CHAIN::Append(), PNS::LINE::CLastPoint(), SHAPE_LINE_CHAIN::Clear(), end, and NearestUnconnectedAnchorPoint().

Referenced by PNS::DIFF_PAIR_PLACER::updateLeadingRatLine(), and PNS::LINE_PLACER::updateLeadingRatLine().

◆ NearestUnconnectedAnchorPoint()

bool PNS::TOPOLOGY::NearestUnconnectedAnchorPoint	(	const LINE *	aTrack,
		VECTOR2I &	aPoint,
		PNS_LAYER_RANGE &	aLayers,
		ITEM *&	aItem )

Definition at line 107 of file pns_topology.cpp.

References PNS::ITEM::Anchor(), anchor, PNS::LINE::CLastPoint(), PNS::LINK_HOLDER::ClearLinks(), end, PNS::LINE::EndsWithVia(), PNS::ITEM::Layers(), PNS::JOINT::LinkCount(), PNS::JOINT::LinkList(), m_iface, m_world, NearestUnconnectedItem(), PNS::JOINT::Net(), PNS::LINE::PointCount(), PNS::JOINT::Pos(), and TOPOLOGY().

Referenced by PNS::ROUTER::GetNearestRatnestAnchor(), and LeadingRatLine().

◆ NearestUnconnectedItem()

ITEM * PNS::TOPOLOGY::NearestUnconnectedItem	(	const JOINT *	aStart,
		int *	aAnchor = nullptr,
		int	aKindMask = ITEM::ANY_T )

Definition at line 185 of file pns_topology.cpp.

References ConnectedJoints(), m_iface, m_world, PNS::JOINT::Net(), and PNS::JOINT::Pos().

Referenced by PNS::ROUTER::GetNearestRatnestAnchor(), and NearestUnconnectedAnchorPoint().

◆ ShortestConnectionLength()

int64_t PNS::TOPOLOGY::ShortestConnectionLength	(	ITEM *	aFrom,
		ITEM *	aTo )

◆ SimplifyLine()

bool PNS::TOPOLOGY::SimplifyLine ( LINE * aLine )

Definition at line 49 of file pns_topology.cpp.

References PNS::LINE::CLine(), PNS::LINK_HOLDER::GetLink(), PNS::LINK_HOLDER::IsLinked(), m_world, PNS::LINE::PointCount(), SHAPE_LINE_CHAIN::PointCount(), PNS::LINE::SegmentCount(), PNS::LINE::SetShape(), and SHAPE_LINE_CHAIN::Simplify().

◆ walkTuningPath()

TOPOLOGY::WALK_RESULT PNS::TOPOLOGY::walkTuningPath	(	ROUTER_IFACE *	aRouterIface,
		LINE &	aStartLine,
		bool	aStartFromBack,
		const std::set< ITEM * > &	aVisited )

private

Member Data Documentation

◆ m_iface

ROUTER_IFACE* PNS::TOPOLOGY::m_iface

private

Definition at line 151 of file pns_topology.h.

Referenced by NearestUnconnectedAnchorPoint(), NearestUnconnectedItem(), and TOPOLOGY().

◆ m_world

NODE* PNS::TOPOLOGY::m_world

private

Definition at line 150 of file pns_topology.h.

Referenced by AssembleCluster(), AssembleDiffPair(), AssembleTrivialPath(), AssembleTuningPath(), ConnectedJoints(), findLinesFromVia(), followBranch(), followTrivialPath(), NearestUnconnectedAnchorPoint(), NearestUnconnectedItem(), SimplifyLine(), TOPOLOGY(), and walkTuningPath().

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

Classes

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ JOINT_SET

Constructor & Destructor Documentation

◆ TOPOLOGY()

◆ ~TOPOLOGY()

Member Function Documentation

◆ AssembleCluster()

◆ AssembleDiffPair() [1/2]

◆ AssembleDiffPair() [2/2]

◆ AssembleTrivialPath()

◆ AssembleTuningPath()

◆ ConnectedItems() [1/2]

◆ ConnectedItems() [2/2]

◆ ConnectedJoints()

◆ findLinesFromVia()

◆ followBranch()

◆ followTrivialPath()

◆ LeadingRatLine()

◆ NearestUnconnectedAnchorPoint()

◆ NearestUnconnectedItem()

◆ ShortestConnectionLength()

◆ SimplifyLine()

◆ walkTuningPath()

Member Data Documentation

◆ m_iface

◆ m_world