pcbnew.PCB_IO Class Reference

Inheritance diagram for pcbnew.PCB_IO:

Public Member Functions
	__init__ (self, *args, **kwargs)
	GetBoardFileDesc (self)
	CanReadBoard (self, aFileName)
	CanReadFootprint (self, aFileName)
	SetQueryUserCallback (self, aCallback)
	LoadBoard (self, aFileName, aAppendToMe, aProperties=None, aProject=None)
	GetImportedCachedLibraryFootprints (self)
	SaveBoard (self, aFileName, aBoard, aProperties=None)
	FootprintEnumerate (self, aFootprintNames, aLibraryPath, aBestEfforts, aProperties=None)
	GetLibraryTimestamp (self, aLibraryPath)
	ImportFootprint (self, aFootprintPath, aFootprintNameOut, aProperties=None)
	FootprintLoad (self, aLibraryPath, aFootprintName, aKeepUUID=False, aProperties=None)
	GetEnumeratedFootprint (self, aLibraryPath, aFootprintName, aProperties=None)
	FootprintExists (self, aLibraryPath, aFootprintName, aProperties=None)
	FootprintSave (self, aLibraryPath, aFootprint, aProperties=None)
	FootprintDelete (self, aLibraryPath, aFootprintName, aProperties=None)
	GetLibraryOptions (self, aListToAppendTo)
	footprintPyEnumerate (self, aLibraryPath, aExitOnError)
	FootprintEnumerate (self, libname)
	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")

Detailed Description

Proxy of C++ PCB_IO class.

Definition at line 8061 of file pcbnew.py.

Constructor & Destructor Documentation

__init__()

pcbnew.PCB_IO.__init__	(		self,
		*	args,
		**	kwargs )

Definition at line 8066 of file pcbnew.py.

Member Function Documentation

CanReadBoard()

pcbnew.PCB_IO.CanReadBoard	(		self,
			aFileName )

CanReadBoard(PCB_IO self, wxString aFileName) -> bool

Definition at line 8074 of file pcbnew.py.

CanReadFootprint()

pcbnew.PCB_IO.CanReadFootprint	(		self,
			aFileName )

CanReadFootprint(PCB_IO self, wxString aFileName) -> bool

Definition at line 8078 of file pcbnew.py.

FootprintDelete()

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

FootprintDelete(PCB_IO self, wxString aLibraryPath, wxString aFootprintName, str_utf8_Map aProperties=None)

Reimplemented in pcbnew.PCB_IO_KICAD_SEXPR.

Definition at line 8126 of file pcbnew.py.

FootprintEnumerate() [1/2]

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

FootprintEnumerate(PCB_IO self, wxArrayString & aFootprintNames, wxString aLibraryPath, bool aBestEfforts, str_utf8_Map aProperties=None)

Reimplemented in pcbnew.PCB_IO_KICAD_SEXPR.

Definition at line 8098 of file pcbnew.py.

FootprintEnumerate() [2/2]

pcbnew.PCB_IO.FootprintEnumerate	(		self,
			libname )

Reimplemented in pcbnew.PCB_IO_KICAD_SEXPR.

Definition at line 8139 of file pcbnew.py.

FootprintExists()

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

FootprintExists(PCB_IO self, wxString aLibraryPath, wxString aFootprintName, str_utf8_Map aProperties=None) -> bool

Reimplemented in pcbnew.PCB_IO_KICAD_SEXPR.

Definition at line 8118 of file pcbnew.py.

FootprintLibCreate()

pcbnew.PCB_IO.FootprintLibCreate	(		self,
			aLibraryPath,
			aProperties = None )

Definition at line 8143 of file pcbnew.py.

FootprintLibDelete()

pcbnew.PCB_IO.FootprintLibDelete	(		self,
			aLibraryPath,
			aProperties = None )

Definition at line 8147 of file pcbnew.py.

FootprintLoad()

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

FootprintLoad(PCB_IO self, wxString aLibraryPath, wxString aFootprintName, bool aKeepUUID=False, str_utf8_Map aProperties=None) -> FOOTPRINT

Reimplemented in pcbnew.PCB_IO_KICAD_SEXPR.

Definition at line 8110 of file pcbnew.py.

footprintPyEnumerate()

pcbnew.PCB_IO.footprintPyEnumerate	(		self,
			aLibraryPath,
			aExitOnError )

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

Definition at line 8135 of file pcbnew.py.

FootprintSave()

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

FootprintSave(PCB_IO self, wxString aLibraryPath, FOOTPRINT aFootprint, str_utf8_Map aProperties=None)

Reimplemented in pcbnew.PCB_IO_KICAD_SEXPR.

Definition at line 8122 of file pcbnew.py.

GetBoardFileDesc()

pcbnew.PCB_IO.GetBoardFileDesc

(

self

)

GetBoardFileDesc(PCB_IO self) -> IO_BASE::IO_FILE_DESC const

Definition at line 8070 of file pcbnew.py.

GetEnumeratedFootprint()

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

GetEnumeratedFootprint(PCB_IO self, wxString aLibraryPath, wxString aFootprintName, str_utf8_Map aProperties=None) -> FOOTPRINT

Reimplemented in pcbnew.PCB_IO_KICAD_SEXPR.

Definition at line 8114 of file pcbnew.py.

GetImportedCachedLibraryFootprints()

pcbnew.PCB_IO.GetImportedCachedLibraryFootprints

(

self

)

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

Definition at line 8090 of file pcbnew.py.

GetLibraryOptions()

pcbnew.PCB_IO.GetLibraryOptions	(		self,
			aListToAppendTo )

GetLibraryOptions(PCB_IO self, str_utf8_Map aListToAppendTo)

Definition at line 8130 of file pcbnew.py.

GetLibraryTimestamp()

pcbnew.PCB_IO.GetLibraryTimestamp	(		self,
			aLibraryPath )

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

Definition at line 8102 of file pcbnew.py.

ImportFootprint()

pcbnew.PCB_IO.ImportFootprint	(		self,
			aFootprintPath,
			aFootprintNameOut,
			aProperties = None )

ImportFootprint(PCB_IO self, wxString aFootprintPath, wxString aFootprintNameOut, str_utf8_Map aProperties=None) -> FOOTPRINT

Reimplemented in pcbnew.PCB_IO_KICAD_SEXPR.

Definition at line 8106 of file pcbnew.py.

IsFootprintLibWritable()

pcbnew.PCB_IO.IsFootprintLibWritable	(		self,
			aLibraryPath )

Definition at line 8151 of file pcbnew.py.

LoadBoard()

pcbnew.PCB_IO.LoadBoard	(		self,
			aFileName,
			aAppendToMe,
			aProperties = None,
			aProject = None )

LoadBoard(PCB_IO self, wxString aFileName, BOARD aAppendToMe, str_utf8_Map aProperties=None, PROJECT * aProject=None) -> BOARD

Reimplemented in pcbnew.PCB_IO_KICAD_SEXPR.

Definition at line 8086 of file pcbnew.py.

SaveBoard()

pcbnew.PCB_IO.SaveBoard	(		self,
			aFileName,
			aBoard,
			aProperties = None )

SaveBoard(PCB_IO self, wxString aFileName, BOARD aBoard, str_utf8_Map aProperties=None)

Reimplemented in pcbnew.PCB_IO_KICAD_SEXPR.

Definition at line 8094 of file pcbnew.py.

SetQueryUserCallback()

pcbnew.PCB_IO.SetQueryUserCallback	(		self,
			aCallback )

SetQueryUserCallback(PCB_IO self, std::function< bool (wxString,int,wxString,wxString) > aCallback)

Definition at line 8082 of file pcbnew.py.

Property Documentation

thisown

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

static

Definition at line 8064 of file pcbnew.py.

---

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

• pcbnew.py