pcbnew.PCB_IO_KICAD_SEXPR Class Reference

Inheritance diagram for pcbnew.PCB_IO_KICAD_SEXPR:

Public Member Functions
	GetLibraryFileDesc (self)
	GetLibraryDesc (self)
	SaveBoard (self, aFileName, aBoard, aProperties=None)
	FormatBoardToFormatter (self, aOut, aBoard, aProperties=None)
	LoadBoard (self, aFileName, aAppendToMe, aProperties=None, aProject=None)
	DoLoad (self, aReader, aAppendToMe, aProperties, aProgressReporter, aLineCount)
	FootprintEnumerate (self, aFootprintNames, aLibraryPath, aBestEfforts, aProperties=None)
	GetEnumeratedFootprint (self, aLibraryPath, aFootprintName, aProperties=None)
	FootprintExists (self, aLibraryPath, aFootprintName, aProperties=None)
	ImportFootprint (self, aFootprintPath, aFootprintNameOut, aProperties=None)
	FootprintLoad (self, aLibraryPath, aFootprintName, aKeepUUID=False, aProperties=None)
	FootprintSave (self, aLibraryPath, aFootprint, aProperties=None)
	FootprintDelete (self, aLibraryPath, aFootprintName, aProperties=None)
	CreateLibrary (self, aLibraryPath, aProperties=None)
	DeleteLibrary (self, aLibraryPath, aProperties=None)
	IsLibraryWritable (self, aLibraryPath)
	__init__ (self, *args)
	Format (self, aItem)
	GetStringOutput (self, doClear)
	SetOutputFormatter (self, aFormatter)
	Parse (self, aClipboardSourceInput)
Public Member Functions inherited from pcbnew.PCB_IO
	__init__ (self, *args, **kwargs)
	GetBoardFileDesc (self)
	IsPCB_IO (self)
	CanReadBoard (self, aFileName)
	CanReadFootprint (self, aFileName)
	SetQueryUserCallback (self, aCallback)
	GetImportedCachedLibraryFootprints (self)
	GetLibraryTimestamp (self, aLibraryPath)
	CachesEnumeratedFootprints (self)
	ClearCachedFootprints (self, aLibraryPath)
	GetLibraryOptions (self, aListToAppendTo)
	footprintPyEnumerate (self, aLibraryPath, aExitOnError)
	FootprintLibCreate (self, aLibraryPath, aProperties=None)
	FootprintLibDelete (self, aLibraryPath, aProperties=None)
	IsFootprintLibWritable (self, aLibraryPath)

Properties
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
Properties inherited from pcbnew.PCB_IO
	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 8302 of file pcbnew.py.

Constructor & Destructor Documentation

__init__()

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

Definition at line 8372 of file pcbnew.py.

Member Function Documentation

CreateLibrary()

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

DeleteLibrary()

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

DoLoad()

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

FootprintDelete()

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

FootprintEnumerate()

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

FootprintExists()

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

FootprintLoad()

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

FootprintSave()

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

Format()

pcbnew.PCB_IO_KICAD_SEXPR.Format	(		self,
			aItem )

Format(PCB_IO_KICAD_SEXPR self, BOARD_ITEM aItem)

Definition at line 8377 of file pcbnew.py.

FormatBoardToFormatter()

pcbnew.PCB_IO_KICAD_SEXPR.FormatBoardToFormatter	(		self,
			aOut,
			aBoard,
			aProperties = None )

FormatBoardToFormatter(PCB_IO_KICAD_SEXPR self, OUTPUTFORMATTER aOut, BOARD aBoard, str_utf8_Map aProperties=None)

Definition at line 8320 of file pcbnew.py.

GetEnumeratedFootprint()

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

GetLibraryDesc()

pcbnew.PCB_IO_KICAD_SEXPR.GetLibraryDesc

(

self

)

GetLibraryDesc(PCB_IO_KICAD_SEXPR self) -> IO_BASE::IO_FILE_DESC const

Definition at line 8312 of file pcbnew.py.

GetLibraryFileDesc()

pcbnew.PCB_IO_KICAD_SEXPR.GetLibraryFileDesc

(

self

)

GetLibraryFileDesc(PCB_IO_KICAD_SEXPR self) -> IO_BASE::IO_FILE_DESC const

Definition at line 8308 of file pcbnew.py.

GetStringOutput()

pcbnew.PCB_IO_KICAD_SEXPR.GetStringOutput	(		self,
			doClear )

GetStringOutput(PCB_IO_KICAD_SEXPR self, bool doClear) -> string

Definition at line 8381 of file pcbnew.py.

ImportFootprint()

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

IsLibraryWritable()

pcbnew.PCB_IO_KICAD_SEXPR.IsLibraryWritable	(		self,
			aLibraryPath )

IsLibraryWritable(PCB_IO_KICAD_SEXPR self, wxString aLibraryPath) -> bool

Definition at line 8368 of file pcbnew.py.

LoadBoard()

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

Parse()

pcbnew.PCB_IO_KICAD_SEXPR.Parse	(		self,
			aClipboardSourceInput )

Parse(PCB_IO_KICAD_SEXPR self, wxString aClipboardSourceInput) -> BOARD_ITEM

Definition at line 8389 of file pcbnew.py.

SaveBoard()

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

SetOutputFormatter()

pcbnew.PCB_IO_KICAD_SEXPR.SetOutputFormatter	(		self,
			aFormatter )

SetOutputFormatter(PCB_IO_KICAD_SEXPR self, OUTPUTFORMATTER aFormatter)

Definition at line 8385 of file pcbnew.py.

Property Documentation

thisown

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

---

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

• pcbnew.py