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

Public Member Functions

def __init__ (self, *args, **kwargs)
 
def GetBoardFileDesc (self)
 
def CanReadBoard (self, aFileName)
 
def CanReadFootprint (self, aFileName)
 
def SetQueryUserCallback (self, aCallback)
 
def LoadBoard (self, aFileName, aAppendToMe, aProperties=None, aProject=None)
 
def GetImportedCachedLibraryFootprints (self)
 
def SaveBoard (self, aFileName, aBoard, aProperties=None)
 
def FootprintEnumerate (self, aFootprintNames, aLibraryPath, aBestEfforts, aProperties=None)
 
def GetLibraryTimestamp (self, aLibraryPath)
 
def PrefetchLib (self, aLibraryPath, aProperties=None)
 
def ImportFootprint (self, aFootprintPath, aFootprintNameOut, aProperties=None)
 
def FootprintLoad (self, aLibraryPath, aFootprintName, aKeepUUID=False, aProperties=None)
 
def GetEnumeratedFootprint (self, aLibraryPath, aFootprintName, aProperties=None)
 
def FootprintExists (self, aLibraryPath, aFootprintName, aProperties=None)
 
def FootprintSave (self, aLibraryPath, aFootprint, aProperties=None)
 
def FootprintDelete (self, aLibraryPath, aFootprintName, aProperties=None)
 
def GetLibraryOptions (self, aListToAppendTo)
 
def footprintPyEnumerate (self, aLibraryPath, aExitOnError)
 
def FootprintEnumerate (self, libname)
 
def FootprintLibCreate (self, aLibraryPath, aProperties=None)
 
def FootprintLibDelete (self, aLibraryPath, aProperties=None)
 
def IsFootprintLibWritable (self, aLibraryPath)
 

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

Definition at line 7642 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

def pcbnew.PCB_IO.__init__ (   self,
args,
**  kwargs 
)

Reimplemented in pcbnew.PCB_IO_KICAD_SEXPR.

Definition at line 7647 of file pcbnew.py.

Member Function Documentation

◆ CanReadBoard()

def pcbnew.PCB_IO.CanReadBoard (   self,
  aFileName 
)
CanReadBoard(PCB_IO self, wxString aFileName) -> bool

Definition at line 7655 of file pcbnew.py.

◆ CanReadFootprint()

def pcbnew.PCB_IO.CanReadFootprint (   self,
  aFileName 
)
CanReadFootprint(PCB_IO self, wxString aFileName) -> bool

Definition at line 7659 of file pcbnew.py.

◆ FootprintDelete()

def pcbnew.PCB_IO.FootprintDelete (   self,
  aLibraryPath,
  aFootprintName,
  aProperties = None 
)
FootprintDelete(PCB_IO self, wxString aLibraryPath, wxString aFootprintName, str_utf8_Map aProperties=None)

Reimplemented in pcbnew.PCB_IO_KICAD_SEXPR.

Definition at line 7711 of file pcbnew.py.

◆ FootprintEnumerate() [1/2]

def pcbnew.PCB_IO.FootprintEnumerate (   self,
  aFootprintNames,
  aLibraryPath,
  aBestEfforts,
  aProperties = None 
)
FootprintEnumerate(PCB_IO self, wxArrayString & aFootprintNames, wxString aLibraryPath, bool aBestEfforts, str_utf8_Map aProperties=None)

Reimplemented in pcbnew.PCB_IO_KICAD_SEXPR.

Definition at line 7679 of file pcbnew.py.

◆ FootprintEnumerate() [2/2]

def pcbnew.PCB_IO.FootprintEnumerate (   self,
  libname 
)

Reimplemented in pcbnew.PCB_IO_KICAD_SEXPR.

Definition at line 7724 of file pcbnew.py.

◆ FootprintExists()

def pcbnew.PCB_IO.FootprintExists (   self,
  aLibraryPath,
  aFootprintName,
  aProperties = None 
)
FootprintExists(PCB_IO self, wxString aLibraryPath, wxString aFootprintName, str_utf8_Map aProperties=None) -> bool

Reimplemented in pcbnew.PCB_IO_KICAD_SEXPR.

Definition at line 7703 of file pcbnew.py.

◆ FootprintLibCreate()

def pcbnew.PCB_IO.FootprintLibCreate (   self,
  aLibraryPath,
  aProperties = None 
)

Definition at line 7728 of file pcbnew.py.

◆ FootprintLibDelete()

def pcbnew.PCB_IO.FootprintLibDelete (   self,
  aLibraryPath,
  aProperties = None 
)

Definition at line 7732 of file pcbnew.py.

◆ FootprintLoad()

def pcbnew.PCB_IO.FootprintLoad (   self,
  aLibraryPath,
  aFootprintName,
  aKeepUUID = False,
  aProperties = None 
)
FootprintLoad(PCB_IO self, wxString aLibraryPath, wxString aFootprintName, bool aKeepUUID=False, str_utf8_Map aProperties=None) -> FOOTPRINT

Reimplemented in pcbnew.PCB_IO_KICAD_SEXPR.

Definition at line 7695 of file pcbnew.py.

◆ footprintPyEnumerate()

def pcbnew.PCB_IO.footprintPyEnumerate (   self,
  aLibraryPath,
  aExitOnError 
)
footprintPyEnumerate(PCB_IO self, wxString aLibraryPath, bool aExitOnError) -> wxArrayString

Definition at line 7720 of file pcbnew.py.

Here is the caller graph for this function:

◆ FootprintSave()

def pcbnew.PCB_IO.FootprintSave (   self,
  aLibraryPath,
  aFootprint,
  aProperties = None 
)
FootprintSave(PCB_IO self, wxString aLibraryPath, FOOTPRINT aFootprint, str_utf8_Map aProperties=None)

Reimplemented in pcbnew.PCB_IO_KICAD_SEXPR.

Definition at line 7707 of file pcbnew.py.

◆ GetBoardFileDesc()

def pcbnew.PCB_IO.GetBoardFileDesc (   self)
GetBoardFileDesc(PCB_IO self) -> IO_BASE::IO_FILE_DESC const

Definition at line 7651 of file pcbnew.py.

◆ GetEnumeratedFootprint()

def pcbnew.PCB_IO.GetEnumeratedFootprint (   self,
  aLibraryPath,
  aFootprintName,
  aProperties = None 
)
GetEnumeratedFootprint(PCB_IO self, wxString aLibraryPath, wxString aFootprintName, str_utf8_Map aProperties=None) -> FOOTPRINT

Reimplemented in pcbnew.PCB_IO_KICAD_SEXPR.

Definition at line 7699 of file pcbnew.py.

◆ GetImportedCachedLibraryFootprints()

def pcbnew.PCB_IO.GetImportedCachedLibraryFootprints (   self)
GetImportedCachedLibraryFootprints(PCB_IO self) -> std::vector< FOOTPRINT *,std::allocator< FOOTPRINT * > >

Definition at line 7671 of file pcbnew.py.

◆ GetLibraryOptions()

def pcbnew.PCB_IO.GetLibraryOptions (   self,
  aListToAppendTo 
)
GetLibraryOptions(PCB_IO self, str_utf8_Map aListToAppendTo)

Definition at line 7715 of file pcbnew.py.

◆ GetLibraryTimestamp()

def pcbnew.PCB_IO.GetLibraryTimestamp (   self,
  aLibraryPath 
)
GetLibraryTimestamp(PCB_IO self, wxString aLibraryPath) -> long long

Definition at line 7683 of file pcbnew.py.

◆ ImportFootprint()

def pcbnew.PCB_IO.ImportFootprint (   self,
  aFootprintPath,
  aFootprintNameOut,
  aProperties = None 
)
ImportFootprint(PCB_IO self, wxString aFootprintPath, wxString aFootprintNameOut, str_utf8_Map aProperties=None) -> FOOTPRINT

Reimplemented in pcbnew.PCB_IO_KICAD_SEXPR.

Definition at line 7691 of file pcbnew.py.

◆ IsFootprintLibWritable()

def pcbnew.PCB_IO.IsFootprintLibWritable (   self,
  aLibraryPath 
)

Definition at line 7736 of file pcbnew.py.

◆ LoadBoard()

def pcbnew.PCB_IO.LoadBoard (   self,
  aFileName,
  aAppendToMe,
  aProperties = None,
  aProject = None 
)
LoadBoard(PCB_IO self, wxString aFileName, BOARD aAppendToMe, str_utf8_Map aProperties=None, PROJECT * aProject=None) -> BOARD

Reimplemented in pcbnew.PCB_IO_KICAD_SEXPR.

Definition at line 7667 of file pcbnew.py.

◆ PrefetchLib()

def pcbnew.PCB_IO.PrefetchLib (   self,
  aLibraryPath,
  aProperties = None 
)
PrefetchLib(PCB_IO self, wxString aLibraryPath, str_utf8_Map aProperties=None)

Definition at line 7687 of file pcbnew.py.

◆ SaveBoard()

def pcbnew.PCB_IO.SaveBoard (   self,
  aFileName,
  aBoard,
  aProperties = None 
)
SaveBoard(PCB_IO self, wxString aFileName, BOARD aBoard, str_utf8_Map aProperties=None)

Reimplemented in pcbnew.PCB_IO_KICAD_SEXPR.

Definition at line 7675 of file pcbnew.py.

◆ SetQueryUserCallback()

def pcbnew.PCB_IO.SetQueryUserCallback (   self,
  aCallback 
)
SetQueryUserCallback(PCB_IO self, std::function< bool (wxString,int,wxString,wxString) > aCallback)

Definition at line 7663 of file pcbnew.py.

Property Documentation

◆ thisown

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

Definition at line 7645 of file pcbnew.py.


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