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

Public Member Functions

def PluginName (self)
 
def GetFileExtension (self)
 
def Save (self, aFileName, aBoard, aProperties=None)
 
def Load (self, aFileName, aAppendToMe, aProperties=None)
 
def FootprintEnumerate (self, aFootprintNames, aLibraryPath, aProperties=None)
 
def LoadEnumeratedFootprint (self, aLibraryPath, aFootprintName, aProperties=None)
 
def FootprintLoad (self, aLibraryPath, aFootprintName, aProperties=None)
 
def FootprintSave (self, aLibraryPath, aFootprint, aProperties=None)
 
def FootprintDelete (self, aLibraryPath, aFootprintName, aProperties=None)
 
def GetLibraryTimestamp (self, aLibraryPath)
 
def FootprintLibCreate (self, aLibraryPath, aProperties=None)
 
def FootprintLibDelete (self, aLibraryPath, aProperties=None)
 
def IsFootprintLibWritable (self, aLibraryPath)
 
def __init__ (self, args)
 
def Format (self, aItem, aNestLevel=0)
 
def GetStringOutput (self, doClear)
 
def SetOutputFormatter (self, aFormatter)
 
def Parse (self, aClipboardSourceInput)
 
- Public Member Functions inherited from pcbnew.PLUGIN
def __init__ (self, args, kwargs)
 
def PluginName (self)
 
def GetFileExtension (self)
 
def Load (self, aFileName, aAppendToMe, aProperties=None)
 
def Save (self, aFileName, aBoard, aProperties=None)
 
def FootprintEnumerate (self, aFootprintNames, aLibraryPath, aProperties=None)
 
def GetLibraryTimestamp (self, aLibraryPath)
 
def PrefetchLib (self, aLibraryPath, aProperties=None)
 
def FootprintLoad (self, aLibraryPath, aFootprintName, aProperties=None)
 
def LoadEnumeratedFootprint (self, aLibraryPath, aFootprintName, aProperties=None)
 
def FootprintSave (self, aLibraryPath, aFootprint, aProperties=None)
 
def FootprintDelete (self, aLibraryPath, aFootprintName, aProperties=None)
 
def FootprintLibCreate (self, aLibraryPath, aProperties=None)
 
def FootprintLibDelete (self, aLibraryPath, aProperties=None)
 
def IsFootprintLibWritable (self, aLibraryPath)
 
def FootprintLibOptions (self, aListToAppendTo)
 
def footprintPyEnumerate (self, aLibraryPath, aExitOnError)
 
def FootprintEnumerate (self, libname)
 

Public Attributes

 this
 

Detailed Description

Proxy of C++ PCB_IO class.

Definition at line 5748 of file pcbnew.py.

Constructor & Destructor Documentation

def pcbnew.PCB_IO.__init__ (   self,
  args 
)
__init__(PCB_IO self, int aControlFlags) -> PCB_IO
__init__(PCB_IO self) -> PCB_IO

Definition at line 5853 of file pcbnew.py.

Member Function Documentation

def pcbnew.PCB_IO.FootprintDelete (   self,
  aLibraryPath,
  aFootprintName,
  aProperties = None 
)
FootprintDelete(PCB_IO self, wxString aLibraryPath, wxString aFootprintName, PROPERTIES const * aProperties=None)
FootprintDelete(PCB_IO self, wxString aLibraryPath, wxString aFootprintName)

Definition at line 5819 of file pcbnew.py.

def pcbnew.PCB_IO.FootprintEnumerate (   self,
  aFootprintNames,
  aLibraryPath,
  aProperties = None 
)
FootprintEnumerate(PCB_IO self, wxArrayString & aFootprintNames, wxString aLibraryPath, PROPERTIES const * aProperties=None)
FootprintEnumerate(PCB_IO self, wxArrayString & aFootprintNames, wxString aLibraryPath)

Definition at line 5787 of file pcbnew.py.

def pcbnew.PCB_IO.FootprintLibCreate (   self,
  aLibraryPath,
  aProperties = None 
)
FootprintLibCreate(PCB_IO self, wxString aLibraryPath, PROPERTIES const * aProperties=None)
FootprintLibCreate(PCB_IO self, wxString aLibraryPath)

Definition at line 5832 of file pcbnew.py.

def pcbnew.PCB_IO.FootprintLibDelete (   self,
  aLibraryPath,
  aProperties = None 
)
FootprintLibDelete(PCB_IO self, wxString aLibraryPath, PROPERTIES const * aProperties=None) -> bool
FootprintLibDelete(PCB_IO self, wxString aLibraryPath) -> bool

Definition at line 5840 of file pcbnew.py.

def pcbnew.PCB_IO.FootprintLoad (   self,
  aLibraryPath,
  aFootprintName,
  aProperties = None 
)
FootprintLoad(PCB_IO self, wxString aLibraryPath, wxString aFootprintName, PROPERTIES const * aProperties=None) -> MODULE
FootprintLoad(PCB_IO self, wxString aLibraryPath, wxString aFootprintName) -> MODULE

Definition at line 5803 of file pcbnew.py.

def pcbnew.PCB_IO.FootprintSave (   self,
  aLibraryPath,
  aFootprint,
  aProperties = None 
)
FootprintSave(PCB_IO self, wxString aLibraryPath, MODULE aFootprint, PROPERTIES const * aProperties=None)
FootprintSave(PCB_IO self, wxString aLibraryPath, MODULE aFootprint)

Definition at line 5811 of file pcbnew.py.

def pcbnew.PCB_IO.Format (   self,
  aItem,
  aNestLevel = 0 
)
Format(PCB_IO self, BOARD_ITEM aItem, int aNestLevel=0)
Format(PCB_IO self, BOARD_ITEM aItem)

Definition at line 5866 of file pcbnew.py.

def pcbnew.PCB_IO.GetFileExtension (   self)
GetFileExtension(PCB_IO self) -> wxString

Definition at line 5766 of file pcbnew.py.

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

Definition at line 5827 of file pcbnew.py.

def pcbnew.PCB_IO.GetStringOutput (   self,
  doClear 
)
GetStringOutput(PCB_IO self, bool doClear) -> string

Definition at line 5874 of file pcbnew.py.

def pcbnew.PCB_IO.IsFootprintLibWritable (   self,
  aLibraryPath 
)
IsFootprintLibWritable(PCB_IO self, wxString aLibraryPath) -> bool

Definition at line 5848 of file pcbnew.py.

def pcbnew.PCB_IO.Load (   self,
  aFileName,
  aAppendToMe,
  aProperties = None 
)
Load(PCB_IO self, wxString aFileName, BOARD aAppendToMe, PROPERTIES const * aProperties=None) -> BOARD
Load(PCB_IO self, wxString aFileName, BOARD aAppendToMe) -> BOARD

Definition at line 5779 of file pcbnew.py.

def pcbnew.PCB_IO.LoadEnumeratedFootprint (   self,
  aLibraryPath,
  aFootprintName,
  aProperties = None 
)
LoadEnumeratedFootprint(PCB_IO self, wxString aLibraryPath, wxString aFootprintName, PROPERTIES const * aProperties=None) -> MODULE
LoadEnumeratedFootprint(PCB_IO self, wxString aLibraryPath, wxString aFootprintName) -> MODULE

Definition at line 5795 of file pcbnew.py.

def pcbnew.PCB_IO.Parse (   self,
  aClipboardSourceInput 
)
Parse(PCB_IO self, wxString aClipboardSourceInput) -> BOARD_ITEM

Definition at line 5884 of file pcbnew.py.

def pcbnew.PCB_IO.PluginName (   self)
PluginName(PCB_IO self) -> wxString

Definition at line 5761 of file pcbnew.py.

def pcbnew.PCB_IO.Save (   self,
  aFileName,
  aBoard,
  aProperties = None 
)
Save(PCB_IO self, wxString aFileName, BOARD aBoard, PROPERTIES const * aProperties=None)
Save(PCB_IO self, wxString aFileName, BOARD aBoard)

Definition at line 5771 of file pcbnew.py.

def pcbnew.PCB_IO.SetOutputFormatter (   self,
  aFormatter 
)
SetOutputFormatter(PCB_IO self, OUTPUTFORMATTER * aFormatter)

Definition at line 5879 of file pcbnew.py.

Member Data Documentation

pcbnew.PCB_IO.this

Definition at line 5862 of file pcbnew.py.


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