pcbnew.PCB_PLUGIN Class Reference

Inheritance diagram for pcbnew.PCB_PLUGIN:

Public Member Functions
def	Save (self, aFileName, aBoard, aProperties=None)
def	Load (self, aFileName, aAppendToMe, aProperties=None, aProject=None, aProgressReporter=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	FootprintLoad (self, aLibraryPath, aFootprintName, aKeepUUID=False, 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	__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	SetQueryUserCallback (self, aCallback)
def	Load (self, aFileName, aAppendToMe, aProperties=None, aProject=None, aProgressReporter=None)
def	GetImportedCachedLibraryFootprints (self)
def	Save (self, aFileName, aBoard, aProperties=None)
def	FootprintEnumerate (self, aFootprintNames, aLibraryPath, aBestEfforts, aProperties=None)
def	GetLibraryTimestamp (self, aLibraryPath)
def	PrefetchLib (self, aLibraryPath, 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	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)

Properties
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
Properties inherited from pcbnew.PLUGIN
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

Detailed Description

Proxy of C++ PCB_PLUGIN class.

Definition at line 8006 of file pcbnew.py.

Constructor & Destructor Documentation

__init__()

def pcbnew.PCB_PLUGIN.__init__	(		self,
		*	args
	)

__init__(PCB_PLUGIN self, int aControlFlags=((1 << 3)|(1 << 8))) -> PCB_PLUGIN

Reimplemented from pcbnew.PLUGIN.

Definition at line 8056 of file pcbnew.py.

Member Function Documentation

DoLoad()

def pcbnew.PCB_PLUGIN.DoLoad	(		self,
			aReader,
			aAppendToMe,
			aProperties,
			aProgressReporter,
			aLineCount
	)

DoLoad(PCB_PLUGIN self, LINE_READER aReader, BOARD aAppendToMe, STRING_UTF8_MAP const * aProperties, PROGRESS_REPORTER * aProgressReporter, unsigned int aLineCount) -> BOARD

Definition at line 8020 of file pcbnew.py.

FootprintDelete()

def pcbnew.PCB_PLUGIN.FootprintDelete	(		self,
			aLibraryPath,
			aFootprintName,
			aProperties = None
	)

FootprintDelete(PCB_PLUGIN self, wxString aLibraryPath, wxString aFootprintName, STRING_UTF8_MAP const * aProperties=None)

Reimplemented from pcbnew.PLUGIN.

Definition at line 8044 of file pcbnew.py.

FootprintEnumerate()

def pcbnew.PCB_PLUGIN.FootprintEnumerate	(		self,
			aFootprintNames,
			aLibraryPath,
			aBestEfforts,
			aProperties = None
	)

FootprintEnumerate(PCB_PLUGIN self, wxArrayString & aFootprintNames, wxString aLibraryPath, bool aBestEfforts, STRING_UTF8_MAP const * aProperties=None)

Reimplemented from pcbnew.PLUGIN.

Definition at line 8024 of file pcbnew.py.

FootprintExists()

def pcbnew.PCB_PLUGIN.FootprintExists	(		self,
			aLibraryPath,
			aFootprintName,
			aProperties = None
	)

FootprintExists(PCB_PLUGIN self, wxString aLibraryPath, wxString aFootprintName, STRING_UTF8_MAP const * aProperties=None) -> bool

Reimplemented from pcbnew.PLUGIN.

Definition at line 8032 of file pcbnew.py.

FootprintLibCreate()

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

FootprintLibCreate(PCB_PLUGIN self, wxString aLibraryPath, STRING_UTF8_MAP const * aProperties=None)

Reimplemented from pcbnew.PLUGIN.

Definition at line 8048 of file pcbnew.py.

FootprintLibDelete()

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

FootprintLibDelete(PCB_PLUGIN self, wxString aLibraryPath, STRING_UTF8_MAP const * aProperties=None) -> bool

Reimplemented from pcbnew.PLUGIN.

Definition at line 8052 of file pcbnew.py.

FootprintLoad()

def pcbnew.PCB_PLUGIN.FootprintLoad	(		self,
			aLibraryPath,
			aFootprintName,
			aKeepUUID = False,
			aProperties = None
	)

FootprintLoad(PCB_PLUGIN self, wxString aLibraryPath, wxString aFootprintName, bool aKeepUUID=False, STRING_UTF8_MAP const * aProperties=None) -> FOOTPRINT

Reimplemented from pcbnew.PLUGIN.

Definition at line 8036 of file pcbnew.py.

FootprintSave()

def pcbnew.PCB_PLUGIN.FootprintSave	(		self,
			aLibraryPath,
			aFootprint,
			aProperties = None
	)

FootprintSave(PCB_PLUGIN self, wxString aLibraryPath, FOOTPRINT aFootprint, STRING_UTF8_MAP const * aProperties=None)

Reimplemented from pcbnew.PLUGIN.

Definition at line 8040 of file pcbnew.py.

Format()

def pcbnew.PCB_PLUGIN.Format	(		self,
			aItem,
			aNestLevel = 0
	)

Format(PCB_PLUGIN self, BOARD_ITEM aItem, int aNestLevel=0)

Definition at line 8061 of file pcbnew.py.

GetEnumeratedFootprint()

def pcbnew.PCB_PLUGIN.GetEnumeratedFootprint	(		self,
			aLibraryPath,
			aFootprintName,
			aProperties = None
	)

GetEnumeratedFootprint(PCB_PLUGIN self, wxString aLibraryPath, wxString aFootprintName, STRING_UTF8_MAP const * aProperties=None) -> FOOTPRINT

Reimplemented from pcbnew.PLUGIN.

Definition at line 8028 of file pcbnew.py.

GetStringOutput()

def pcbnew.PCB_PLUGIN.GetStringOutput	(		self,
			doClear
	)

GetStringOutput(PCB_PLUGIN self, bool doClear) -> string

Definition at line 8065 of file pcbnew.py.

Load()

def pcbnew.PCB_PLUGIN.Load	(		self,
			aFileName,
			aAppendToMe,
			aProperties = None,
			aProject = None,
			aProgressReporter = None
	)

Load(PCB_PLUGIN self, wxString aFileName, BOARD aAppendToMe, STRING_UTF8_MAP const * aProperties=None, PROJECT * aProject=None, PROGRESS_REPORTER * aProgressReporter=None) -> BOARD

Reimplemented from pcbnew.PLUGIN.

Definition at line 8016 of file pcbnew.py.

Parse()

def pcbnew.PCB_PLUGIN.Parse	(		self,
			aClipboardSourceInput
	)

Parse(PCB_PLUGIN self, wxString aClipboardSourceInput) -> BOARD_ITEM

Definition at line 8073 of file pcbnew.py.

Save()

def pcbnew.PCB_PLUGIN.Save	(		self,
			aFileName,
			aBoard,
			aProperties = None
	)

Save(PCB_PLUGIN self, wxString aFileName, BOARD aBoard, STRING_UTF8_MAP const * aProperties=None)

Reimplemented from pcbnew.PLUGIN.

Definition at line 8012 of file pcbnew.py.

SetOutputFormatter()

def pcbnew.PCB_PLUGIN.SetOutputFormatter	(		self,
			aFormatter
	)

SetOutputFormatter(PCB_PLUGIN self, OUTPUTFORMATTER aFormatter)

Definition at line 8069 of file pcbnew.py.

Property Documentation

thisown

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

static

Definition at line 8009 of file pcbnew.py.

---

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

• pcbnew.py