A base class that BOARD loading and saving plugins should derive from. More...

#include <pcb_io.h>

Inheritance diagram for PCB_IO:

Public Member Functions
virtual const IO_BASE::IO_FILE_DESC	GetBoardFileDesc () const
	Returns board file description for the PCB_IO.

virtual bool	CanReadBoard (const wxString &aFileName) const
	Checks if this PCB_IO can read the specified board file.

virtual bool	CanReadFootprint (const wxString &aFileName) const
	Checks if this PCB_IO can read a footprint from specified file or directory.

virtual void	SetQueryUserCallback (std::function< bool(wxString aTitle, int aIcon, wxString aMessage, wxString aAction)> aCallback)
	Registers a KIDIALOG callback for collecting info from the user.

virtual BOARD *	LoadBoard (const wxString &aFileName, BOARD aAppendToMe, const STRING_UTF8_MAP aProperties=nullptr, PROJECT *aProject=nullptr)
	Load information from some input file format that this PCB_IO implementation knows about into either a new BOARD or an existing one.

virtual std::vector< FOOTPRINT * >	GetImportedCachedLibraryFootprints ()
	Return a container with the cached library footprints generated in the last call to Load.

virtual void	SaveBoard (const wxString &aFileName, BOARD aBoard, const STRING_UTF8_MAP aProperties=nullptr)
	Write aBoard to a storage file in a format that this PCB_IO implementation knows about or it can be used to write a portion of aBoard to a special kind of export file.

virtual void	FootprintEnumerate (wxArrayString &aFootprintNames, const wxString &aLibraryPath, bool aBestEfforts, const STRING_UTF8_MAP *aProperties=nullptr)
	Return a list of footprint names contained within the library at aLibraryPath.

virtual long long	GetLibraryTimestamp (const wxString &aLibraryPath) const =0
	Generate a timestamp representing all the files in the library (including the library directory).

virtual void	PrefetchLib (const wxString &aLibraryPath, const STRING_UTF8_MAP *aProperties=nullptr)
	If possible, prefetches the specified library (e.g.

virtual FOOTPRINT *	ImportFootprint (const wxString &aFootprintPath, wxString &aFootprintNameOut, const STRING_UTF8_MAP *aProperties=nullptr)
	Load a single footprint from aFootprintPath and put its name in aFootprintNameOut.

virtual FOOTPRINT *	FootprintLoad (const wxString &aLibraryPath, const wxString &aFootprintName, bool aKeepUUID=false, const STRING_UTF8_MAP *aProperties=nullptr)
	Load a footprint having aFootprintName from the aLibraryPath containing a library format that this PCB_IO knows about.

virtual const FOOTPRINT *	GetEnumeratedFootprint (const wxString &aLibraryPath, const wxString &aFootprintName, const STRING_UTF8_MAP *aProperties=nullptr)
	A version of FootprintLoad() for use after FootprintEnumerate() for more efficient cache management.

virtual bool	FootprintExists (const wxString &aLibraryPath, const wxString &aFootprintName, const STRING_UTF8_MAP *aProperties=nullptr)
	Check for the existence of a footprint.

virtual void	FootprintSave (const wxString &aLibraryPath, const FOOTPRINT aFootprint, const STRING_UTF8_MAP aProperties=nullptr)
	Write aFootprint to an existing library located at aLibraryPath.

virtual void	FootprintDelete (const wxString &aLibraryPath, const wxString &aFootprintName, const STRING_UTF8_MAP *aProperties=nullptr)
	Delete aFootprintName from the library at aLibraryPath.

virtual void	GetLibraryOptions (STRING_UTF8_MAP *aListToAppendTo) const override
	Append supported PLUGIN options to aListToAppenTo along with internationalized descriptions.

virtual	~PCB_IO ()

const wxString &	GetName () const
	Return a brief hard coded name for this IO interface.

virtual void	SetReporter (REPORTER *aReporter)
	Set an optional reporter for warnings/errors.

virtual void	SetProgressReporter (PROGRESS_REPORTER *aReporter)
	Set an optional progress reporter.

virtual const IO_FILE_DESC	GetLibraryDesc () const =0
	Get the descriptor for the library container that this IO plugin operates on.

virtual const IO_FILE_DESC	GetLibraryFileDesc () const
	Get the descriptor for the individual library elements that this IO plugin operates on.

virtual bool	CanReadLibrary (const wxString &aFileName) const
	Checks if this IO object can read the specified library file/directory.

virtual void	CreateLibrary (const wxString &aLibraryPath, const STRING_UTF8_MAP *aProperties=nullptr)
	Create a new empty library at aLibraryPath empty.

virtual bool	DeleteLibrary (const wxString &aLibraryPath, const STRING_UTF8_MAP *aProperties=nullptr)
	Delete an existing library and returns true, or if library does not exist returns false, or throws an exception if library exists but is read only or cannot be deleted for some other reason.

virtual bool	IsLibraryWritable (const wxString &aLibraryPath)
	Return true if the library at aLibraryPath is writable.

Protected Member Functions
	PCB_IO (const wxString &aName)

Protected Attributes
BOARD *	m_board
	The board BOARD being worked on, no ownership here.

const STRING_UTF8_MAP *	m_props
	Properties passed via Save() or Load(), no ownership, may be NULL.

wxString	m_name
	Name of the IO loader.

REPORTER *	m_reporter
	Reporter to log errors/warnings to, may be nullptr.

PROGRESS_REPORTER *	m_progressReporter
	Progress reporter to track the progress of the operation, may be nullptr.

Detailed Description

A base class that BOARD loading and saving plugins should derive from.

Implementations can provide either Load() or Save() functions, or both. PCB_IOs throw exceptions, so it is best that you wrap your calls to these functions in a try catch block. Plugins throw exceptions because it is illegal for them to have any user interface calls in them whatsoever, i.e. no windowing or screen printing at all.

The compiler writes the "zero argument" constructor for a PCB_IO automatically if you do not provide one. If you decide you need to provide a zero argument constructor of your own design, that is allowed. It must be public, and it is what the PCB_IO_MGR uses. Parameters may be passed into a PCB_IO via the #PROPERTIES variable for any of the public API functions which take one.

   try
   {
        PCB_IO_MGR::Load(...);
   or
        PCB_IO_MGR::Save(...);
   }
   catch( const IO_ERROR& ioe )
   {
        // grab text from ioe, show in error window.
   }

Definition at line 71 of file pcb_io.h.

Constructor & Destructor Documentation

◆ ~PCB_IO()

virtual PCB_IO::~PCB_IO ( )

inlinevirtual

Definition at line 333 of file pcb_io.h.

◆ PCB_IO()

PCB_IO::PCB_IO ( const wxString & aName )

inlineprotected

Definition at line 337 of file pcb_io.h.

Member Function Documentation

◆ CanReadBoard()

bool PCB_IO::CanReadBoard ( const wxString & aFileName ) const

virtual

Checks if this PCB_IO can read the specified board file.

If not overriden, extension check is used.

Reimplemented in PCB_IO_ALTIUM_CIRCUIT_MAKER, PCB_IO_ALTIUM_CIRCUIT_STUDIO, PCB_IO_ALTIUM_DESIGNER, PCB_IO_SOLIDWORKS, PCB_IO_CADSTAR_ARCHIVE, PCB_IO_EAGLE, PCB_IO_EASYEDA, PCB_IO_EASYEDAPRO, PCB_IO_IPC2581, PCB_IO_KICAD_LEGACY, PCB_IO_KICAD_SEXPR, and PCB_IO_PCAD.

Definition at line 43 of file pcb_io.cpp.

References GetBoardFileDesc(), and IO_BASE::IO_FILE_DESC::m_FileExtensions.

Referenced by PCB_IO_ALTIUM_CIRCUIT_MAKER::CanReadBoard(), PCB_IO_ALTIUM_CIRCUIT_STUDIO::CanReadBoard(), PCB_IO_ALTIUM_DESIGNER::CanReadBoard(), PCB_IO_SOLIDWORKS::CanReadBoard(), PCB_IO_CADSTAR_ARCHIVE::CanReadBoard(), PCB_IO_EAGLE::CanReadBoard(), PCB_IO_EASYEDA::CanReadBoard(), PCB_IO_KICAD_LEGACY::CanReadBoard(), PCB_IO_KICAD_SEXPR::CanReadBoard(), and PCB_IO_PCAD::CanReadBoard().

◆ CanReadFootprint()

bool PCB_IO::CanReadFootprint ( const wxString & aFileName ) const

virtual

Checks if this PCB_IO can read a footprint from specified file or directory.

If not overriden, extension check is used.

Reimplemented in PCB_IO_CADSTAR_ARCHIVE, PCB_IO_EAGLE, PCB_IO_EASYEDA, PCB_IO_IPC2581, and PCB_IO_KICAD_LEGACY.

Definition at line 59 of file pcb_io.cpp.

References IO_BASE::GetLibraryFileDesc(), and IO_BASE::IO_FILE_DESC::m_FileExtensions.

Referenced by PCB_IO_CADSTAR_ARCHIVE::CanReadFootprint(), and PCB_IO_KICAD_LEGACY::CanReadFootprint().

◆ CanReadLibrary()

bool IO_BASE::CanReadLibrary ( const wxString & aFileName ) const

virtualinherited

Checks if this IO object can read the specified library file/directory.

If not overriden, extension check is used.

Note: This is not a check that the file system object is readable by the user, but a check that this IO object can parse the given library.

Reimplemented in SCH_IO_ALTIUM, SCH_IO_CADSTAR_ARCHIVE, SCH_IO_EAGLE, SCH_IO_EASYEDA, SCH_IO_KICAD_LEGACY, PCB_IO_ALTIUM_DESIGNER, PCB_IO_CADSTAR_ARCHIVE, PCB_IO_EAGLE, PCB_IO_EASYEDA, and PCB_IO_IPC2581.

Definition at line 67 of file io_base.cpp.

References IO_BASE::GetLibraryDesc(), IO_BASE::IO_FILE_DESC::m_ExtensionsInDir, IO_BASE::IO_FILE_DESC::m_FileExtensions, and IO_BASE::IO_FILE_DESC::m_IsFile.

Referenced by SCH_IO_ALTIUM::CanReadLibrary(), SCH_IO_CADSTAR_ARCHIVE::CanReadLibrary(), SCH_IO_EAGLE::CanReadLibrary(), SCH_IO_KICAD_LEGACY::CanReadLibrary(), PCB_IO_ALTIUM_DESIGNER::CanReadLibrary(), PCB_IO_CADSTAR_ARCHIVE::CanReadLibrary(), and PCB_IO_EAGLE::CanReadLibrary().

◆ CreateLibrary()

void IO_BASE::CreateLibrary	(	const wxString &	aLibraryPath,
		const STRING_UTF8_MAP *	aProperties = `nullptr`
	)

virtualinherited

Create a new empty library at aLibraryPath empty.

It is an error to attempt to create an existing library or to attempt to create on a "read only" location.

Parameters

aLibraryPath	is a locator for the "library", usually a directory, file, or URL containing several elements.
aProperties	is an associative array that can be used to tell the library create function anything special, because it can take any number of additional named tuning arguments that the IO is known to support. The caller continues to own this object (IO may not delete it), and IOs should expect it to be optionally NULL.

Exceptions

IO_ERROR if there is a problem finding the library, or creating it.

Reimplemented in SCH_IO_KICAD_LEGACY, SCH_IO_KICAD_SEXPR, and PCB_IO_KICAD_SEXPR.

Definition at line 44 of file io_base.cpp.

References NOT_IMPLEMENTED.

◆ DeleteLibrary()

bool IO_BASE::DeleteLibrary	(	const wxString &	aLibraryPath,
		const STRING_UTF8_MAP *	aProperties = `nullptr`
	)

virtualinherited

Delete an existing library and returns true, or if library does not exist returns false, or throws an exception if library exists but is read only or cannot be deleted for some other reason.

Parameters

aLibraryPath	is a locator for the "library", usually a directory or file which will contain several elements.
aProperties	is an associative array that can be used to tell the library delete implementation function anything special, because it can take any number of additional named tuning arguments that the plugin is known to support. The caller continues to own this object (plugin may not delete it), and plugins should expect it to be optionally NULL.

Returns: true if library deleted, false if library did not exist.

Exceptions

IO_ERROR if there is a problem deleting an existing library.

Reimplemented in SCH_IO_KICAD_LEGACY, SCH_IO_KICAD_SEXPR, PCB_IO_GEDA, PCB_IO_KICAD_LEGACY, and PCB_IO_KICAD_SEXPR.

Definition at line 50 of file io_base.cpp.

References NOT_IMPLEMENTED.

◆ FootprintDelete()

void PCB_IO::FootprintDelete	(	const wxString &	aLibraryPath,
		const wxString &	aFootprintName,
		const STRING_UTF8_MAP *	aProperties = `nullptr`
	)

virtual

Delete aFootprintName from the library at aLibraryPath.

Parameters

aLibraryPath	is a locator for the "library", usually a directory, file, or URL containing several footprints.
aFootprintName	is the name of a footprint to delete from the specified library.
aProperties	is an associative array that can be used to tell the library delete function anything special, because it can take any number of additional named tuning arguments that the plugin is known to support. The caller continues to own this object (plugin may not delete it), and plugins should expect it to be optionally NULL.

Exceptions

IO_ERROR if there is a problem finding the footprint or the library, or deleting it.

Reimplemented in PCB_IO_GEDA, and PCB_IO_KICAD_SEXPR.

Definition at line 164 of file pcb_io.cpp.

References NOT_IMPLEMENTED.

◆ FootprintEnumerate()

void PCB_IO::FootprintEnumerate	(	wxArrayString &	aFootprintNames,
		const wxString &	aLibraryPath,
		bool	aBestEfforts,
		const STRING_UTF8_MAP *	aProperties = `nullptr`
	)

virtual

Return a list of footprint names contained within the library at aLibraryPath.

Parameters

aLibraryPath	is a locator for the "library", usually a directory, file, or URL containing several footprints.
aProperties	is an associative array that can be used to tell the plugin anything needed about how to perform with respect to aLibraryPath. The caller continues to own this object (plugin may not delete it), and plugins should expect it to be optionally NULL.
aFootprintNames	is the array of available footprint names inside a library.
aBestEfforts	if true, don't throw on errors, just return an empty list.

Exceptions

IO_ERROR if the library cannot be found, or footprint cannot be loaded.

Reimplemented in PCB_IO_ALTIUM_DESIGNER, PCB_IO_CADSTAR_ARCHIVE, PCB_IO_EAGLE, PCB_IO_EASYEDA, PCB_IO_EASYEDAPRO, PCB_IO_GEDA, PCB_IO_KICAD_LEGACY, and PCB_IO_KICAD_SEXPR.

Definition at line 96 of file pcb_io.cpp.

References NOT_IMPLEMENTED.

Referenced by ImportFootprint().

◆ FootprintExists()

bool PCB_IO::FootprintExists	(	const wxString &	aLibraryPath,
		const wxString &	aFootprintName,
		const STRING_UTF8_MAP *	aProperties = `nullptr`
	)

virtual

Check for the existence of a footprint.

Reimplemented in PCB_IO_CADSTAR_ARCHIVE, and PCB_IO_KICAD_SEXPR.

Definition at line 140 of file pcb_io.cpp.

References FootprintLoad().

◆ FootprintLoad()

FOOTPRINT * PCB_IO::FootprintLoad	(	const wxString &	aLibraryPath,
		const wxString &	aFootprintName,
		bool	aKeepUUID = `false`,
		const STRING_UTF8_MAP *	aProperties = `nullptr`
	)

virtual

Load a footprint having aFootprintName from the aLibraryPath containing a library format that this PCB_IO knows about.

Parameters

aLibraryPath	is a locator for the "library", usually a directory, file, or URL containing several footprints.
aFootprintName	is the name of the footprint to load.
aProperties	is an associative array that can be used to tell the loader implementation to do something special, because it can take any number of additional named tuning arguments that the plugin is known to support. The caller continues to own this object (plugin may not delete it), and plugins should expect it to be optionally NULL.
aKeepUUID	= true to keep initial items UUID, false to set new UUID normally true if loaded in the footprint editor, false if loaded in the board editor. Make sense only in kicad_plugin

Returns: the FOOTPRINT object if found, caller owns it, else NULL if not found.

Exceptions

IO_ERROR if the library cannot be found or read. No exception is thrown in the case where aFootprintName cannot be found.

Reimplemented in PCB_IO_ALTIUM_DESIGNER, PCB_IO_CADSTAR_ARCHIVE, PCB_IO_EAGLE, PCB_IO_EASYEDA, PCB_IO_EASYEDAPRO, PCB_IO_GEDA, PCB_IO_KICAD_LEGACY, and PCB_IO_KICAD_SEXPR.

Definition at line 148 of file pcb_io.cpp.

References NOT_IMPLEMENTED.

Referenced by FootprintExists(), GetEnumeratedFootprint(), and ImportFootprint().

◆ FootprintSave()

void PCB_IO::FootprintSave	(	const wxString &	aLibraryPath,
		const FOOTPRINT *	aFootprint,
		const STRING_UTF8_MAP *	aProperties = `nullptr`
	)

virtual

Write aFootprint to an existing library located at aLibraryPath.

If a footprint by the same name already exists, it is replaced.

Parameters

aLibraryPath	is a locator for the "library", usually a directory, file, or URL containing several footprints.
aFootprint	is what to store in the library. The caller continues to own the footprint after this call.
aProperties	is an associative array that can be used to tell the saver how to save the footprint, because it can take any number of additional named tuning arguments that the plugin is known to support. The caller continues to own this object (plugin may not delete it), and plugins should expect it to be optionally NULL.

Exceptions

IO_ERROR if there is a problem saving.

Reimplemented in PCB_IO_KICAD_SEXPR.

Definition at line 156 of file pcb_io.cpp.

References NOT_IMPLEMENTED.

◆ GetBoardFileDesc()

virtual const IO_BASE::IO_FILE_DESC PCB_IO::GetBoardFileDesc ( ) const

inlinevirtual

Returns board file description for the PCB_IO.

Reimplemented in PCB_IO_ALTIUM_CIRCUIT_MAKER, PCB_IO_ALTIUM_CIRCUIT_STUDIO, PCB_IO_ALTIUM_DESIGNER, PCB_IO_SOLIDWORKS, PCB_IO_CADSTAR_ARCHIVE, PCB_IO_EAGLE, PCB_IO_EASYEDA, PCB_IO_EASYEDAPRO, PCB_IO_FABMASTER, PCB_IO_IPC2581, PCB_IO_KICAD_LEGACY, PCB_IO_KICAD_SEXPR, and PCB_IO_PCAD.

Definition at line 77 of file pcb_io.h.

Referenced by CanReadBoard().

◆ GetEnumeratedFootprint()

const FOOTPRINT * PCB_IO::GetEnumeratedFootprint	(	const wxString &	aLibraryPath,
		const wxString &	aFootprintName,
		const STRING_UTF8_MAP *	aProperties = `nullptr`
	)

virtual

A version of FootprintLoad() for use after FootprintEnumerate() for more efficient cache management.

Reimplemented in PCB_IO_GEDA, and PCB_IO_KICAD_SEXPR.

Definition at line 131 of file pcb_io.cpp.

References FootprintLoad().

◆ GetImportedCachedLibraryFootprints()

std::vector< FOOTPRINT * > PCB_IO::GetImportedCachedLibraryFootprints ( )

virtual

Return a container with the cached library footprints generated in the last call to Load.

This function is intended to be used ONLY by the non-KiCad board importers for the purpose of obtaining the footprint library of the design and creating a project-specific library.

Returns: Footprints (caller owns the objects)

Reimplemented in PCB_IO_CADSTAR_ARCHIVE, PCB_IO_EAGLE, PCB_IO_EASYEDA, PCB_IO_EASYEDAPRO, and PCB_IO_IPC2581.

Definition at line 82 of file pcb_io.cpp.

References NOT_IMPLEMENTED.

◆ GetLibraryDesc()

virtual const IO_FILE_DESC IO_BASE::GetLibraryDesc ( ) const

pure virtualinherited

Get the descriptor for the library container that this IO plugin operates on.

Returns: File descriptor for the container of the library elements

Implemented in SCH_IO_ALTIUM, SCH_IO_CADSTAR_ARCHIVE, SCH_IO_DATABASE, SCH_IO_EAGLE, SCH_IO_EASYEDA, SCH_IO_EASYEDAPRO, SCH_IO_HTTP_LIB, SCH_IO_KICAD_LEGACY, SCH_IO_KICAD_SEXPR, SCH_IO_LTSPICE, PCB_IO_ALTIUM_CIRCUIT_MAKER, PCB_IO_ALTIUM_CIRCUIT_STUDIO, PCB_IO_ALTIUM_DESIGNER, PCB_IO_SOLIDWORKS, PCB_IO_CADSTAR_ARCHIVE, PCB_IO_EAGLE, PCB_IO_EASYEDA, PCB_IO_EASYEDAPRO, PCB_IO_FABMASTER, PCB_IO_GEDA, PCB_IO_IPC2581, PCB_IO_KICAD_LEGACY, PCB_IO_KICAD_SEXPR, and PCB_IO_PCAD.

Referenced by IO_BASE::CanReadLibrary(), and IO_BASE::GetLibraryFileDesc().

◆ GetLibraryFileDesc()

virtual const IO_FILE_DESC IO_BASE::GetLibraryFileDesc ( ) const

inlinevirtualinherited

Get the descriptor for the individual library elements that this IO plugin operates on.

For libraries where all the elements are in a single container (e.g. all elements in a single file), then this will return the descriptor from IO_BASE::GetLibraryDesc().

Returns: File descriptor for the library elements

Reimplemented in PCB_IO_EASYEDA, PCB_IO_EASYEDAPRO, PCB_IO_GEDA, and PCB_IO_KICAD_SEXPR.

Definition at line 99 of file io_base.h.

References IO_BASE::GetLibraryDesc().

Referenced by CanReadFootprint().

◆ GetLibraryOptions()

void PCB_IO::GetLibraryOptions ( STRING_UTF8_MAP * aListToAppendTo ) const

overridevirtual

Append supported PLUGIN options to aListToAppenTo along with internationalized descriptions.

Options are typically appended so that a derived #PLUGIN can call its base class function by the same name first, thus inheriting options declared there. Some base class options could pertain to all Footprint*() functions in all derived PLUGINs.

Note: Since aListToAppendTo is a #PROPERTIES object, all options will be unique and last guy wins.

Parameters

aListToAppendTo

holds a tuple of

option: This eventually is what shows up into the fp-lib-table "options" field, possibly combined with others.
internationalized description: The internationalized description is displayed in DIALOG_PLUGIN_OPTIONS. It may be multi-line and be quite explanatory of the option.

In the future perhaps aListToAppendTo evolves to something capable of also holding a wxValidator for the cells in said dialog: http://forums.wxwidgets.org/viewtopic.php?t=23277&p=104180. This would require a 3 column list, and introducing wx GUI knowledge to PLUGIN, which has been avoided to date.

Reimplemented from IO_BASE.

Definition at line 172 of file pcb_io.cpp.

References _, and IO_BASE::GetLibraryOptions().

◆ GetLibraryTimestamp()

virtual long long PCB_IO::GetLibraryTimestamp ( const wxString & aLibraryPath ) const

pure virtual

Generate a timestamp representing all the files in the library (including the library directory).

Timestamps should not be considered ordered, they either match or they don't.

Implemented in PCB_IO_ALTIUM_CIRCUIT_MAKER, PCB_IO_ALTIUM_CIRCUIT_STUDIO, PCB_IO_ALTIUM_DESIGNER, PCB_IO_SOLIDWORKS, PCB_IO_CADSTAR_ARCHIVE, PCB_IO_EAGLE, PCB_IO_EASYEDA, PCB_IO_EASYEDAPRO, PCB_IO_FABMASTER, PCB_IO_GEDA, PCB_IO_IPC2581, PCB_IO_KICAD_LEGACY, PCB_IO_KICAD_SEXPR, and PCB_IO_PCAD.

◆ GetName()

const wxString & IO_BASE::GetName ( ) const

inlineinherited

Return a brief hard coded name for this IO interface.

Definition at line 68 of file io_base.h.

References IO_BASE::m_name.

Referenced by SCH_IO_ALTIUM::ParseLibFile().

◆ ImportFootprint()

FOOTPRINT * PCB_IO::ImportFootprint	(	const wxString &	aFootprintPath,
		wxString &	aFootprintNameOut,
		const STRING_UTF8_MAP *	aProperties = `nullptr`
	)

virtual

Load a single footprint from aFootprintPath and put its name in aFootprintNameOut.

If this is a footprint library, the first footprint should be loaded. The default implementation uses FootprintEnumerate and FootprintLoad to load first footprint.

Parameters

aLibraryPath	is a path of the footprint file.
aFootprintNameOut	is the name output of the loaded footprint.
aProperties	is an associative array that can be used to tell the loader implementation to do something special, because it can take any number of additional named tuning arguments that the plugin is known to support. The caller continues to own this object (plugin may not delete it), and plugins should expect it to be optionally NULL.

Returns: the FOOTPRINT object if found, caller owns it, else NULL if not found.

Exceptions

IO_ERROR if the footprint cannot be found or read.

Reimplemented in PCB_IO_GEDA, and PCB_IO_KICAD_SEXPR.

Definition at line 109 of file pcb_io.cpp.

References _, FootprintEnumerate(), and FootprintLoad().

◆ IsLibraryWritable()

bool IO_BASE::IsLibraryWritable ( const wxString & aLibraryPath )

virtualinherited

Return true if the library at aLibraryPath is writable.

The system libraries are typically read only because of where they are installed..

Parameters

aLibraryPath is a locator for the "library", usually a directory, file, or URL containing several footprints.

Exceptions

IO_ERROR if no library at aLibraryPath exists.

Reimplemented in SCH_IO_ALTIUM, SCH_IO_CADSTAR_ARCHIVE, SCH_IO_DATABASE, SCH_IO_EAGLE, SCH_IO_EASYEDA, SCH_IO_EASYEDAPRO, SCH_IO_HTTP_LIB, SCH_IO_KICAD_LEGACY, SCH_IO_KICAD_SEXPR, PCB_IO_ALTIUM_DESIGNER, PCB_IO_CADSTAR_ARCHIVE, PCB_IO_EAGLE, PCB_IO_EASYEDA, PCB_IO_EASYEDAPRO, PCB_IO_GEDA, PCB_IO_KICAD_LEGACY, and PCB_IO_KICAD_SEXPR.

Definition at line 56 of file io_base.cpp.

References NOT_IMPLEMENTED.

◆ LoadBoard()

BOARD * PCB_IO::LoadBoard	(	const wxString &	aFileName,
		BOARD *	aAppendToMe,
		const STRING_UTF8_MAP *	aProperties = `nullptr`,
		PROJECT *	aProject = `nullptr`
	)

virtual

Load information from some input file format that this PCB_IO implementation knows about into either a new BOARD or an existing one.

This may be used to load an entire new BOARD, or to augment an existing one if aAppendToMe is not NULL.

Parameters

aFileName	is the name of the file to use as input and may be foreign in nature or native in nature.
aAppendToMe	is an existing BOARD to append to, but if NULL then this means "do not append, rather load anew".
aProperties	is an associative array that can be used to tell the loader how to load the file, because it can take any number of additional named arguments that the plugin is known to support. These are tuning parameters for the import or load. The caller continues to own this object (plugin may not delete it), and plugins should expect it to be optionally NULL.
aProject	is the optional PROJECT object primarily used by third party importers.

Returns: the successfully loaded board, or the same one as aAppendToMe if aAppendToMe was not NULL, and caller owns it.

Exceptions

IO_ERROR if there is a problem loading, and its contents should say what went wrong, using line number and character offsets of the input file if possible.

Reimplemented in PCB_IO_ALTIUM_CIRCUIT_STUDIO, PCB_IO_ALTIUM_CIRCUIT_MAKER, PCB_IO_ALTIUM_DESIGNER, PCB_IO_SOLIDWORKS, CLIPBOARD_IO, PCB_IO_CADSTAR_ARCHIVE, PCB_IO_EAGLE, PCB_IO_EASYEDA, PCB_IO_EASYEDAPRO, PCB_IO_FABMASTER, PCB_IO_KICAD_LEGACY, PCB_IO_KICAD_SEXPR, and PCB_IO_PCAD.

Definition at line 75 of file pcb_io.cpp.

References NOT_IMPLEMENTED.

Referenced by PCB_CONTROL::AppendBoard().

◆ PrefetchLib()

void PCB_IO::PrefetchLib	(	const wxString &	aLibraryPath,
		const STRING_UTF8_MAP *	aProperties = `nullptr`
	)

virtual

If possible, prefetches the specified library (e.g.

performing downloads). Does not parse. Threadsafe.

This is a no-op for libraries that cannot be prefetched. Plugins that cannot prefetch need not override this; a default no-op is provided.

Parameters

aLibraryPath	is a locator for the "library", usually a directory, file, or URL containing several footprints.
aProperties	is an associative array that can be used to tell the plugin anything needed about how to perform with respect to aLibraryPath. The caller continues to own this object (plugin may not delete it), and plugins should expect it to be optionally NULL.

Exceptions

IO_ERROR if there is an error prefetching the library.

Definition at line 104 of file pcb_io.cpp.

◆ SaveBoard()

void PCB_IO::SaveBoard	(	const wxString &	aFileName,
		BOARD *	aBoard,
		const STRING_UTF8_MAP *	aProperties = `nullptr`
	)

virtual

Write aBoard to a storage file in a format that this PCB_IO implementation knows about or it can be used to write a portion of aBoard to a special kind of export file.

Parameters

aFileName	is the name of a file to save to on disk.
aBoard	is the class BOARD in memory document tree from which to extract information when writing to aFileName. The caller continues to own the BOARD, and the plugin should refrain from modifying the BOARD if possible.
aProperties	is an associative array that can be used to tell the saver how to save the file, because it can take any number of additional named tuning arguments that the plugin is known to support. The caller continues to own this object (plugin may not delete it) and plugins should expect it to be optionally NULL.

Exceptions

IO_ERROR if there is a problem saving or exporting.

Reimplemented in CLIPBOARD_IO, PCB_IO_IPC2581, and PCB_IO_KICAD_SEXPR.

Definition at line 88 of file pcb_io.cpp.

References NOT_IMPLEMENTED.

◆ SetProgressReporter()

virtual void IO_BASE::SetProgressReporter ( PROGRESS_REPORTER * aReporter )

inlinevirtualinherited

Set an optional progress reporter.

Reimplemented in SCH_IO_CADSTAR_ARCHIVE.

Definition at line 78 of file io_base.h.

References IO_BASE::m_progressReporter.

Referenced by PCB_CONTROL::AppendBoard().

◆ SetQueryUserCallback()

virtual void PCB_IO::SetQueryUserCallback ( std::function< bool(wxString aTitle, int aIcon, wxString aMessage, wxString aAction)> aCallback )

inlinevirtual

Registers a KIDIALOG callback for collecting info from the user.

Definition at line 98 of file pcb_io.h.

Referenced by PCB_CONTROL::AppendBoard().

◆ SetReporter()

virtual void IO_BASE::SetReporter ( REPORTER * aReporter )

inlinevirtualinherited

Set an optional reporter for warnings/errors.

Reimplemented in SCH_IO_CADSTAR_ARCHIVE.

Definition at line 73 of file io_base.h.

References IO_BASE::m_reporter.

Member Data Documentation

◆ m_board

BOARD* PCB_IO::m_board

protected

The board BOARD being worked on, no ownership here.

Definition at line 343 of file pcb_io.h.

◆ m_name

wxString IO_BASE::m_name

protectedinherited

Name of the IO loader.

Definition at line 204 of file io_base.h.

Referenced by IO_BASE::GetName().

◆ m_progressReporter

PROGRESS_REPORTER* IO_BASE::m_progressReporter

protectedinherited

Progress reporter to track the progress of the operation, may be nullptr.

Definition at line 210 of file io_base.h.

Referenced by SCH_IO_EAGLE::checkpoint(), SCH_IO_KICAD_LEGACY::checkpoint(), SCH_IO_EAGLE::ensureLoadedLibrary(), SCH_IO_CADSTAR_ARCHIVE::ensureLoadedLibrary(), PCB_IO_IPC2581::generateAvlSection(), PCB_IO_IPC2581::generateBOMSection(), PCB_IO_IPC2581::generateContentSection(), PCB_IO_IPC2581::generateEcadSection(), PCB_IO_IPC2581::generateHistorySection(), PCB_IO_ALTIUM_CIRCUIT_STUDIO::LoadBoard(), PCB_IO_ALTIUM_CIRCUIT_MAKER::LoadBoard(), PCB_IO_ALTIUM_DESIGNER::LoadBoard(), PCB_IO_SOLIDWORKS::LoadBoard(), PCB_IO_CADSTAR_ARCHIVE::LoadBoard(), PCB_IO_EASYEDA::LoadBoard(), PCB_IO_EASYEDAPRO::LoadBoard(), PCB_IO_FABMASTER::LoadBoard(), PCB_IO_KICAD_SEXPR::LoadBoard(), SCH_IO_KICAD_LEGACY::loadFile(), SCH_IO_KICAD_SEXPR::loadFile(), SCH_IO_EAGLE::loadSchematic(), SCH_IO_CADSTAR_ARCHIVE::LoadSchematicFile(), SCH_IO_EAGLE::LoadSchematicFile(), SCH_IO_LTSPICE::LoadSchematicFile(), PCB_IO_IPC2581::SaveBoard(), IO_BASE::SetProgressReporter(), and SCH_IO_CADSTAR_ARCHIVE::SetProgressReporter().

◆ m_props

const STRING_UTF8_MAP* PCB_IO::m_props

protected

Properties passed via Save() or Load(), no ownership, may be NULL.

Definition at line 346 of file pcb_io.h.

Referenced by PCB_IO_EAGLE::init(), PCB_IO_GEDA::init(), PCB_IO_KICAD_LEGACY::init(), PCB_IO_KICAD_SEXPR::init(), PCB_IO_ALTIUM_CIRCUIT_STUDIO::LoadBoard(), PCB_IO_ALTIUM_CIRCUIT_MAKER::LoadBoard(), PCB_IO_ALTIUM_DESIGNER::LoadBoard(), PCB_IO_SOLIDWORKS::LoadBoard(), PCB_IO_CADSTAR_ARCHIVE::LoadBoard(), PCB_IO_EASYEDA::LoadBoard(), PCB_IO_EASYEDAPRO::LoadBoard(), PCB_IO_FABMASTER::LoadBoard(), and PCB_IO_PCAD::LoadBoard().

◆ m_reporter

REPORTER* IO_BASE::m_reporter

protectedinherited

Reporter to log errors/warnings to, may be nullptr.

Definition at line 207 of file io_base.h.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~PCB_IO()

◆ PCB_IO()

Member Function Documentation

◆ CanReadBoard()

◆ CanReadFootprint()

◆ CanReadLibrary()

◆ CreateLibrary()

◆ DeleteLibrary()

◆ FootprintDelete()

◆ FootprintEnumerate()

◆ FootprintExists()

◆ FootprintLoad()

◆ FootprintSave()

◆ GetBoardFileDesc()

◆ GetEnumeratedFootprint()

◆ GetImportedCachedLibraryFootprints()

◆ GetLibraryDesc()

◆ GetLibraryFileDesc()

◆ GetLibraryOptions()

◆ GetLibraryTimestamp()

◆ GetName()

◆ ImportFootprint()

◆ IsLibraryWritable()

◆ LoadBoard()

◆ PrefetchLib()

◆ SaveBoard()

◆ SetProgressReporter()

◆ SetQueryUserCallback()

◆ SetReporter()

Member Data Documentation

◆ m_board

◆ m_name

◆ m_progressReporter

◆ m_props

◆ m_reporter