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

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

Properties

property 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 11685 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::shared_ptr< CONNECTIVITY_DATA > aGlobalConnectivity, std::vector< BOARD_ITEM *,std::allocator< BOARD_ITEM * > > const & aLocalItems, bool aSkipRatsnestUpdate=False) -> CONNECTIVITY_DATA

Definition at line 11692 of file pcbnew.py.

Here is the caller graph for this function:

Member Function Documentation

◆ Add()

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

Definition at line 11706 of file pcbnew.py.

Here is the caller graph for this function:

◆ BlockRatsnestItems()

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

Definition at line 11813 of file pcbnew.py.

◆ Build()

def 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 11699 of file pcbnew.py.

Here is the caller graph for this function:

◆ ClearLocalRatsnest()

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

Definition at line 11789 of file pcbnew.py.

◆ ClearRatsnest()

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

Definition at line 11722 of file pcbnew.py.

◆ ComputeLocalRatsnest()

def 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 11797 of file pcbnew.py.

◆ FillIsolatedIslandsMap()

def 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 11738 of file pcbnew.py.

◆ GetConnectedItems()

def 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 11805 of file pcbnew.py.

◆ GetConnectedItemsAtAnchor()

def 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 11777 of file pcbnew.py.

◆ GetConnectedPads()

def 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 11766 of file pcbnew.py.

Here is the caller graph for this function:

◆ GetConnectedPadsAndVias()

def 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 11773 of file pcbnew.py.

◆ GetConnectedTracks()

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

Definition at line 11762 of file pcbnew.py.

◆ GetConnectivityAlgo()

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

Definition at line 11817 of file pcbnew.py.

◆ GetFromToCache()

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

Definition at line 11853 of file pcbnew.py.

◆ GetLocalRatsnest()

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

Definition at line 11801 of file pcbnew.py.

◆ GetLock()

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

Definition at line 11821 of file pcbnew.py.

◆ GetNetCount()

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

Definition at line 11726 of file pcbnew.py.

◆ GetNetItems()

def 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 11809 of file pcbnew.py.

◆ GetNetNameForNetCode()

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

Definition at line 11845 of file pcbnew.py.

◆ GetNetSettings()

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

Definition at line 11837 of file pcbnew.py.

◆ GetNodeCount()

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

Definition at line 11754 of file pcbnew.py.

◆ GetPadCount()

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

Definition at line 11758 of file pcbnew.py.

◆ GetRatsnestForNet()

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

Definition at line 11730 of file pcbnew.py.

◆ GetUnconnectedCount()

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

Definition at line 11746 of file pcbnew.py.

◆ HasNetNameForNetCode()

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

Definition at line 11841 of file pcbnew.py.

◆ HideLocalRatsnest()

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

Definition at line 11793 of file pcbnew.py.

◆ IsConnectedOnLayer()

def 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 11750 of file pcbnew.py.

◆ MarkItemNetAsDirty()

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

Definition at line 11825 of file pcbnew.py.

◆ Move()

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

Definition at line 11718 of file pcbnew.py.

◆ PropagateNets()

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

Definition at line 11734 of file pcbnew.py.

◆ RecalculateRatsnest()

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

Definition at line 11742 of file pcbnew.py.

◆ RefreshNetcodeMap()

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

Definition at line 11849 of file pcbnew.py.

◆ Remove()

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

Definition at line 11710 of file pcbnew.py.

◆ RemoveInvalidRefs()

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

Definition at line 11829 of file pcbnew.py.

◆ RunOnUnconnectedEdges()

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

Definition at line 11781 of file pcbnew.py.

◆ SetProgressReporter()

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

Definition at line 11833 of file pcbnew.py.

◆ TestTrackEndpointDangling()

def 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 11785 of file pcbnew.py.

◆ Update()

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

Definition at line 11714 of file pcbnew.py.

Property Documentation

◆ thisown

property 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 11688 of file pcbnew.py.


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