KiCad Pcbnew Python Scripting
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

def __init__ (self, *args)
 
"void" Build (self, *args)
 
"bool" Add (self, "BOARD_ITEM" aItem)
 
"bool" Remove (self, "BOARD_ITEM" aItem)
 
"bool" Update (self, "BOARD_ITEM" aItem)
 
"void" Move (self, "VECTOR2I" aDelta)
 
"void" Clear (self)
 
"int" GetNetCount (self)
 
"RN_NET *" GetRatsnestForNet (self, "int" aNet)
 
"void" PropagateNets (self, *args)
 
"bool" CheckConnectivity (self, "std::vector< CN_DISJOINT_NET_ENTRY,std::allocator< CN_DISJOINT_NET_ENTRY > > &" aReport)
 
"void" FindIsolatedCopperIslands (self, *args)
 
"void" RecalculateRatsnest (self, "BOARD_COMMIT *" aCommit=None)
 
"unsigned int" GetUnconnectedCount (self)
 
"bool" IsConnectedOnLayer (self, *args)
 
"unsigned int" GetNodeCount (self, "int" aNet=-1)
 
"unsigned int" GetPadCount (self, "int" aNet=-1)
 
"std::vector< PCB_TRACK *,std::allocator< PCB_TRACK * > > const" GetConnectedTracks (self, "BOARD_CONNECTED_ITEM" aItem)
 
"void" GetConnectedPads (self, *args)
 
"std::vector< BOARD_CONNECTED_ITEM *,std::allocator< BOARD_CONNECTED_ITEM * > > const" GetConnectedItemsAtAnchor (self, "BOARD_CONNECTED_ITEM" aItem, "VECTOR2I" aAnchor, "KICAD_T const []" aTypes, "int const &" aMaxError=0)
 
"void" GetUnconnectedEdges (self, "std::vector< CN_EDGE,std::allocator< CN_EDGE > > &" aEdges)
 
"bool" TestTrackEndpointDangling (self, "PCB_TRACK" aTrack, "wxPoint" aPos=None)
 
"void" ClearDynamicRatsnest (self)
 
"void" HideDynamicRatsnest (self)
 
"void" ComputeDynamicRatsnest (self, *args)
 
"std::vector< RN_DYNAMIC_LINE,std::allocator< RN_DYNAMIC_LINE > > const &" GetDynamicRatsnest (self)
 
"std::vector< BOARD_CONNECTED_ITEM *,std::allocator< BOARD_CONNECTED_ITEM * > > const" GetConnectedItems (self, "BOARD_CONNECTED_ITEM" aItem, "KICAD_T const []" aTypes, "bool" aIgnoreNetcodes=False)
 
"std::vector< BOARD_CONNECTED_ITEM *,std::allocator< BOARD_CONNECTED_ITEM * > > const" GetNetItems (self, "int" aNetCode, "KICAD_T const []" aTypes)
 
"void" BlockRatsnestItems (self, "std::vector< BOARD_ITEM *,std::allocator< BOARD_ITEM * > > const &" aItems)
 
"std::shared_ptr< CN_CONNECTIVITY_ALGO >" GetConnectivityAlgo (self)
 
"KISPINLOCK &" GetLock (self)
 
"void" MarkItemNetAsDirty (self, "BOARD_ITEM" aItem)
 
"void" SetProgressReporter (self, "PROGRESS_REPORTER *" aReporter)
 
"std::map< int,wxString,std::less< int >,std::allocator< std::pair< int const,wxString > > > const &" GetNetclassMap (self)
 
"std::shared_ptr< FROM_TO_CACHE >" 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 9283 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

def pcbnew.CONNECTIVITY_DATA.__init__ (   self,
*  args 
) 
    __init__(CONNECTIVITY_DATA self) -> CONNECTIVITY_DATA
    __init__(CONNECTIVITY_DATA self, std::vector< BOARD_ITEM *,std::allocator< BOARD_ITEM * > > const & aItems, bool aSkipItems=False) -> CONNECTIVITY_DATA

Definition at line 9290 of file pcbnew.py.

Here is the caller graph for this function:

Member Function Documentation

◆ Add()

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

Definition at line 9304 of file pcbnew.py.

◆ BlockRatsnestItems()

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

Definition at line 9414 of file pcbnew.py.

◆ Build()

"void" pcbnew.CONNECTIVITY_DATA.Build (   self,
*  args 
) 
    Build(CONNECTIVITY_DATA self, BOARD aBoard, PROGRESS_REPORTER * aReporter=None)
    Build(CONNECTIVITY_DATA self, std::vector< BOARD_ITEM *,std::allocator< BOARD_ITEM * > > const & aItems)

Definition at line 9297 of file pcbnew.py.

Here is the caller graph for this function:

◆ CheckConnectivity()

"bool" pcbnew.CONNECTIVITY_DATA.CheckConnectivity (   self,
"std::vector< CN_DISJOINT_NET_ENTRY,std::allocator< CN_DISJOINT_NET_ENTRY > > &"  aReport 
) 
CheckConnectivity(CONNECTIVITY_DATA self, std::vector< CN_DISJOINT_NET_ENTRY,std::allocator< CN_DISJOINT_NET_ENTRY > > & aReport) -> bool

Definition at line 9336 of file pcbnew.py.

◆ Clear()

"void" pcbnew.CONNECTIVITY_DATA.Clear (   self) 
Clear(CONNECTIVITY_DATA self)

Definition at line 9320 of file pcbnew.py.

◆ ClearDynamicRatsnest()

"void" pcbnew.CONNECTIVITY_DATA.ClearDynamicRatsnest (   self) 
ClearDynamicRatsnest(CONNECTIVITY_DATA self)

Definition at line 9390 of file pcbnew.py.

◆ ComputeDynamicRatsnest()

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

Definition at line 9398 of file pcbnew.py.

◆ FindIsolatedCopperIslands()

"void" pcbnew.CONNECTIVITY_DATA.FindIsolatedCopperIslands (   self,
*  args 
) 
    FindIsolatedCopperIslands(CONNECTIVITY_DATA self, ZONE aZone, intVector aIslands)
    FindIsolatedCopperIslands(CONNECTIVITY_DATA self, std::vector< CN_ZONE_ISOLATED_ISLAND_LIST,std::allocator< CN_ZONE_ISOLATED_ISLAND_LIST > > & aZones)

Definition at line 9340 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetConnectedItems()

"std.vector< BOARD_CONNECTED_ITEM *,std.allocator< BOARD_CONNECTED_ITEM * > > const" pcbnew.CONNECTIVITY_DATA.GetConnectedItems (   self,
"BOARD_CONNECTED_ITEM"  aItem,
"KICAD_T const []"  aTypes,
"bool"  aIgnoreNetcodes = False 
) 
GetConnectedItems(CONNECTIVITY_DATA self, BOARD_CONNECTED_ITEM aItem, KICAD_T const [] aTypes, bool aIgnoreNetcodes=False) -> std::vector< BOARD_CONNECTED_ITEM *,std::allocator< BOARD_CONNECTED_ITEM * > > const

Definition at line 9406 of file pcbnew.py.

◆ GetConnectedItemsAtAnchor()

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

Definition at line 9378 of file pcbnew.py.

◆ GetConnectedPads()

"void" 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 9371 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetConnectedTracks()

"std.vector< PCB_TRACK *,std.allocator< PCB_TRACK * > > const" pcbnew.CONNECTIVITY_DATA.GetConnectedTracks (   self,
"BOARD_CONNECTED_ITEM"  aItem 
) 
GetConnectedTracks(CONNECTIVITY_DATA self, BOARD_CONNECTED_ITEM aItem) -> TRACKS_VEC

Definition at line 9367 of file pcbnew.py.

◆ GetConnectivityAlgo()

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

Definition at line 9418 of file pcbnew.py.

◆ GetDynamicRatsnest()

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

Definition at line 9402 of file pcbnew.py.

◆ GetFromToCache()

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

Definition at line 9438 of file pcbnew.py.

◆ GetLock()

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

Definition at line 9422 of file pcbnew.py.

◆ GetNetclassMap()

"std.map< int,wxString,std.less< int >,std.allocator< std.pair< int const,wxString > > > const &" pcbnew.CONNECTIVITY_DATA.GetNetclassMap (   self) 
GetNetclassMap(CONNECTIVITY_DATA self) -> std::map< int,wxString,std::less< int >,std::allocator< std::pair< int const,wxString > > > const &

Definition at line 9434 of file pcbnew.py.

◆ GetNetCount()

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

Definition at line 9324 of file pcbnew.py.

◆ GetNetItems()

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

Definition at line 9410 of file pcbnew.py.

◆ GetNodeCount()

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

Definition at line 9359 of file pcbnew.py.

◆ GetPadCount()

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

Definition at line 9363 of file pcbnew.py.

◆ GetRatsnestForNet()

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

Definition at line 9328 of file pcbnew.py.

◆ GetUnconnectedCount()

"unsigned int" pcbnew.CONNECTIVITY_DATA.GetUnconnectedCount (   self) 
GetUnconnectedCount(CONNECTIVITY_DATA self) -> unsigned int

Definition at line 9351 of file pcbnew.py.

◆ GetUnconnectedEdges()

"void" pcbnew.CONNECTIVITY_DATA.GetUnconnectedEdges (   self,
"std::vector< CN_EDGE,std::allocator< CN_EDGE > > &"  aEdges 
) 
GetUnconnectedEdges(CONNECTIVITY_DATA self, std::vector< CN_EDGE,std::allocator< CN_EDGE > > & aEdges)

Definition at line 9382 of file pcbnew.py.

◆ HideDynamicRatsnest()

"void" pcbnew.CONNECTIVITY_DATA.HideDynamicRatsnest (   self) 
HideDynamicRatsnest(CONNECTIVITY_DATA self)

Definition at line 9394 of file pcbnew.py.

◆ IsConnectedOnLayer()

"bool" pcbnew.CONNECTIVITY_DATA.IsConnectedOnLayer (   self,
*  args 
) 
IsConnectedOnLayer(CONNECTIVITY_DATA self, BOARD_CONNECTED_ITEM aItem, int aLayer, std::vector< KICAD_T,std::allocator< KICAD_T > > aTypes={}, bool aCheckOptionalFlashing=False) -> bool

Definition at line 9355 of file pcbnew.py.

◆ MarkItemNetAsDirty()

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

Definition at line 9426 of file pcbnew.py.

◆ Move()

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

Definition at line 9316 of file pcbnew.py.

◆ PropagateNets()

"void" pcbnew.CONNECTIVITY_DATA.PropagateNets (   self,
*  args 
) 
PropagateNets(CONNECTIVITY_DATA self, BOARD_COMMIT * aCommit=None, PROPAGATE_MODE aMode=SKIP_CONFLICTS)

Definition at line 9332 of file pcbnew.py.

◆ RecalculateRatsnest()

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

Definition at line 9347 of file pcbnew.py.

◆ Remove()

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

Definition at line 9308 of file pcbnew.py.

◆ SetProgressReporter()

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

Definition at line 9430 of file pcbnew.py.

◆ TestTrackEndpointDangling()

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

Definition at line 9386 of file pcbnew.py.

◆ Update()

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

Definition at line 9312 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 9286 of file pcbnew.py.

The documentation for this class was generated from the following file:
Generated on Sun Jan 1 2023 00:51:22 for KiCad Pcbnew Python Scripting by doxygen 1.9.4