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

Public Member Functions

def __init__ (self)
 
def Clear (self)
 
def begin (self, args)
 
def end (self, args)
 
def GetCount (self)
 
def GetDefault (self)
 
def Add (self, aNetclass)
 
def Remove (self, aNetName)
 
def Find (self, aName)
 
def NetClasses (self)
 

Public Attributes

 this
 

Detailed Description

Class NETCLASSES is a container for NETCLASS instances.

It owns all its NETCLASSes (=> it will delete them at time of
destruction). This container will always have a default NETCLASS with
the name given by const NETCLASS::Default.

C++ includes: class_netclass.h 

Definition at line 31152 of file pcbnew.py.

Constructor & Destructor Documentation

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

NETCLASSES::NETCLASSES() 

Definition at line 31170 of file pcbnew.py.

Member Function Documentation

def pcbnew.NETCLASSES.Add (   self,
  aNetclass 
)
Add(NETCLASSES self, NETCLASSPTR aNetclass) -> bool

bool
NETCLASSES::Add(NETCLASSPTR aNetclass)

Function Add takes aNetclass and puts it into this NETCLASSES
container.

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

aNetclass:  is netclass to add

true if the name within aNetclass is unique and it could be inserted
OK, else false because the name was not unique. 

Definition at line 31246 of file pcbnew.py.

def pcbnew.NETCLASSES.begin (   self,
  args 
)
begin(NETCLASSES self) -> NETCLASSES::iterator
begin(NETCLASSES self) -> NETCLASSES::const_iterator

const_iterator
NETCLASSES::begin() const 

Definition at line 31196 of file pcbnew.py.

def pcbnew.NETCLASSES.Clear (   self)
Clear(NETCLASSES self)

void NETCLASSES::Clear()

Function Clear destroys any contained NETCLASS instances except the
Default one. 

Definition at line 31184 of file pcbnew.py.

def pcbnew.NETCLASSES.end (   self,
  args 
)
end(NETCLASSES self) -> NETCLASSES::iterator
end(NETCLASSES self) -> NETCLASSES::const_iterator

const_iterator
NETCLASSES::end() const 

Definition at line 31207 of file pcbnew.py.

def pcbnew.NETCLASSES.Find (   self,
  aName 
)
Find(NETCLASSES self, wxString aName) -> NETCLASSPTR

NETCLASSPTR
NETCLASSES::Find(const wxString &aName) const

Function Find searches this container for a NETCLASS given by aName.

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

aName:  is the name of the NETCLASS to search for.

NETCLASSPTR - if found, else NULL. 

Definition at line 31289 of file pcbnew.py.

def pcbnew.NETCLASSES.GetCount (   self)
GetCount(NETCLASSES self) -> unsigned int

unsigned
NETCLASSES::GetCount() const

Function GetCount.

the number of netclasses, excluding the default one. 

Definition at line 31218 of file pcbnew.py.

def pcbnew.NETCLASSES.GetDefault (   self)
GetDefault(NETCLASSES self) -> NETCLASSPTR &

NETCLASSPTR&
NETCLASSES::GetDefault() const

Function GetDefault.

the default net class. 

Definition at line 31232 of file pcbnew.py.

def pcbnew.NETCLASSES.NetClasses (   self)
NetClasses(NETCLASSES self) -> NETCLASS_MAP

NETCLASS_MAP&
NETCLASSES::NetClasses()

Provide public access to m_NetClasses so it gets swigged. 

Definition at line 31308 of file pcbnew.py.

def pcbnew.NETCLASSES.Remove (   self,
  aNetName 
)
Remove(NETCLASSES self, wxString aNetName) -> NETCLASSPTR

NETCLASSPTR
NETCLASSES::Remove(const wxString &aNetName)

Function Remove removes a NETCLASS from this container but does not
destroy/delete it.

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

aNetName:  is the name of the net to delete, and it may not be
NETCLASS::Default.

NETCLASSPTR - the NETCLASS associated with aNetName if found and
removed, else NULL. 

Definition at line 31267 of file pcbnew.py.

Member Data Documentation

pcbnew.NETCLASSES.this

Definition at line 31180 of file pcbnew.py.


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