KiCAD pcbnew scripting
Public Member Functions | Public Attributes | List of all members
pcbnew.CONNECTIVITY_DATA Class Reference
Inheritance diagram for pcbnew.CONNECTIVITY_DATA:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self)
 
def Build (self, args)
 
def Add (self, aItem)
 
def Remove (self, aItem)
 
def Update (self, aItem)
 
def Clear (self)
 
def GetNetCount (self)
 
def GetRatsnestForNet (self, aNet)
 
def PropagateNets (self)
 
def CheckConnectivity (self, aReport)
 
def FindIsolatedCopperIslands (self, args)
 
def RecalculateRatsnest (self)
 
def GetUnconnectedCount (self)
 
def GetNodeCount
 
def GetPadCount
 
def GetConnectedTracks (self, aItem)
 
def GetConnectedPads (self, aItem)
 
def GetUnconnectedEdges (self, aEdges)
 
def ClearDynamicRatsnest (self)
 
def HideDynamicRatsnest (self)
 
def ComputeDynamicRatsnest (self, aItems)
 
def GetDynamicRatsnest (self)
 
def GetConnectedItems (self, args)
 
def GetNetItems (self, aNetCode, aTypes)
 
def NearestUnconnectedTargets
 
def BlockRatsnestItems (self, aItems)
 
def GetConnectivityAlgo (self)
 
def MarkItemNetAsDirty (self, aItem)
 
def SetProgressReporter (self, aReporter)
 

Public Attributes

 this
 

Detailed Description

C++ includes:
connectivity_data.h 

Definition at line 18211 of file pcbnew.py.

Constructor & Destructor Documentation

def pcbnew.CONNECTIVITY_DATA.__init__ (   self)
__init__(CONNECTIVITY_DATA self) -> CONNECTIVITY_DATA

CONNECTIVITY_DATA::CONNECTIVITY_DATA() 

Definition at line 18222 of file pcbnew.py.

Member Function Documentation

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

bool
CONNECTIVITY_DATA::Add(BOARD_ITEM *aItem)

Function Add() Adds an item to the connectivity data.

Parameters:
-----------

aItem:  is an item to be added.

True if operation succeeded. 

Definition at line 18250 of file pcbnew.py.

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

void
CONNECTIVITY_DATA::BlockRatsnestItems(const std::vector< BOARD_ITEM *
> &aItems) 

Definition at line 18570 of file pcbnew.py.

def pcbnew.CONNECTIVITY_DATA.Build (   self,
  args 
)
Build(CONNECTIVITY_DATA self, BOARD aBoard)
Build(CONNECTIVITY_DATA self, std::vector< BOARD_ITEM *,std::allocator< BOARD_ITEM * > > const & aItems)

void
CONNECTIVITY_DATA::Build(const std::vector< BOARD_ITEM * > &aItems)

Function Build() Builds the connectivity database for a set of items
aItems. 

Definition at line 18236 of file pcbnew.py.

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

bool
CONNECTIVITY_DATA::CheckConnectivity(std::vector<
CN_DISJOINT_NET_ENTRY > &aReport) 

Definition at line 18358 of file pcbnew.py.

def pcbnew.CONNECTIVITY_DATA.Clear (   self)
Clear(CONNECTIVITY_DATA self)

void
CONNECTIVITY_DATA::Clear()

Function Clear() Erases the connectivity database. 

Definition at line 18307 of file pcbnew.py.

def pcbnew.CONNECTIVITY_DATA.ClearDynamicRatsnest (   self)
ClearDynamicRatsnest(CONNECTIVITY_DATA self)

void
CONNECTIVITY_DATA::ClearDynamicRatsnest()

Function ClearDynamicRatsnest() Erases the temporary dynamic ratsnest
(i.e.

the ratsnest lines that pcbnew displays when moving an item/set of
items) 

Definition at line 18459 of file pcbnew.py.

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

void CONNECTIVITY_DATA::ComputeDynamicRatsnest(const std::vector<
BOARD_ITEM * > &aItems)

Function ComputeDynamicRatsnest() Calculates the temporary dynamic
ratsnest (i.e.

the ratsnest lines that) for the set of items aItems. 

Definition at line 18487 of file pcbnew.py.

def pcbnew.CONNECTIVITY_DATA.FindIsolatedCopperIslands (   self,
  args 
)
FindIsolatedCopperIslands(CONNECTIVITY_DATA self, ZONE_CONTAINER aZone, intVector aIslands)
FindIsolatedCopperIslands(CONNECTIVITY_DATA self, std::vector< CN_ZONE_ISOLATED_ISLAND_LIST,std::allocator< CN_ZONE_ISOLATED_ISLAND_LIST > > & aZones)

void CONNECTIVITY_DATA::FindIsolatedCopperIslands(std::vector<
CN_ZONE_ISOLATED_ISLAND_LIST > &aZones) 

Definition at line 18369 of file pcbnew.py.

def pcbnew.CONNECTIVITY_DATA.GetConnectedItems (   self,
  args 
)
GetConnectedItems(CONNECTIVITY_DATA self, BOARD_CONNECTED_ITEM aItem, VECTOR2I const & aAnchor, KICAD_T [] aTypes) -> std::vector< BOARD_CONNECTED_ITEM *,std::allocator< BOARD_CONNECTED_ITEM * > > const
GetConnectedItems(CONNECTIVITY_DATA self, BOARD_CONNECTED_ITEM aItem, KICAD_T const [] aTypes) -> std::vector< BOARD_CONNECTED_ITEM *,std::allocator< BOARD_CONNECTED_ITEM * > > const

const
std::vector< BOARD_CONNECTED_ITEM * >
CONNECTIVITY_DATA::GetConnectedItems(const BOARD_CONNECTED_ITEM
*aItem, const KICAD_T aTypes[]) const

Function GetConnectedItems() Returns a list of items connected to a
source item aItem.

Parameters:
-----------

aItem:  is the reference item to find other connected items.

aTypes:  allows to filter by item types. 

Definition at line 18513 of file pcbnew.py.

def pcbnew.CONNECTIVITY_DATA.GetConnectedPads (   self,
  aItem 
)
GetConnectedPads(CONNECTIVITY_DATA self, BOARD_CONNECTED_ITEM aItem) -> D_PADS

const
std::vector< D_PAD * > CONNECTIVITY_DATA::GetConnectedPads(const
BOARD_CONNECTED_ITEM *aItem) const 

Definition at line 18437 of file pcbnew.py.

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

const
std::vector< TRACK * > CONNECTIVITY_DATA::GetConnectedTracks(const
BOARD_CONNECTED_ITEM *aItem) const 

Definition at line 18426 of file pcbnew.py.

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

std::shared_ptr<CN_CONNECTIVITY_ALGO>
CONNECTIVITY_DATA::GetConnectivityAlgo() const 

Definition at line 18581 of file pcbnew.py.

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

const
std::vector<RN_DYNAMIC_LINE>& CONNECTIVITY_DATA::GetDynamicRatsnest()
const 

Definition at line 18502 of file pcbnew.py.

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

int
CONNECTIVITY_DATA::GetNetCount() const

Function GetNetCount() Returns the total number of nets in the
connectivity database. 

Definition at line 18319 of file pcbnew.py.

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

const
std::vector< BOARD_CONNECTED_ITEM * >
CONNECTIVITY_DATA::GetNetItems(int aNetCode, const KICAD_T aTypes[])
const

Function GetNetItems() Returns the list of items that belong to a
certain net.

Parameters:
-----------

aNetCode:  is the net code.

aTypes:  allows to filter by item types. 

Definition at line 18536 of file pcbnew.py.

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

unsigned int
CONNECTIVITY_DATA::GetNodeCount(int aNet=-1) const 

Definition at line 18404 of file pcbnew.py.

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

unsigned int
CONNECTIVITY_DATA::GetPadCount(int aNet=-1) const 

Definition at line 18415 of file pcbnew.py.

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

RN_NET *
CONNECTIVITY_DATA::GetRatsnestForNet(int aNet)

Function GetRatsnestForNet() Returns the ratsnest, expressed as a set
of graph edges for a given net. 

Definition at line 18332 of file pcbnew.py.

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

unsigned int CONNECTIVITY_DATA::GetUnconnectedCount() const

Function GetUnconnectedCount() Returns the number of remaining edges
in the ratsnest. 

Definition at line 18392 of file pcbnew.py.

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

void
CONNECTIVITY_DATA::GetUnconnectedEdges(std::vector< CN_EDGE > &aEdges)
const 

Definition at line 18448 of file pcbnew.py.

def pcbnew.CONNECTIVITY_DATA.HideDynamicRatsnest (   self)
HideDynamicRatsnest(CONNECTIVITY_DATA self)

void
CONNECTIVITY_DATA::HideDynamicRatsnest()

Hides the temporary dynamic ratsnest lines. 

Definition at line 18475 of file pcbnew.py.

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

void
CONNECTIVITY_DATA::MarkItemNetAsDirty(BOARD_ITEM *aItem) 

Definition at line 18591 of file pcbnew.py.

def pcbnew.CONNECTIVITY_DATA.NearestUnconnectedTargets (   self,
  aRef,
  aPos,
  aMaxCount = -1 
)
NearestUnconnectedTargets(CONNECTIVITY_DATA self, BOARD_CONNECTED_ITEM aRef, VECTOR2I const & aPos, int aMaxCount=-1) -> std::vector< VECTOR2I,std::allocator< VECTOR2I > > const
NearestUnconnectedTargets(CONNECTIVITY_DATA self, BOARD_CONNECTED_ITEM aRef, VECTOR2I const & aPos) -> std::vector< VECTOR2I,std::allocator< VECTOR2I > > const

const std::vector< VECTOR2I >
CONNECTIVITY_DATA::NearestUnconnectedTargets(const
BOARD_CONNECTED_ITEM *aRef, const VECTOR2I &aPos, int aMaxCount=-1) 

Definition at line 18558 of file pcbnew.py.

def pcbnew.CONNECTIVITY_DATA.PropagateNets (   self)
PropagateNets(CONNECTIVITY_DATA self)

void
CONNECTIVITY_DATA::PropagateNets()

Function PropagateNets() Propagates the net codes from the source pads
to the tracks/vias. 

Definition at line 18345 of file pcbnew.py.

def pcbnew.CONNECTIVITY_DATA.RecalculateRatsnest (   self)
RecalculateRatsnest(CONNECTIVITY_DATA self)

void
CONNECTIVITY_DATA::RecalculateRatsnest()

Function RecalculateRatsnest() Updates the ratsnest for the board. 

Definition at line 18380 of file pcbnew.py.

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

bool
CONNECTIVITY_DATA::Remove(BOARD_ITEM *aItem)

Function Remove() Removes an item from the connectivity data.

Parameters:
-----------

aItem:  is an item to be updated.

True if operation succeeded. 

Definition at line 18269 of file pcbnew.py.

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

void
CONNECTIVITY_DATA::SetProgressReporter(PROGRESS_REPORTER *aReporter)

Definition at line 18601 of file pcbnew.py.

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

bool
CONNECTIVITY_DATA::Update(BOARD_ITEM *aItem)

Function Update() Updates the connectivity data for an item.

Parameters:
-----------

aItem:  is an item to be updated.

True if operation succeeded. 

Definition at line 18288 of file pcbnew.py.

Member Data Documentation

pcbnew.CONNECTIVITY_DATA.this

Definition at line 18232 of file pcbnew.py.


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