pcbnew.PLUGIN Class Reference

Inheritance diagram for pcbnew.PLUGIN:

Public Member Functions
def	__init__ (self, *args, **kwargs)
"wxString const"	PluginName (self)
"wxString const"	GetFileExtension (self)
"BOARD *"	Load (self, "wxString" aFileName, "BOARD" aAppendToMe, "PROPERTIES const *" aProperties=None, "PROJECT *" aProject=None, "PROGRESS_REPORTER *" aProgressReporter=None)
"std::vector< FOOTPRINT *,std::allocator< FOOTPRINT * > >"	GetImportedCachedLibraryFootprints (self)
"void"	Save (self, "wxString" aFileName, "BOARD" aBoard, "PROPERTIES const *" aProperties=None)
"void"	FootprintEnumerate (self, "wxArrayString &" aFootprintNames, "wxString" aLibraryPath, "bool" aBestEfforts, "PROPERTIES const *" aProperties=None)
"long long"	GetLibraryTimestamp (self, "wxString" aLibraryPath)
"void"	PrefetchLib (self, "wxString" aLibraryPath, "PROPERTIES const *" aProperties=None)
"FOOTPRINT *"	FootprintLoad (self, "wxString" aLibraryPath, "wxString" aFootprintName, "bool" aKeepUUID=False, "PROPERTIES const *" aProperties=None)
"FOOTPRINT const *"	GetEnumeratedFootprint (self, "wxString" aLibraryPath, "wxString" aFootprintName, "PROPERTIES const *" aProperties=None)
"bool"	FootprintExists (self, "wxString" aLibraryPath, "wxString" aFootprintName, "PROPERTIES const *" aProperties=None)
"void"	FootprintSave (self, "wxString" aLibraryPath, "FOOTPRINT" aFootprint, "PROPERTIES const *" aProperties=None)
"void"	FootprintDelete (self, "wxString" aLibraryPath, "wxString" aFootprintName, "PROPERTIES const *" aProperties=None)
"void"	FootprintLibCreate (self, "wxString" aLibraryPath, "PROPERTIES const *" aProperties=None)
"bool"	FootprintLibDelete (self, "wxString" aLibraryPath, "PROPERTIES const *" aProperties=None)
"bool"	IsFootprintLibWritable (self, "wxString" aLibraryPath)
"void"	FootprintLibOptions (self, "PROPERTIES *" aListToAppendTo)
"wxArrayString"	footprintPyEnumerate (self, "wxString" aLibraryPath, "bool" aExitOnError)
def	FootprintEnumerate (self, libname)

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

Detailed Description

Proxy of C++ PLUGIN class.

Definition at line 5850 of file pcbnew.py.

Constructor & Destructor Documentation

__init__()

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

Reimplemented in pcbnew.PCB_PLUGIN.

Definition at line 5855 of file pcbnew.py.

Member Function Documentation

FootprintDelete()

"void" pcbnew.PLUGIN.FootprintDelete	(		self,
		"wxString"	aLibraryPath,
		"wxString"	aFootprintName,
		"PROPERTIES const *"	aProperties = None
	)

FootprintDelete(PLUGIN self, wxString aLibraryPath, wxString aFootprintName, PROPERTIES const * aProperties=None)

Reimplemented in pcbnew.PCB_PLUGIN.

Definition at line 5907 of file pcbnew.py.

FootprintEnumerate() [1/2]

"void" pcbnew.PLUGIN.FootprintEnumerate	(		self,
		"wxArrayString &"	aFootprintNames,
		"wxString"	aLibraryPath,
		"bool"	aBestEfforts,
		"PROPERTIES const *"	aProperties = None
	)

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

Reimplemented in pcbnew.PCB_PLUGIN.

Definition at line 5879 of file pcbnew.py.

FootprintEnumerate() [2/2]

def pcbnew.PLUGIN.FootprintEnumerate	(		self,
			libname
	)

Reimplemented in pcbnew.PCB_PLUGIN.

Definition at line 5932 of file pcbnew.py.

FootprintExists()

"bool" pcbnew.PLUGIN.FootprintExists	(		self,
		"wxString"	aLibraryPath,
		"wxString"	aFootprintName,
		"PROPERTIES const *"	aProperties = None
	)

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

Reimplemented in pcbnew.PCB_PLUGIN.

Definition at line 5899 of file pcbnew.py.

FootprintLibCreate()

"void" pcbnew.PLUGIN.FootprintLibCreate	(		self,
		"wxString"	aLibraryPath,
		"PROPERTIES const *"	aProperties = None
	)

FootprintLibCreate(PLUGIN self, wxString aLibraryPath, PROPERTIES const * aProperties=None)

Reimplemented in pcbnew.PCB_PLUGIN.

Definition at line 5911 of file pcbnew.py.

FootprintLibDelete()

"bool" pcbnew.PLUGIN.FootprintLibDelete	(		self,
		"wxString"	aLibraryPath,
		"PROPERTIES const *"	aProperties = None
	)

FootprintLibDelete(PLUGIN self, wxString aLibraryPath, PROPERTIES const * aProperties=None) -> bool

Reimplemented in pcbnew.PCB_PLUGIN.

Definition at line 5915 of file pcbnew.py.

FootprintLibOptions()

"void" pcbnew.PLUGIN.FootprintLibOptions	(		self,
		"PROPERTIES *"	aListToAppendTo
	)

FootprintLibOptions(PLUGIN self, PROPERTIES * aListToAppendTo)

Definition at line 5923 of file pcbnew.py.

FootprintLoad()

"FOOTPRINT *" pcbnew.PLUGIN.FootprintLoad	(		self,
		"wxString"	aLibraryPath,
		"wxString"	aFootprintName,
		"bool"	aKeepUUID = False,
		"PROPERTIES const *"	aProperties = None
	)

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

Reimplemented in pcbnew.PCB_PLUGIN.

Definition at line 5891 of file pcbnew.py.

footprintPyEnumerate()

"wxArrayString" pcbnew.PLUGIN.footprintPyEnumerate	(		self,
		"wxString"	aLibraryPath,
		"bool"	aExitOnError
	)

footprintPyEnumerate(PLUGIN self, wxString aLibraryPath, bool aExitOnError) -> wxArrayString

Definition at line 5928 of file pcbnew.py.

Here is the caller graph for this function:

FootprintSave()

"void" pcbnew.PLUGIN.FootprintSave	(		self,
		"wxString"	aLibraryPath,
		"FOOTPRINT"	aFootprint,
		"PROPERTIES const *"	aProperties = None
	)

FootprintSave(PLUGIN self, wxString aLibraryPath, FOOTPRINT aFootprint, PROPERTIES const * aProperties=None)

Reimplemented in pcbnew.PCB_PLUGIN.

Definition at line 5903 of file pcbnew.py.

GetEnumeratedFootprint()

"FOOTPRINT const *" pcbnew.PLUGIN.GetEnumeratedFootprint	(		self,
		"wxString"	aLibraryPath,
		"wxString"	aFootprintName,
		"PROPERTIES const *"	aProperties = None
	)

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

Reimplemented in pcbnew.PCB_PLUGIN.

Definition at line 5895 of file pcbnew.py.

GetFileExtension()

"wxString const" pcbnew.PLUGIN.GetFileExtension

(

self

)

GetFileExtension(PLUGIN self) -> wxString

Reimplemented in pcbnew.PCB_PLUGIN.

Definition at line 5863 of file pcbnew.py.

GetImportedCachedLibraryFootprints()

"std.vector< FOOTPRINT *,std.allocator< FOOTPRINT * > >" pcbnew.PLUGIN.GetImportedCachedLibraryFootprints

(

self

)

GetImportedCachedLibraryFootprints(PLUGIN self) -> std::vector< FOOTPRINT *,std::allocator< FOOTPRINT * > >

Definition at line 5871 of file pcbnew.py.

GetLibraryTimestamp()

"long long" pcbnew.PLUGIN.GetLibraryTimestamp	(		self,
		"wxString"	aLibraryPath
	)

GetLibraryTimestamp(PLUGIN self, wxString aLibraryPath) -> long long

Reimplemented in pcbnew.PCB_PLUGIN.

Definition at line 5883 of file pcbnew.py.

IsFootprintLibWritable()

"bool" pcbnew.PLUGIN.IsFootprintLibWritable	(		self,
		"wxString"	aLibraryPath
	)

IsFootprintLibWritable(PLUGIN self, wxString aLibraryPath) -> bool

Reimplemented in pcbnew.PCB_PLUGIN.

Definition at line 5919 of file pcbnew.py.

Load()

"BOARD *" pcbnew.PLUGIN.Load	(		self,
		"wxString"	aFileName,
		"BOARD"	aAppendToMe,
		"PROPERTIES const *"	aProperties = None,
		"PROJECT *"	aProject = None,
		"PROGRESS_REPORTER *"	aProgressReporter = None
	)

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

Reimplemented in pcbnew.PCB_PLUGIN.

Definition at line 5867 of file pcbnew.py.

PluginName()

"wxString const" pcbnew.PLUGIN.PluginName

(

self

)

PluginName(PLUGIN self) -> wxString

Reimplemented in pcbnew.PCB_PLUGIN.

Definition at line 5859 of file pcbnew.py.

PrefetchLib()

"void" pcbnew.PLUGIN.PrefetchLib	(		self,
		"wxString"	aLibraryPath,
		"PROPERTIES const *"	aProperties = None
	)

PrefetchLib(PLUGIN self, wxString aLibraryPath, PROPERTIES const * aProperties=None)

Definition at line 5887 of file pcbnew.py.

Save()

"void" pcbnew.PLUGIN.Save	(		self,
		"wxString"	aFileName,
		"BOARD"	aBoard,
		"PROPERTIES const *"	aProperties = None
	)

Save(PLUGIN self, wxString aFileName, BOARD aBoard, PROPERTIES const * aProperties=None)

Reimplemented in pcbnew.PCB_PLUGIN.

Definition at line 5875 of file pcbnew.py.

Property Documentation

thisown

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

static

Definition at line 5853 of file pcbnew.py.

---

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

• pcbnew.py