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

Public Member Functions

def GetLibraryFileDesc (self)
 
def GetLibraryDesc (self)
 
def SaveBoard (self, aFileName, aBoard, aProperties=None)
 
def LoadBoard (self, aFileName, aAppendToMe, aProperties=None, aProject=None)
 
def DoLoad (self, aReader, aAppendToMe, aProperties, aProgressReporter, aLineCount)
 
def FootprintEnumerate (self, aFootprintNames, aLibraryPath, aBestEfforts, aProperties=None)
 
def GetEnumeratedFootprint (self, aLibraryPath, aFootprintName, aProperties=None)
 
def FootprintExists (self, aLibraryPath, aFootprintName, aProperties=None)
 
def ImportFootprint (self, aFootprintPath, aFootprintNameOut, aProperties=None)
 
def FootprintLoad (self, aLibraryPath, aFootprintName, aKeepUUID=False, aProperties=None)
 
def FootprintSave (self, aLibraryPath, aFootprint, aProperties=None)
 
def FootprintDelete (self, aLibraryPath, aFootprintName, aProperties=None)
 
def CreateLibrary (self, aLibraryPath, aProperties=None)
 
def DeleteLibrary (self, aLibraryPath, aProperties=None)
 
def IsLibraryWritable (self, aLibraryPath)
 
def __init__ (self, *args)
 
def Format (self, aItem)
 
def GetStringOutput (self, doClear)
 
def SetOutputFormatter (self, aFormatter)
 
def Parse (self, aClipboardSourceInput)
 
- Public Member Functions inherited from pcbnew.PCB_IO
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")
 
- Properties inherited from pcbnew.PCB_IO
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_KICAD_SEXPR class.

Definition at line 7835 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

def pcbnew.PCB_IO_KICAD_SEXPR.__init__ (   self,
args 
)
__init__(PCB_IO_KICAD_SEXPR self, int aControlFlags=(CTL_OMIT_INITIAL_COMMENTS|CTL_OMIT_FOOTPRINT_VERSION)) -> PCB_IO_KICAD_SEXPR

Reimplemented from pcbnew.PCB_IO.

Definition at line 7901 of file pcbnew.py.

Member Function Documentation

◆ CreateLibrary()

def pcbnew.PCB_IO_KICAD_SEXPR.CreateLibrary (   self,
  aLibraryPath,
  aProperties = None 
)
CreateLibrary(PCB_IO_KICAD_SEXPR self, wxString aLibraryPath, str_utf8_Map aProperties=None)

Definition at line 7889 of file pcbnew.py.

Here is the caller graph for this function:

◆ DeleteLibrary()

def pcbnew.PCB_IO_KICAD_SEXPR.DeleteLibrary (   self,
  aLibraryPath,
  aProperties = None 
)
DeleteLibrary(PCB_IO_KICAD_SEXPR self, wxString aLibraryPath, str_utf8_Map aProperties=None) -> bool

Definition at line 7893 of file pcbnew.py.

Here is the caller graph for this function:

◆ DoLoad()

def pcbnew.PCB_IO_KICAD_SEXPR.DoLoad (   self,
  aReader,
  aAppendToMe,
  aProperties,
  aProgressReporter,
  aLineCount 
)
DoLoad(PCB_IO_KICAD_SEXPR self, LINE_READER aReader, BOARD aAppendToMe, str_utf8_Map aProperties, PROGRESS_REPORTER * aProgressReporter, unsigned int aLineCount) -> BOARD

Definition at line 7857 of file pcbnew.py.

◆ FootprintDelete()

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

Reimplemented from pcbnew.PCB_IO.

Definition at line 7885 of file pcbnew.py.

◆ FootprintEnumerate()

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

Reimplemented from pcbnew.PCB_IO.

Definition at line 7861 of file pcbnew.py.

◆ FootprintExists()

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

Reimplemented from pcbnew.PCB_IO.

Definition at line 7869 of file pcbnew.py.

◆ FootprintLoad()

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

Reimplemented from pcbnew.PCB_IO.

Definition at line 7877 of file pcbnew.py.

◆ FootprintSave()

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

Reimplemented from pcbnew.PCB_IO.

Definition at line 7881 of file pcbnew.py.

◆ Format()

def pcbnew.PCB_IO_KICAD_SEXPR.Format (   self,
  aItem 
)
Format(PCB_IO_KICAD_SEXPR self, BOARD_ITEM aItem)

Definition at line 7906 of file pcbnew.py.

◆ GetEnumeratedFootprint()

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

Reimplemented from pcbnew.PCB_IO.

Definition at line 7865 of file pcbnew.py.

◆ GetLibraryDesc()

def pcbnew.PCB_IO_KICAD_SEXPR.GetLibraryDesc (   self)
GetLibraryDesc(PCB_IO_KICAD_SEXPR self) -> IO_BASE::IO_FILE_DESC const

Definition at line 7845 of file pcbnew.py.

◆ GetLibraryFileDesc()

def pcbnew.PCB_IO_KICAD_SEXPR.GetLibraryFileDesc (   self)
GetLibraryFileDesc(PCB_IO_KICAD_SEXPR self) -> IO_BASE::IO_FILE_DESC const

Definition at line 7841 of file pcbnew.py.

◆ GetStringOutput()

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

Definition at line 7910 of file pcbnew.py.

◆ ImportFootprint()

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

Reimplemented from pcbnew.PCB_IO.

Definition at line 7873 of file pcbnew.py.

◆ IsLibraryWritable()

def pcbnew.PCB_IO_KICAD_SEXPR.IsLibraryWritable (   self,
  aLibraryPath 
)
IsLibraryWritable(PCB_IO_KICAD_SEXPR self, wxString aLibraryPath) -> bool

Definition at line 7897 of file pcbnew.py.

Here is the caller graph for this function:

◆ LoadBoard()

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

Reimplemented from pcbnew.PCB_IO.

Definition at line 7853 of file pcbnew.py.

◆ Parse()

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

Definition at line 7918 of file pcbnew.py.

◆ SaveBoard()

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

Reimplemented from pcbnew.PCB_IO.

Definition at line 7849 of file pcbnew.py.

◆ SetOutputFormatter()

def pcbnew.PCB_IO_KICAD_SEXPR.SetOutputFormatter (   self,
  aFormatter 
)
SetOutputFormatter(PCB_IO_KICAD_SEXPR self, OUTPUTFORMATTER aFormatter)

Definition at line 7914 of file pcbnew.py.

Property Documentation

◆ thisown

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

Definition at line 7838 of file pcbnew.py.


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