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

Public Member Functions

def __init__ (self, aParent, aPath)
 
def __eq__ (self, aOther)
 
def __ne__ (self, aOther)
 
def SetDefaultNetclass (self, netclass)
 
def GetDefaultNetclass (self)
 
def HasNetclass (self, netclassName)
 
def SetNetclass (self, netclassName, netclass)
 
def SetNetclasses (self, netclasses)
 
def GetNetclasses (self)
 
def GetCompositeNetclasses (self)
 
def ClearNetclasses (self)
 
def GetNetclassLabelAssignments (self)
 
def ClearNetclassLabelAssignments (self)
 
def ClearNetclassLabelAssignment (self, netName)
 
def SetNetclassLabelAssignment (self, netName, netclasses)
 
def AppendNetclassLabelAssignment (self, netName, netclasses)
 
def HasNetclassLabelAssignment (self, netName)
 
def SetNetclassPatternAssignment (self, pattern, netclass)
 
def SetNetclassPatternAssignments (self, netclassPatterns)
 
def GetNetclassPatternAssignments (self)
 
def ClearNetclassPatternAssignments (self)
 
def ClearCacheForNet (self, netName)
 
def ClearAllCaches (self)
 
def SetNetColorAssignment (self, netName, color)
 
def GetNetColorAssignments (self)
 
def ClearNetColorAssignments (self)
 
def HasEffectiveNetClass (self, aNetName)
 
def GetCachedEffectiveNetClass (self, aNetName)
 
def GetEffectiveNetClass (self, aNetName)
 
def RecomputeEffectiveNetclasses (self)
 
def GetNetClassByName (self, aNetName)
 

Static Public Member Functions

def ParseBusVector (aBus, aName, aMemberList)
 
def ParseBusGroup (aGroup, name, aMemberList)
 

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++ NET_SETTINGS class.

Definition at line 11464 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

def pcbnew.NET_SETTINGS.__init__ (   self,
  aParent,
  aPath 
)
__init__(NET_SETTINGS self, JSON_SETTINGS * aParent, string aPath) -> NET_SETTINGS

Definition at line 11470 of file pcbnew.py.

Member Function Documentation

◆ __eq__()

def pcbnew.NET_SETTINGS.__eq__ (   self,
  aOther 
)
__eq__(NET_SETTINGS self, NET_SETTINGS aOther) -> bool

Definition at line 11475 of file pcbnew.py.

◆ __ne__()

def pcbnew.NET_SETTINGS.__ne__ (   self,
  aOther 
)
__ne__(NET_SETTINGS self, NET_SETTINGS aOther) -> bool

Definition at line 11479 of file pcbnew.py.

◆ AppendNetclassLabelAssignment()

def pcbnew.NET_SETTINGS.AppendNetclassLabelAssignment (   self,
  netName,
  netclasses 
)
AppendNetclassLabelAssignment(NET_SETTINGS self, wxString netName, STRINGSET netclasses)

Definition at line 11531 of file pcbnew.py.

◆ ClearAllCaches()

def pcbnew.NET_SETTINGS.ClearAllCaches (   self)
ClearAllCaches(NET_SETTINGS self)

Definition at line 11559 of file pcbnew.py.

◆ ClearCacheForNet()

def pcbnew.NET_SETTINGS.ClearCacheForNet (   self,
  netName 
)
ClearCacheForNet(NET_SETTINGS self, wxString netName)

Definition at line 11555 of file pcbnew.py.

◆ ClearNetclasses()

def pcbnew.NET_SETTINGS.ClearNetclasses (   self)
ClearNetclasses(NET_SETTINGS self)

Definition at line 11511 of file pcbnew.py.

◆ ClearNetclassLabelAssignment()

def pcbnew.NET_SETTINGS.ClearNetclassLabelAssignment (   self,
  netName 
)
ClearNetclassLabelAssignment(NET_SETTINGS self, wxString netName)

Definition at line 11523 of file pcbnew.py.

◆ ClearNetclassLabelAssignments()

def pcbnew.NET_SETTINGS.ClearNetclassLabelAssignments (   self)
ClearNetclassLabelAssignments(NET_SETTINGS self)

Definition at line 11519 of file pcbnew.py.

◆ ClearNetclassPatternAssignments()

def pcbnew.NET_SETTINGS.ClearNetclassPatternAssignments (   self)
ClearNetclassPatternAssignments(NET_SETTINGS self)

Definition at line 11551 of file pcbnew.py.

◆ ClearNetColorAssignments()

def pcbnew.NET_SETTINGS.ClearNetColorAssignments (   self)
ClearNetColorAssignments(NET_SETTINGS self)

Definition at line 11571 of file pcbnew.py.

◆ GetCachedEffectiveNetClass()

def pcbnew.NET_SETTINGS.GetCachedEffectiveNetClass (   self,
  aNetName 
)
GetCachedEffectiveNetClass(NET_SETTINGS self, wxString aNetName) -> std::shared_ptr< NETCLASS >

Definition at line 11579 of file pcbnew.py.

◆ GetCompositeNetclasses()

def pcbnew.NET_SETTINGS.GetCompositeNetclasses (   self)
GetCompositeNetclasses(NET_SETTINGS self) -> netclasses_map

Definition at line 11507 of file pcbnew.py.

◆ GetDefaultNetclass()

def pcbnew.NET_SETTINGS.GetDefaultNetclass (   self)
GetDefaultNetclass(NET_SETTINGS self) -> std::shared_ptr< NETCLASS >

Definition at line 11487 of file pcbnew.py.

◆ GetEffectiveNetClass()

def pcbnew.NET_SETTINGS.GetEffectiveNetClass (   self,
  aNetName 
)
GetEffectiveNetClass(NET_SETTINGS self, wxString aNetName) -> std::shared_ptr< NETCLASS >

Definition at line 11583 of file pcbnew.py.

◆ GetNetClassByName()

def pcbnew.NET_SETTINGS.GetNetClassByName (   self,
  aNetName 
)
GetNetClassByName(NET_SETTINGS self, wxString aNetName) -> std::shared_ptr< NETCLASS >

Definition at line 11591 of file pcbnew.py.

◆ GetNetclasses()

def pcbnew.NET_SETTINGS.GetNetclasses (   self)
GetNetclasses(NET_SETTINGS self) -> netclasses_map

Definition at line 11503 of file pcbnew.py.

◆ GetNetclassLabelAssignments()

def pcbnew.NET_SETTINGS.GetNetclassLabelAssignments (   self)
GetNetclassLabelAssignments(NET_SETTINGS self) -> std::map< wxString,std::set< wxString,std::less< wxString >,std::allocator< wxString > >,std::less< wxString >,std::allocator< std::pair< wxString const,std::set< wxString,std::less< wxString >,std::allocator< wxString > > > > > const &

Definition at line 11515 of file pcbnew.py.

◆ GetNetclassPatternAssignments()

def pcbnew.NET_SETTINGS.GetNetclassPatternAssignments (   self)
GetNetclassPatternAssignments(NET_SETTINGS self) -> std::vector< std::pair< std::unique_ptr< EDA_COMBINED_MATCHER >,wxString >,std::allocator< std::pair< std::unique_ptr< EDA_COMBINED_MATCHER >,wxString > > > &

Definition at line 11547 of file pcbnew.py.

◆ GetNetColorAssignments()

def pcbnew.NET_SETTINGS.GetNetColorAssignments (   self)
GetNetColorAssignments(NET_SETTINGS self) -> std::map< wxString,KIGFX::COLOR4D,std::less< wxString >,std::allocator< std::pair< wxString const,KIGFX::COLOR4D > > > const &

Definition at line 11567 of file pcbnew.py.

◆ HasEffectiveNetClass()

def pcbnew.NET_SETTINGS.HasEffectiveNetClass (   self,
  aNetName 
)
HasEffectiveNetClass(NET_SETTINGS self, wxString aNetName) -> bool

Definition at line 11575 of file pcbnew.py.

◆ HasNetclass()

def pcbnew.NET_SETTINGS.HasNetclass (   self,
  netclassName 
)
HasNetclass(NET_SETTINGS self, wxString netclassName) -> bool

Definition at line 11491 of file pcbnew.py.

◆ HasNetclassLabelAssignment()

def pcbnew.NET_SETTINGS.HasNetclassLabelAssignment (   self,
  netName 
)
HasNetclassLabelAssignment(NET_SETTINGS self, wxString netName) -> bool

Definition at line 11535 of file pcbnew.py.

◆ ParseBusGroup()

def pcbnew.NET_SETTINGS.ParseBusGroup (   aGroup,
  name,
  aMemberList 
)
static
ParseBusGroup(wxString aGroup, wxString name, std::vector< wxString,std::allocator< wxString > > * aMemberList) -> bool

Definition at line 11601 of file pcbnew.py.

◆ ParseBusVector()

def pcbnew.NET_SETTINGS.ParseBusVector (   aBus,
  aName,
  aMemberList 
)
static
ParseBusVector(wxString aBus, wxString aName, std::vector< wxString,std::allocator< wxString > > * aMemberList) -> bool

Definition at line 11596 of file pcbnew.py.

◆ RecomputeEffectiveNetclasses()

def pcbnew.NET_SETTINGS.RecomputeEffectiveNetclasses (   self)
RecomputeEffectiveNetclasses(NET_SETTINGS self)

Definition at line 11587 of file pcbnew.py.

◆ SetDefaultNetclass()

def pcbnew.NET_SETTINGS.SetDefaultNetclass (   self,
  netclass 
)
SetDefaultNetclass(NET_SETTINGS self, std::shared_ptr< NETCLASS > netclass)

Definition at line 11483 of file pcbnew.py.

◆ SetNetclass()

def pcbnew.NET_SETTINGS.SetNetclass (   self,
  netclassName,
  netclass 
)
SetNetclass(NET_SETTINGS self, wxString netclassName, std::shared_ptr< NETCLASS > & netclass)

Definition at line 11495 of file pcbnew.py.

◆ SetNetclasses()

def pcbnew.NET_SETTINGS.SetNetclasses (   self,
  netclasses 
)
SetNetclasses(NET_SETTINGS self, netclasses_map netclasses)

Definition at line 11499 of file pcbnew.py.

◆ SetNetclassLabelAssignment()

def pcbnew.NET_SETTINGS.SetNetclassLabelAssignment (   self,
  netName,
  netclasses 
)
SetNetclassLabelAssignment(NET_SETTINGS self, wxString netName, STRINGSET netclasses)

Definition at line 11527 of file pcbnew.py.

◆ SetNetclassPatternAssignment()

def pcbnew.NET_SETTINGS.SetNetclassPatternAssignment (   self,
  pattern,
  netclass 
)
SetNetclassPatternAssignment(NET_SETTINGS self, wxString pattern, wxString netclass)

Definition at line 11539 of file pcbnew.py.

◆ SetNetclassPatternAssignments()

def pcbnew.NET_SETTINGS.SetNetclassPatternAssignments (   self,
  netclassPatterns 
)
SetNetclassPatternAssignments(NET_SETTINGS self, std::vector< std::pair< std::unique_ptr< EDA_COMBINED_MATCHER >,wxString >,std::allocator< std::pair< std::unique_ptr< EDA_COMBINED_MATCHER >,wxString > > > && netclassPatterns)

Definition at line 11543 of file pcbnew.py.

◆ SetNetColorAssignment()

def pcbnew.NET_SETTINGS.SetNetColorAssignment (   self,
  netName,
  color 
)
SetNetColorAssignment(NET_SETTINGS self, wxString netName, COLOR4D color)

Definition at line 11563 of file pcbnew.py.

Property Documentation

◆ thisown

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

Definition at line 11467 of file pcbnew.py.


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