PNS::ROUTER_IFACE Class Reference

ROUTER. More...

#include <pns_router.h>

Inheritance diagram for PNS::ROUTER_IFACE:

Public Member Functions
	ROUTER_IFACE ()
virtual	~ROUTER_IFACE ()
virtual void	SyncWorld (NODE *aNode)=0
virtual void	AddItem (ITEM *aItem)=0
virtual void	UpdateItem (ITEM *aItem)=0
virtual void	RemoveItem (ITEM *aItem)=0
virtual bool	IsAnyLayerVisible (const PNS_LAYER_RANGE &aLayer) const =0
virtual bool	IsItemVisible (const PNS::ITEM *aItem) const =0
virtual bool	IsFlashedOnLayer (const PNS::ITEM *aItem, int aLayer) const =0
virtual bool	IsFlashedOnLayer (const PNS::ITEM *aItem, const PNS_LAYER_RANGE &aLayer) const =0
virtual bool	IsPNSCopperLayer (int aPNSLayer) const =0
virtual void	DisplayItem (const ITEM *aItem, int aClearance, bool aEdit=false, int aFlags=0)=0
virtual void	DisplayPathLine (const SHAPE_LINE_CHAIN &aLine, int aImportance)=0
virtual void	DisplayRatline (const SHAPE_LINE_CHAIN &aRatline, NET_HANDLE aNetCode)=0
virtual void	HideItem (ITEM *aItem)=0
virtual void	Commit ()=0
virtual bool	ImportSizes (SIZES_SETTINGS &aSizes, ITEM *aStartItem, NET_HANDLE aNet, VECTOR2D aStartPosition)=0
virtual int	StackupHeight (int aFirstLayer, int aSecondLayer) const =0
virtual void	EraseView ()=0
virtual int	GetNetCode (NET_HANDLE aNet) const =0
virtual wxString	GetNetName (PNS::NET_HANDLE aNet) const =0
virtual void	UpdateNet (NET_HANDLE aNet)=0
virtual NET_HANDLE	GetOrphanedNetHandle ()=0
virtual PNS::NODE *	GetWorld () const =0
virtual RULE_RESOLVER *	GetRuleResolver ()=0
virtual DEBUG_DECORATOR *	GetDebugDecorator ()=0
virtual long long int	CalculateRoutedPathLength (const ITEM_SET &aLine, const SOLID *aStartPad, const SOLID *aEndPad, const NETCLASS *aNetClass)=0
virtual int64_t	CalculateRoutedPathDelay (const ITEM_SET &aLine, const SOLID *aStartPad, const SOLID *aEndPad, const NETCLASS *aNetClass)=0
virtual int64_t	CalculateLengthForDelay (int64_t aDesiredDelay, int aWidth, bool aIsDiffPairCoupled, int aDiffPairCouplingGap, int aPNSLayer, const NETCLASS *aNetClass)=0
virtual int64_t	CalculateDelayForShapeLineChain (const SHAPE_LINE_CHAIN &aShape, int aWidth, bool aIsDiffPairCoupled, int aDiffPairCouplingGap, int aPNSLayer, const NETCLASS *aNetClass)=0
virtual PCB_LAYER_ID	GetBoardLayerFromPNSLayer (int aLayer) const =0
virtual int	GetPNSLayerFromBoardLayer (PCB_LAYER_ID aLayer) const =0

Detailed Description

ROUTER.

Main router class.

Definition at line 86 of file pns_router.h.

Constructor & Destructor Documentation

ROUTER_IFACE()

PNS::ROUTER_IFACE::ROUTER_IFACE ( )

inline

Definition at line 89 of file pns_router.h.

~ROUTER_IFACE()

virtual PNS::ROUTER_IFACE::~ROUTER_IFACE ( )

inlinevirtual

Definition at line 90 of file pns_router.h.

Member Function Documentation

AddItem()

virtual void PNS::ROUTER_IFACE::AddItem ( ITEM *  aItem )

pure virtual

Implemented in PNS_KICAD_IFACE_BASE, PNS_KICAD_IFACE, PNS_KICAD_IFACE_GENERATOR, and PNS_VIEWER_IFACE.

Referenced by PNS::ROUTER::CommitRouting(), and PCB_TUNING_PATTERN::removeToBaseline().

CalculateDelayForShapeLineChain()

virtual int64_t PNS::ROUTER_IFACE::CalculateDelayForShapeLineChain ( const SHAPE_LINE_CHAIN &  aShape, int  aWidth, bool  aIsDiffPairCoupled, int  aDiffPairCouplingGap, int  aPNSLayer, const NETCLASS *  aNetClass  )

pure virtual

Implemented in PNS_KICAD_IFACE_BASE, and PNS_VIEWER_IFACE.

Referenced by PNS::MEANDER_PLACER::doMove(), and PNS::DP_MEANDER_PLACER::Move().

CalculateLengthForDelay()

virtual int64_t PNS::ROUTER_IFACE::CalculateLengthForDelay ( int64_t  aDesiredDelay, int  aWidth, bool  aIsDiffPairCoupled, int  aDiffPairCouplingGap, int  aPNSLayer, const NETCLASS *  aNetClass  )

pure virtual

Implemented in PNS_VIEWER_IFACE, and PNS_KICAD_IFACE_BASE.

Referenced by PNS::DP_MEANDER_PLACER::calculateTimeDomainTargets(), PNS::MEANDER_PLACER::calculateTimeDomainTargets(), and PNS::MEANDER_SKEW_PLACER::calculateTimeDomainTargets().

CalculateRoutedPathDelay()

virtual int64_t PNS::ROUTER_IFACE::CalculateRoutedPathDelay ( const ITEM_SET &  aLine, const SOLID *  aStartPad, const SOLID *  aEndPad, const NETCLASS *  aNetClass  )

pure virtual

Implemented in PNS_KICAD_IFACE_BASE, and PNS_VIEWER_IFACE.

Referenced by PNS::MEANDER_PLACER_BASE::lineDelay().

CalculateRoutedPathLength()

virtual long long int PNS::ROUTER_IFACE::CalculateRoutedPathLength ( const ITEM_SET &  aLine, const SOLID *  aStartPad, const SOLID *  aEndPad, const NETCLASS *  aNetClass  )

pure virtual

Implemented in PNS_KICAD_IFACE_BASE, and PNS_VIEWER_IFACE.

Referenced by PNS::MEANDER_PLACER_BASE::lineLength().

Commit()

virtual void PNS::ROUTER_IFACE::Commit ( )

pure virtual

Implemented in PNS_KICAD_IFACE_BASE, PNS_KICAD_IFACE, PNS_KICAD_IFACE_GENERATOR, and PNS_VIEWER_IFACE.

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

DisplayItem()

virtual void PNS::ROUTER_IFACE::DisplayItem ( const ITEM *  aItem, int  aClearance, bool  aEdit = false, int  aFlags = 0  )

pure virtual

Implemented in PNS_KICAD_IFACE_BASE, PNS_KICAD_IFACE, MOCK_PNS_KICAD_IFACE, PNS_LOG_PLAYER_KICAD_IFACE, and PNS_VIEWER_IFACE.

Referenced by PNS::ROUTER::markViolations(), PNS::ROUTER::movePlacing(), and PNS::ROUTER::updateView().

DisplayPathLine()

virtual void PNS::ROUTER_IFACE::DisplayPathLine ( const SHAPE_LINE_CHAIN &  aLine, int  aImportance  )

pure virtual

Implemented in PNS_KICAD_IFACE_BASE, PNS_KICAD_IFACE, and PNS_VIEWER_IFACE.

Referenced by PNS::MEANDER_PLACER::doMove(), PNS::DP_MEANDER_PLACER::Move(), and PNS::MEANDER_SKEW_PLACER::Move().

DisplayRatline()

virtual void PNS::ROUTER_IFACE::DisplayRatline ( const SHAPE_LINE_CHAIN &  aRatline, NET_HANDLE  aNetCode  )

pure virtual

Implemented in PNS_KICAD_IFACE_BASE, PNS_KICAD_IFACE, and PNS_VIEWER_IFACE.

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

EraseView()

virtual void PNS::ROUTER_IFACE::EraseView ( )

pure virtual

Implemented in PNS_KICAD_IFACE_BASE, PNS_KICAD_IFACE, and PNS_VIEWER_IFACE.

Referenced by PNS::ROUTER::ClearViewDecorations(), PNS::ROUTER::moveDragging(), PNS::ROUTER::movePlacing(), and PNS::ROUTER::StopRouting().

GetBoardLayerFromPNSLayer()

virtual PCB_LAYER_ID PNS::ROUTER_IFACE::GetBoardLayerFromPNSLayer ( int  aLayer ) const

pure virtual

Implemented in PNS_KICAD_IFACE_BASE, and PNS_VIEWER_IFACE.

Referenced by PNS::TOPOLOGY::AssembleTuningPath(), PNS_PCBNEW_RULE_RESOLVER::IsKeepout(), PNS_PCBNEW_RULE_RESOLVER::IsNetTieExclusion(), PNS_PCBNEW_RULE_RESOLVER::QueryConstraint(), and ROUTER_PREVIEW_ITEM::Update().

GetDebugDecorator()

virtual DEBUG_DECORATOR * PNS::ROUTER_IFACE::GetDebugDecorator ( )

pure virtual

Implemented in PNS_KICAD_IFACE_BASE, and PNS_VIEWER_IFACE.

Referenced by PNS::MOUSE_TRAIL_TRACER::AddTrailPoint(), PNS::AREA_CONSTRAINT::Check(), PNS::clipToOtherLine(), PNS::MOUSE_TRAIL_TRACER::GetPosture(), PNS::NODE::NearestObstacle(), PNS::OPTIMIZER::Optimize(), PNS::VIA::PushoutForce(), PNS::SHOVE::SHOVE(), PNS::ROUTER::StartDragging(), and PNS::ROUTER::StartRouting().

GetNetCode()

virtual int PNS::ROUTER_IFACE::GetNetCode ( NET_HANDLE  aNet ) const

pure virtual

Implemented in PNS_KICAD_IFACE_BASE, PNS_KICAD_IFACE, PNS_LOG_PLAYER_KICAD_IFACE, and PNS_VIEWER_IFACE.

Referenced by PNS::LINE_PLACER::FixRoute(), PNS::TOOL_BASE::highlightNets(), PNS_PCBNEW_RULE_RESOLVER::NetCode(), and PNS::TOOL_BASE::pickSingleItem().

GetNetName()

virtual wxString PNS::ROUTER_IFACE::GetNetName ( PNS::NET_HANDLE  aNet ) const

pure virtual

Implemented in PNS_KICAD_IFACE_BASE, PNS_KICAD_IFACE, PNS_LOG_PLAYER_KICAD_IFACE, and PNS_VIEWER_IFACE.

Referenced by PNS::ITEM::Format(), PNS_PCBNEW_RULE_RESOLVER::NetName(), and PNS::SHOVE::shoveIteration().

GetOrphanedNetHandle()

virtual NET_HANDLE PNS::ROUTER_IFACE::GetOrphanedNetHandle ( )

pure virtual

Implemented in PNS_KICAD_IFACE_BASE, and PNS_VIEWER_IFACE.

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

GetPNSLayerFromBoardLayer()

virtual int PNS::ROUTER_IFACE::GetPNSLayerFromBoardLayer ( PCB_LAYER_ID  aLayer ) const

pure virtual

Implemented in PNS_KICAD_IFACE_BASE, and PNS_VIEWER_IFACE.

Referenced by PCB_TUNING_PATTERN::EditStart(), PNS::TOOL_BASE::pickSingleItem(), and PNS::TOOL_BASE::updateStartItem().

GetRuleResolver()

virtual RULE_RESOLVER * PNS::ROUTER_IFACE::GetRuleResolver ( )

pure virtual

Implemented in PNS_KICAD_IFACE_BASE, MOCK_PNS_KICAD_IFACE, and PNS_VIEWER_IFACE.

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

GetWorld()

virtual PNS::NODE * PNS::ROUTER_IFACE::GetWorld ( ) const

pure virtual

Implemented in PNS_KICAD_IFACE_BASE, and PNS_VIEWER_IFACE.

HideItem()

virtual void PNS::ROUTER_IFACE::HideItem ( ITEM *  aItem )

pure virtual

Implemented in PNS_KICAD_IFACE_BASE, PNS_KICAD_IFACE, MOCK_PNS_KICAD_IFACE, PNS_LOG_PLAYER_KICAD_IFACE, and PNS_VIEWER_IFACE.

Referenced by PNS::ROUTER::isStartingPointRoutable(), and PNS::ROUTER::updateView().

ImportSizes()

virtual bool PNS::ROUTER_IFACE::ImportSizes ( SIZES_SETTINGS &  aSizes, ITEM *  aStartItem, NET_HANDLE  aNet, VECTOR2D  aStartPosition  )

pure virtual

Implemented in PNS_KICAD_IFACE_BASE, and PNS_VIEWER_IFACE.

IsAnyLayerVisible()

virtual bool PNS::ROUTER_IFACE::IsAnyLayerVisible ( const PNS_LAYER_RANGE &  aLayer ) const

pure virtual

Implemented in PNS_KICAD_IFACE_BASE, PNS_KICAD_IFACE, and PNS_VIEWER_IFACE.

IsFlashedOnLayer() [1/2]

virtual bool PNS::ROUTER_IFACE::IsFlashedOnLayer ( const PNS::ITEM *  aItem, const PNS_LAYER_RANGE &  aLayer  ) const

pure virtual

Implemented in PNS_KICAD_IFACE_BASE, and PNS_VIEWER_IFACE.

IsFlashedOnLayer() [2/2]

virtual bool PNS::ROUTER_IFACE::IsFlashedOnLayer ( const PNS::ITEM *  aItem, int  aLayer  ) const

pure virtual

Implemented in PNS_KICAD_IFACE_BASE, and PNS_VIEWER_IFACE.

Referenced by PNS::ITEM::collideSimple().

IsItemVisible()

virtual bool PNS::ROUTER_IFACE::IsItemVisible ( const PNS::ITEM *  aItem ) const

pure virtual

Implemented in PNS_KICAD_IFACE_BASE, PNS_KICAD_IFACE, and PNS_VIEWER_IFACE.

IsPNSCopperLayer()

virtual bool PNS::ROUTER_IFACE::IsPNSCopperLayer ( int  aPNSLayer ) const

pure virtual

Implemented in PNS_VIEWER_IFACE, and PNS_KICAD_IFACE_BASE.

RemoveItem()

virtual void PNS::ROUTER_IFACE::RemoveItem ( ITEM *  aItem )

pure virtual

Implemented in PNS_KICAD_IFACE_BASE, PNS_KICAD_IFACE, PNS_KICAD_IFACE_GENERATOR, and PNS_VIEWER_IFACE.

Referenced by PNS::ROUTER::CommitRouting(), and PCB_TUNING_PATTERN::removeToBaseline().

StackupHeight()

virtual int PNS::ROUTER_IFACE::StackupHeight ( int  aFirstLayer, int  aSecondLayer  ) const

pure virtual

Implemented in PNS_KICAD_IFACE_BASE, and PNS_VIEWER_IFACE.

SyncWorld()

virtual void PNS::ROUTER_IFACE::SyncWorld ( NODE *  aNode )

pure virtual

Implemented in PNS_KICAD_IFACE_BASE, and PNS_VIEWER_IFACE.

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

UpdateItem()

virtual void PNS::ROUTER_IFACE::UpdateItem ( ITEM *  aItem )

pure virtual

Implemented in PNS_KICAD_IFACE_BASE, PNS_KICAD_IFACE, PNS_KICAD_IFACE_GENERATOR, and PNS_VIEWER_IFACE.

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

UpdateNet()

virtual void PNS::ROUTER_IFACE::UpdateNet ( NET_HANDLE  aNet )

pure virtual

Implemented in PNS_KICAD_IFACE_BASE, PNS_KICAD_IFACE, and PNS_VIEWER_IFACE.

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

---

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

• pns_router.h