KiCad Pcbnew Python Scripting
Loading...
Searching...
No Matches
pcbnew.NET_SETTINGS Class Reference
Inheritance diagram for pcbnew.NET_SETTINGS:

Public Member Functions

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

Static Public Member Functions

 ParseBusVector (aBus, aName, aMemberList)
 
 ParseBusGroup (aGroup, name, aMemberList)
 
 ForEachBusMember (aBusPattern, aFunction)
 

Properties

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

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 12032 of file pcbnew.py.

Member Function Documentation

◆ __eq__()

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

Definition at line 12037 of file pcbnew.py.

◆ __ne__()

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

Definition at line 12041 of file pcbnew.py.

◆ AppendNetclassLabelAssignment()

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

Definition at line 12093 of file pcbnew.py.

◆ ClearAllCaches()

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

Definition at line 12121 of file pcbnew.py.

◆ ClearCacheForNet()

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

Definition at line 12117 of file pcbnew.py.

◆ ClearNetclasses()

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

Definition at line 12073 of file pcbnew.py.

◆ ClearNetclassLabelAssignment()

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

Definition at line 12085 of file pcbnew.py.

◆ ClearNetclassLabelAssignments()

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

Definition at line 12081 of file pcbnew.py.

◆ ClearNetclassPatternAssignments()

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

Definition at line 12113 of file pcbnew.py.

◆ ClearNetColorAssignments()

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

Definition at line 12133 of file pcbnew.py.

◆ ForEachBusMember()

pcbnew.NET_SETTINGS.ForEachBusMember ( aBusPattern,
aFunction )
static
ForEachBusMember(wxString aBusPattern, std::function< void (wxString const &) > const & aFunction)

Definition at line 12168 of file pcbnew.py.

◆ GetCachedEffectiveNetClass()

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

Definition at line 12141 of file pcbnew.py.

◆ GetCompositeNetclasses()

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

Definition at line 12069 of file pcbnew.py.

◆ GetDefaultNetclass()

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

Definition at line 12049 of file pcbnew.py.

◆ GetEffectiveNetClass()

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

Definition at line 12145 of file pcbnew.py.

◆ GetNetClassByName()

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

Definition at line 12153 of file pcbnew.py.

◆ GetNetclasses()

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

Definition at line 12065 of file pcbnew.py.

◆ GetNetclassLabelAssignments()

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

◆ GetNetclassPatternAssignments()

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

◆ GetNetColorAssignments()

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

◆ HasEffectiveNetClass()

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

Definition at line 12137 of file pcbnew.py.

◆ HasNetclass()

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

Definition at line 12053 of file pcbnew.py.

◆ HasNetclassLabelAssignment()

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

Definition at line 12097 of file pcbnew.py.

◆ ParseBusGroup()

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

Definition at line 12163 of file pcbnew.py.

◆ ParseBusVector()

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

Definition at line 12158 of file pcbnew.py.

◆ RecomputeEffectiveNetclasses()

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

Definition at line 12149 of file pcbnew.py.

◆ SetDefaultNetclass()

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

Definition at line 12045 of file pcbnew.py.

◆ SetNetclass()

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

Definition at line 12057 of file pcbnew.py.

◆ SetNetclasses()

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

Definition at line 12061 of file pcbnew.py.

◆ SetNetclassLabelAssignment()

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

Definition at line 12089 of file pcbnew.py.

◆ SetNetclassPatternAssignment()

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

Definition at line 12101 of file pcbnew.py.

◆ SetNetclassPatternAssignments()

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

◆ SetNetColorAssignment()

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

Definition at line 12125 of file pcbnew.py.

Property Documentation

◆ thisown

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


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