KiCad Pcbnew Python Scripting
Loading...
Searching...
No Matches
Public Member Functions | Properties | List of all members
pcbnew.CONNECTIVITY_DATA Class Reference
Inheritance diagram for pcbnew.CONNECTIVITY_DATA:
Inheritance graph
[legend]

Public Member Functions

 __init__ (self, *args)
 
 Build (self, *args)
 
 Add (self, aItem)
 
 Remove (self, aItem)
 
 Update (self, aItem)
 
 Move (self, aDelta)
 
 ClearRatsnest (self)
 
 GetNetCount (self)
 
 GetRatsnestForNet (self, aNet)
 
 PropagateNets (self, aCommit=None)
 
 FillIsolatedIslandsMap (self, aMap, aConnectivityAlreadyRebuilt=False)
 
 RecalculateRatsnest (self, aCommit=None)
 
 GetUnconnectedCount (self, aVisibileOnly)
 
 IsConnectedOnLayer (self, *args)
 
 GetNodeCount (self, aNet=-1)
 
 GetPadCount (self, aNet=-1)
 
 GetConnectedTracks (self, aItem)
 
 GetConnectedPads (self, *args)
 
 GetConnectedPadsAndVias (self, aItem, pads, vias)
 
 GetConnectedItemsAtAnchor (self, aItem, aAnchor, aTypes, aMaxError=0)
 
 RunOnUnconnectedEdges (self, aFunc)
 
 TestTrackEndpointDangling (self, aTrack, aIgnoreTracksInPads, aPos=None)
 
 ClearLocalRatsnest (self)
 
 HideLocalRatsnest (self)
 
 ComputeLocalRatsnest (self, *args)
 
 GetLocalRatsnest (self)
 
 GetConnectedItems (self, aItem, aFlags=0)
 
 GetNetItems (self, aNetCode, aTypes)
 
 BlockRatsnestItems (self, aItems)
 
 GetConnectivityAlgo (self)
 
 GetLock (self)
 
 MarkItemNetAsDirty (self, aItem)
 
 RemoveInvalidRefs (self)
 
 SetProgressReporter (self, aReporter)
 
 GetNetSettings (self)
 
 HasNetNameForNetCode (self, nc)
 
 GetNetNameForNetCode (self, nc)
 
 RefreshNetcodeMap (self, aBoard)
 
 GetFromToCache (self)
 

Properties

 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 

Detailed Description

Proxy of C++ CONNECTIVITY_DATA class.

Definition at line 11961 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

pcbnew.CONNECTIVITY_DATA.__init__ ( self,
* args ) 
    __init__(CONNECTIVITY_DATA self) -> CONNECTIVITY_DATA
    __init__(CONNECTIVITY_DATA self, std::shared_ptr< CONNECTIVITY_DATA > aGlobalConnectivity, std::vector< BOARD_ITEM *,std::allocator< BOARD_ITEM * > > const & aLocalItems, bool aSkipRatsnestUpdate=False) -> CONNECTIVITY_DATA

Definition at line 11968 of file pcbnew.py.

Member Function Documentation

◆ Add()

pcbnew.CONNECTIVITY_DATA.Add ( self,
aItem ) 
Add(CONNECTIVITY_DATA self, BOARD_ITEM aItem) -> bool

Definition at line 11982 of file pcbnew.py.

◆ BlockRatsnestItems()

pcbnew.CONNECTIVITY_DATA.BlockRatsnestItems ( self,
aItems ) 
BlockRatsnestItems(CONNECTIVITY_DATA self, std::vector< BOARD_ITEM *,std::allocator< BOARD_ITEM * > > const & aItems)

Definition at line 12089 of file pcbnew.py.

◆ Build()

pcbnew.CONNECTIVITY_DATA.Build ( self,
* args ) 
    Build(CONNECTIVITY_DATA self, BOARD aBoard, PROGRESS_REPORTER * aReporter=None) -> bool
    Build(CONNECTIVITY_DATA self, std::shared_ptr< CONNECTIVITY_DATA > & aGlobalConnectivity, std::vector< BOARD_ITEM *,std::allocator< BOARD_ITEM * > > const & aLocalItems)

Definition at line 11975 of file pcbnew.py.

◆ ClearLocalRatsnest()

pcbnew.CONNECTIVITY_DATA.ClearLocalRatsnest ( self) 
ClearLocalRatsnest(CONNECTIVITY_DATA self)

Definition at line 12065 of file pcbnew.py.

◆ ClearRatsnest()

pcbnew.CONNECTIVITY_DATA.ClearRatsnest ( self) 
ClearRatsnest(CONNECTIVITY_DATA self)

Definition at line 11998 of file pcbnew.py.

◆ ComputeLocalRatsnest()

pcbnew.CONNECTIVITY_DATA.ComputeLocalRatsnest ( self,
* args ) 
ComputeLocalRatsnest(CONNECTIVITY_DATA self, std::vector< BOARD_ITEM *,std::allocator< BOARD_ITEM * > > const & aItems, CONNECTIVITY_DATA aDynamicData, VECTOR2I aInternalOffset={ 0, 0 })

Definition at line 12073 of file pcbnew.py.

◆ FillIsolatedIslandsMap()

pcbnew.CONNECTIVITY_DATA.FillIsolatedIslandsMap ( self,
aMap,
aConnectivityAlreadyRebuilt = False ) 
FillIsolatedIslandsMap(CONNECTIVITY_DATA self, std::map< ZONE *,std::map< PCB_LAYER_ID,ISOLATED_ISLANDS,std::less< PCB_LAYER_ID >,std::allocator< std::pair< PCB_LAYER_ID const,ISOLATED_ISLANDS > > >,std::less< ZONE * >,std::allocator< std::pair< ZONE *const,std::map< PCB_LAYER_ID,ISOLATED_ISLANDS,std::less< PCB_LAYER_ID >,std::allocator< std::pair< PCB_LAYER_ID const,ISOLATED_ISLANDS > > > > > > & aMap, bool aConnectivityAlreadyRebuilt=False)

Definition at line 12014 of file pcbnew.py.

◆ GetConnectedItems()

pcbnew.CONNECTIVITY_DATA.GetConnectedItems ( self,
aItem,
aFlags = 0 ) 
GetConnectedItems(CONNECTIVITY_DATA self, BOARD_CONNECTED_ITEM aItem, int aFlags=0) -> std::vector< BOARD_CONNECTED_ITEM *,std::allocator< BOARD_CONNECTED_ITEM * > > const

Definition at line 12081 of file pcbnew.py.

◆ GetConnectedItemsAtAnchor()

pcbnew.CONNECTIVITY_DATA.GetConnectedItemsAtAnchor ( self,
aItem,
aAnchor,
aTypes,
aMaxError = 0 ) 
GetConnectedItemsAtAnchor(CONNECTIVITY_DATA self, BOARD_CONNECTED_ITEM aItem, VECTOR2I aAnchor, std::vector< KICAD_T,std::allocator< KICAD_T > > const & aTypes, int const & aMaxError=0) -> std::vector< BOARD_CONNECTED_ITEM *,std::allocator< BOARD_CONNECTED_ITEM * > > const

Definition at line 12053 of file pcbnew.py.

◆ GetConnectedPads()

pcbnew.CONNECTIVITY_DATA.GetConnectedPads ( self,
* args ) 
    GetConnectedPads(CONNECTIVITY_DATA self, BOARD_CONNECTED_ITEM aItem) -> PADS_VEC
    GetConnectedPads(CONNECTIVITY_DATA self, BOARD_CONNECTED_ITEM aItem, std::set< PAD *,std::less< PAD * >,std::allocator< PAD * > > * pads)

Definition at line 12042 of file pcbnew.py.

◆ GetConnectedPadsAndVias()

pcbnew.CONNECTIVITY_DATA.GetConnectedPadsAndVias ( self,
aItem,
pads,
vias ) 
GetConnectedPadsAndVias(CONNECTIVITY_DATA self, BOARD_CONNECTED_ITEM aItem, PADS_VEC pads, std::vector< PCB_VIA *,std::allocator< PCB_VIA * > > * vias)

Definition at line 12049 of file pcbnew.py.

◆ GetConnectedTracks()

pcbnew.CONNECTIVITY_DATA.GetConnectedTracks ( self,
aItem ) 
GetConnectedTracks(CONNECTIVITY_DATA self, BOARD_CONNECTED_ITEM aItem) -> TRACKS_VEC

Definition at line 12038 of file pcbnew.py.

◆ GetConnectivityAlgo()

pcbnew.CONNECTIVITY_DATA.GetConnectivityAlgo ( self) 
GetConnectivityAlgo(CONNECTIVITY_DATA self) -> std::shared_ptr< CN_CONNECTIVITY_ALGO >

Definition at line 12093 of file pcbnew.py.

◆ GetFromToCache()

pcbnew.CONNECTIVITY_DATA.GetFromToCache ( self) 
GetFromToCache(CONNECTIVITY_DATA self) -> std::shared_ptr< FROM_TO_CACHE >

Definition at line 12129 of file pcbnew.py.

◆ GetLocalRatsnest()

pcbnew.CONNECTIVITY_DATA.GetLocalRatsnest ( self) 
GetLocalRatsnest(CONNECTIVITY_DATA self) -> std::vector< RN_DYNAMIC_LINE,std::allocator< RN_DYNAMIC_LINE > > const &

Definition at line 12077 of file pcbnew.py.

◆ GetLock()

pcbnew.CONNECTIVITY_DATA.GetLock ( self) 
GetLock(CONNECTIVITY_DATA self) -> KISPINLOCK &

Definition at line 12097 of file pcbnew.py.

◆ GetNetCount()

pcbnew.CONNECTIVITY_DATA.GetNetCount ( self) 
GetNetCount(CONNECTIVITY_DATA self) -> int

Definition at line 12002 of file pcbnew.py.

◆ GetNetItems()

pcbnew.CONNECTIVITY_DATA.GetNetItems ( self,
aNetCode,
aTypes ) 
GetNetItems(CONNECTIVITY_DATA self, int aNetCode, std::vector< KICAD_T,std::allocator< KICAD_T > > const & aTypes) -> std::vector< BOARD_CONNECTED_ITEM *,std::allocator< BOARD_CONNECTED_ITEM * > > const

Definition at line 12085 of file pcbnew.py.

◆ GetNetNameForNetCode()

pcbnew.CONNECTIVITY_DATA.GetNetNameForNetCode ( self,
nc ) 
GetNetNameForNetCode(CONNECTIVITY_DATA self, int nc) -> wxString

Definition at line 12121 of file pcbnew.py.

◆ GetNetSettings()

pcbnew.CONNECTIVITY_DATA.GetNetSettings ( self) 
GetNetSettings(CONNECTIVITY_DATA self) -> NET_SETTINGS

Definition at line 12113 of file pcbnew.py.

◆ GetNodeCount()

pcbnew.CONNECTIVITY_DATA.GetNodeCount ( self,
aNet = -1 ) 
GetNodeCount(CONNECTIVITY_DATA self, int aNet=-1) -> unsigned int

Definition at line 12030 of file pcbnew.py.

◆ GetPadCount()

pcbnew.CONNECTIVITY_DATA.GetPadCount ( self,
aNet = -1 ) 
GetPadCount(CONNECTIVITY_DATA self, int aNet=-1) -> unsigned int

Definition at line 12034 of file pcbnew.py.

◆ GetRatsnestForNet()

pcbnew.CONNECTIVITY_DATA.GetRatsnestForNet ( self,
aNet ) 
GetRatsnestForNet(CONNECTIVITY_DATA self, int aNet) -> RN_NET *

Definition at line 12006 of file pcbnew.py.

◆ GetUnconnectedCount()

pcbnew.CONNECTIVITY_DATA.GetUnconnectedCount ( self,
aVisibileOnly ) 
GetUnconnectedCount(CONNECTIVITY_DATA self, bool aVisibileOnly) -> unsigned int

Definition at line 12022 of file pcbnew.py.

◆ HasNetNameForNetCode()

pcbnew.CONNECTIVITY_DATA.HasNetNameForNetCode ( self,
nc ) 
HasNetNameForNetCode(CONNECTIVITY_DATA self, int nc) -> bool

Definition at line 12117 of file pcbnew.py.

◆ HideLocalRatsnest()

pcbnew.CONNECTIVITY_DATA.HideLocalRatsnest ( self) 
HideLocalRatsnest(CONNECTIVITY_DATA self)

Definition at line 12069 of file pcbnew.py.

◆ IsConnectedOnLayer()

pcbnew.CONNECTIVITY_DATA.IsConnectedOnLayer ( self,
* args ) 
IsConnectedOnLayer(CONNECTIVITY_DATA self, BOARD_CONNECTED_ITEM aItem, int aLayer, std::initializer_list< KICAD_T > const & aTypes={}) -> bool

Definition at line 12026 of file pcbnew.py.

◆ MarkItemNetAsDirty()

pcbnew.CONNECTIVITY_DATA.MarkItemNetAsDirty ( self,
aItem ) 
MarkItemNetAsDirty(CONNECTIVITY_DATA self, BOARD_ITEM aItem)

Definition at line 12101 of file pcbnew.py.

◆ Move()

pcbnew.CONNECTIVITY_DATA.Move ( self,
aDelta ) 
Move(CONNECTIVITY_DATA self, VECTOR2I aDelta)

Definition at line 11994 of file pcbnew.py.

◆ PropagateNets()

pcbnew.CONNECTIVITY_DATA.PropagateNets ( self,
aCommit = None ) 
PropagateNets(CONNECTIVITY_DATA self, BOARD_COMMIT * aCommit=None)

Definition at line 12010 of file pcbnew.py.

◆ RecalculateRatsnest()

pcbnew.CONNECTIVITY_DATA.RecalculateRatsnest ( self,
aCommit = None ) 
RecalculateRatsnest(CONNECTIVITY_DATA self, BOARD_COMMIT * aCommit=None)

Definition at line 12018 of file pcbnew.py.

◆ RefreshNetcodeMap()

pcbnew.CONNECTIVITY_DATA.RefreshNetcodeMap ( self,
aBoard ) 
RefreshNetcodeMap(CONNECTIVITY_DATA self, BOARD aBoard)

Definition at line 12125 of file pcbnew.py.

◆ Remove()

pcbnew.CONNECTIVITY_DATA.Remove ( self,
aItem ) 
Remove(CONNECTIVITY_DATA self, BOARD_ITEM aItem) -> bool

Definition at line 11986 of file pcbnew.py.

◆ RemoveInvalidRefs()

pcbnew.CONNECTIVITY_DATA.RemoveInvalidRefs ( self) 
RemoveInvalidRefs(CONNECTIVITY_DATA self)

Definition at line 12105 of file pcbnew.py.

◆ RunOnUnconnectedEdges()

pcbnew.CONNECTIVITY_DATA.RunOnUnconnectedEdges ( self,
aFunc ) 
RunOnUnconnectedEdges(CONNECTIVITY_DATA self, std::function< bool (CN_EDGE &) > aFunc)

Definition at line 12057 of file pcbnew.py.

◆ SetProgressReporter()

pcbnew.CONNECTIVITY_DATA.SetProgressReporter ( self,
aReporter ) 
SetProgressReporter(CONNECTIVITY_DATA self, PROGRESS_REPORTER * aReporter)

Definition at line 12109 of file pcbnew.py.

◆ TestTrackEndpointDangling()

pcbnew.CONNECTIVITY_DATA.TestTrackEndpointDangling ( self,
aTrack,
aIgnoreTracksInPads,
aPos = None ) 
TestTrackEndpointDangling(CONNECTIVITY_DATA self, PCB_TRACK aTrack, bool aIgnoreTracksInPads, VECTOR2I aPos=None) -> bool

Definition at line 12061 of file pcbnew.py.

◆ Update()

pcbnew.CONNECTIVITY_DATA.Update ( self,
aItem ) 
Update(CONNECTIVITY_DATA self, BOARD_ITEM aItem) -> bool

Definition at line 11990 of file pcbnew.py.

Property Documentation

◆ thisown

pcbnew.CONNECTIVITY_DATA.thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
static

Definition at line 11964 of file pcbnew.py.

The documentation for this class was generated from the following file:
Generated on Sun Dec 7 2025 00:10:37 for KiCad Pcbnew Python Scripting by doxygen 1.13.2