Class NODE. More...

#include <pns_node.h>

Classes
struct	DEFAULT_OBSTACLE_VISITOR

Public Types
typedef OPT< OBSTACLE >	OPT_OBSTACLE

typedef std::vector< ITEM * >	ITEM_VECTOR

typedef std::vector< OBSTACLE >	OBSTACLES

Public Member Functions
int	GetClearance (const ITEM aA, const ITEM aB) const
	Returns the expected clearance between items a and b.

int	GetMaxClearance () const
	Returns the pre-set worst case clearance between any pair of items

void	SetMaxClearance (int aClearance)
	Sets the worst-case clerance between any pair of items

void	SetRuleResolver (RULE_RESOLVER *aFunc)
	Assigns a clerance resolution function object

RULE_RESOLVER *	GetRuleResolver ()

int	JointCount () const
	Returns the number of joints

int	Depth () const
	Returns the number of nodes in the inheritance chain (wrs to the root node)

int	QueryColliding (const ITEM *aItem, OBSTACLES &aObstacles, int aKindMask=ITEM::ANY_T, int aLimitCount=-1, bool aDifferentNetsOnly=true, int aForceClearance=-1)
	Function QueryColliding() More...

int	QueryColliding (const ITEM *aItem, OBSTACLE_VISITOR &aVisitor)

OPT_OBSTACLE	NearestObstacle (const LINE aItem, int aKindMask=ITEM::ANY_T, const std::set< ITEM > *aRestrictedSet=NULL)
	Function NearestObstacle() More...

OPT_OBSTACLE	CheckColliding (const ITEM *aItem, int aKindMask=ITEM::ANY_T)
	Function CheckColliding() More...

OPT_OBSTACLE	CheckColliding (const ITEM_SET &aSet, int aKindMask=ITEM::ANY_T)
	Function CheckColliding() More...

bool	CheckColliding (const ITEM aItemA, const ITEM aItemB, int aKindMask=ITEM::ANY_T, int aForceClearance=-1)
	Function CheckColliding() More...

const ITEM_SET	HitTest (const VECTOR2I &aPoint) const
	Function HitTest() More...

bool	Add (std::unique_ptr< SEGMENT > aSegment, bool aAllowRedundant=false)
	Function Add() More...

void	Add (std::unique_ptr< SOLID > aSolid)

void	Add (std::unique_ptr< VIA > aVia)

void	Add (LINE &aLine, bool aAllowRedundant=false)

void	Remove (SOLID *aSolid)
	Function Remove() More...

void	Remove (VIA *aVia)

void	Remove (SEGMENT *aSegment)

void	Remove (ITEM *aItem)

void	Remove (LINE &aLine)
	Function Remove() More...

void	Replace (ITEM *aOldItem, std::unique_ptr< ITEM > aNewItem)
	Function Replace() More...

void	Replace (LINE &aOldLine, LINE &aNewLine)

NODE *	Branch ()
	Function Branch() More...

const LINE	AssembleLine (SEGMENT aSeg, int aOriginSegmentIndex=NULL, bool aStopAtLockedJoints=false)
	Function AssembleLine() More...

void	Dump (bool aLong=false)
	Prints the contents and joints structure

void	GetUpdatedItems (ITEM_VECTOR &aRemoved, ITEM_VECTOR &aAdded)
	Function GetUpdatedItems() More...

void	Commit (NODE *aNode)
	Function Commit() More...

JOINT *	FindJoint (const VECTOR2I &aPos, int aLayer, int aNet)
	Function FindJoint() More...

void	LockJoint (const VECTOR2I &aPos, const ITEM *aItem, bool aLock)

JOINT *	FindJoint (const VECTOR2I &aPos, const ITEM *aItem)
	Function FindJoint() More...

int	FindLinesBetweenJoints (JOINT &aA, JOINT &aB, std::vector< LINE > &aLines)
	finds all lines between a pair of joints. Used by the loop removal procedure.

void	FindLineEnds (const LINE &aLine, JOINT &aA, JOINT &aB)
	finds the joints corresponding to the ends of line aLine

void	KillChildren ()
	Destroys all child nodes. Applicable only to the root node.

void	AllItemsInNet (int aNet, std::set< ITEM * > &aItems)

void	ClearRanks (int aMarkerMask=MK_HEAD\|MK_VIOLATION)

int	FindByMarker (int aMarker, ITEM_SET &aItems)

int	RemoveByMarker (int aMarker)

ITEM *	FindItemByParent (const class PNS_HORIZON_PARENT_ITEM *aParent, int net)

bool	HasChildren () const

bool	Overrides (ITEM *aItem) const
	checks if this branch contains an updated version of the m_item from the root branch. More...

Detailed Description

Class NODE.

Keeps the router "world" - i.e. all the tracks, vias, solids in a hierarchical and indexed way. Features:

spatial-indexed container for PCB item shapes
collision search & clearance checking
assembly of lines connecting joints, finding loops and unique paths
lightweight cloning/branching (for recursive optimization and shove springback)

Member Function Documentation

◆ Add()

bool PNS::NODE::Add	(	std::unique_ptr< SEGMENT >	aSegment,
		bool	aAllowRedundant = `false`
	)

Function Add()

Adds an item to the current node.

Parameters

aSegment	item to add
aAllowRedundant	if true, duplicate items are allowed (e.g. a segment or via

Returns: true if added at the same coordinates as an existing one)

◆ AssembleLine()

const LINE PNS::NODE::AssembleLine	(	SEGMENT *	aSeg,
		int *	aOriginSegmentIndex = `NULL`,
		bool	aStopAtLockedJoints = `false`
	)

Function AssembleLine()

Follows the joint map to assemble a line connecting two non-trivial joints starting from segment aSeg.

Parameters

aSeg	the initial segment
aOriginSegmentIndex	index of aSeg in the resulting line

Returns: the line

◆ Branch()

NODE * PNS::NODE::Branch ( )

Function Branch()

Creates a lightweight copy (called branch) of self that tracks the changes (added/removed items) wrs to the root. Note that if there are any branches in use, their parents must NOT be deleted.

Returns: the new branch

◆ CheckColliding() [1/3]

NODE::OPT_OBSTACLE PNS::NODE::CheckColliding	(	const ITEM *	aItem,
		int	aKindMask = `ITEM::ANY_T`
	)

Function CheckColliding()

Checks if the item collides with anything else in the world, and if found, returns the obstacle.

Parameters

aItem	the item to find collisions with
aKindMask	mask of obstacle types to take into account

Returns: the obstacle, if found, otherwise empty.

◆ CheckColliding() [2/3]

bool PNS::NODE::CheckColliding	(	const ITEM *	aItemA,
		const ITEM *	aItemB,
		int	aKindMask = `ITEM::ANY_T`,
		int	aForceClearance = `-1`
	)

Function CheckColliding()

Checks if 2 items collide. and if found, returns the obstacle.

Parameters

aItemA	first item to find collisions with
aItemB	second item to find collisions with
aKindMask	mask of obstacle types to take into account

Returns: the obstacle, if found, otherwise empty.

◆ CheckColliding() [3/3]

NODE::OPT_OBSTACLE PNS::NODE::CheckColliding	(	const ITEM_SET &	aSet,
		int	aKindMask = `ITEM::ANY_T`
	)

Function CheckColliding()

Checks if any item in the set collides with anything else in the world, and if found, returns the obstacle.

Parameters

aSet	set of items to find collisions with
aKindMask	mask of obstacle types to take into account

Returns: the obstacle, if found, otherwise empty.

◆ Commit()

void PNS::NODE::Commit ( NODE * aNode )

Function Commit()

Applies the changes from a given branch (aNode) to the root branch. Called on a non-root branch will fail. Calling commit also kills all children nodes of the root branch.

Parameters

aNode node to commit changes from

◆ FindJoint() [1/2]

JOINT* PNS::NODE::FindJoint	(	const VECTOR2I &	aPos,
		const ITEM *	aItem
	)

inline

Function FindJoint()

Searches for a joint at a given position, linked to given item.

Returns: the joint, if found, otherwise empty

◆ FindJoint() [2/2]

JOINT * PNS::NODE::FindJoint	(	const VECTOR2I &	aPos,
		int	aLayer,
		int	aNet
	)

Function FindJoint()

Searches for a joint at a given position, layer and belonging to given net.

Returns: the joint, if found, otherwise empty

◆ GetUpdatedItems()

void PNS::NODE::GetUpdatedItems	(	ITEM_VECTOR &	aRemoved,
		ITEM_VECTOR &	aAdded
	)

Function GetUpdatedItems()

Returns the lists of items removed and added in this branch, with respect to the root branch.

Parameters

aRemoved	removed items
aAdded	added items

◆ HitTest()

const ITEM_SET PNS::NODE::HitTest ( const VECTOR2I & aPoint ) const

Function HitTest()

Finds all items that contain the point aPoint.

Parameters

aPoint the point

Returns: the items

◆ NearestObstacle()

NODE::OPT_OBSTACLE PNS::NODE::NearestObstacle	(	const LINE *	aItem,
		int	aKindMask = `ITEM::ANY_T`,
		const std::set< ITEM * > *	aRestrictedSet = `NULL`
	)

Function NearestObstacle()

Follows the line in search of an obstacle that is nearest to the starting to the line's starting point.

Parameters

aItem	the item to find collisions with
aKindMask	mask of obstacle types to take into account

Returns: the obstacle, if found, otherwise empty.

◆ Overrides()

bool PNS::NODE::Overrides ( ITEM * aItem ) const

inline

checks if this branch contains an updated version of the m_item from the root branch.

◆ QueryColliding()

int PNS::NODE::QueryColliding	(	const ITEM *	aItem,
		NODE::OBSTACLES &	aObstacles,
		int	aKindMask = `ITEM::ANY_T`,
		int	aLimitCount = `-1`,
		bool	aDifferentNetsOnly = `true`,
		int	aForceClearance = `-1`
	)

Function QueryColliding()

Finds items collliding (closer than clearance) with the item aItem.

Parameters

aItem	item to check collisions against
aObstacles	set of colliding objects found
aKindMask	mask of obstacle types to take into account
aLimitCount	stop looking for collisions after finding this number of colliding items

Returns: number of obstacles found

◆ Remove() [1/2]

void PNS::NODE::Remove ( LINE & aLine )

Function Remove()

Just as the name says, removes a line from this branch.

Parameters

aLine item to remove

◆ Remove() [2/2]

void PNS::NODE::Remove ( SOLID * aSolid )

Function Remove()

Just as the name says, removes an item from this branch.

◆ Replace()

void PNS::NODE::Replace	(	ITEM *	aOldItem,
		std::unique_ptr< ITEM >	aNewItem
	)

Function Replace()

Just as the name says, replaces an item with another one.

Parameters

aOldItem	item to be removed
aNewItem	item add instead

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

3rd_party/router/router/pns_node.h
3rd_party/router/router/pns_node.cpp

Classes

Public Types

Public Member Functions

Detailed Description

Member Function Documentation

◆ Add()

◆ AssembleLine()

◆ Branch()

◆ CheckColliding() [1/3]

◆ CheckColliding() [2/3]

◆ CheckColliding() [3/3]

◆ Commit()

◆ FindJoint() [1/2]

◆ FindJoint() [2/2]

◆ GetUpdatedItems()

◆ HitTest()

◆ NearestObstacle()

◆ Overrides()

◆ QueryColliding()

◆ Remove() [1/2]

◆ Remove() [2/2]

◆ Replace()