KiCad PCB EDA Suite
Loading...
Searching...
No Matches
SCH_IO_DATABASE Class Reference

A KiCad database library provides both symbol and footprint metadata, so there are "shim" plugins on both the symbol and footprint side of things that expose the database contents to the schematic and board editors. More...

#include <sch_io_database.h>

Inheritance diagram for SCH_IO_DATABASE:
SCH_IO IO_BASE

Public Member Functions

 SCH_IO_DATABASE ()
 
virtual ~SCH_IO_DATABASE ()
 
const IO_BASE::IO_FILE_DESC GetLibraryDesc () const override
 Get the descriptor for the library container that this IO plugin operates on.
 
int GetModifyHash () const override
 Return the modification hash from the library cache.
 
void EnumerateSymbolLib (wxArrayString &aSymbolNameList, const wxString &aLibraryPath, const STRING_UTF8_MAP *aProperties=nullptr) override
 Populate a list of LIB_SYMBOL alias names contained within the library aLibraryPath.
 
void EnumerateSymbolLib (std::vector< LIB_SYMBOL * > &aSymbolList, const wxString &aLibraryPath, const STRING_UTF8_MAP *aProperties=nullptr) override
 Populate a list of LIB_SYMBOL aliases contained within the library aLibraryPath.
 
LIB_SYMBOLLoadSymbol (const wxString &aLibraryPath, const wxString &aAliasName, const STRING_UTF8_MAP *aProperties=nullptr) override
 Load a LIB_SYMBOL object having aPartName from the aLibraryPath containing a library format that this SCH_IO knows about.
 
bool SupportsSubLibraries () const override
 
void GetSubLibraryNames (std::vector< wxString > &aNames) override
 Retrieves a list of sub-libraries in this library.
 
void GetAvailableSymbolFields (std::vector< wxString > &aNames) override
 Retrieves a list of (custom) field names that are present on symbols in this library.
 
void GetDefaultSymbolFields (std::vector< wxString > &aNames) override
 Retrieves a list of (custom) field names that should be shown by default for this library in the symbol chooser.
 
bool IsLibraryWritable (const wxString &aLibraryPath) override
 Return true if the library at aLibraryPath is writable.
 
void SetLibTable (SYMBOL_LIB_TABLE *aTable) override
 Some library plugins need to have access to their parent library table.
 
DATABASE_LIB_SETTINGSSettings () const
 
bool TestConnection (wxString *aErrorMsg=nullptr)
 
virtual const IO_BASE::IO_FILE_DESC GetSchematicFileDesc () const
 Returns schematic file description for the SCH_IO.
 
virtual bool CanReadSchematicFile (const wxString &aFileName) const
 Checks if this SCH_IO can read the specified schematic file.
 
virtual void SaveLibrary (const wxString &aFileName, const STRING_UTF8_MAP *aProperties=nullptr)
 
virtual SCH_SHEETLoadSchematicFile (const wxString &aFileName, SCHEMATIC *aSchematic, SCH_SHEET *aAppendToMe=nullptr, const STRING_UTF8_MAP *aProperties=nullptr)
 Load information from some input file format that this SCH_IO implementation knows about, into either a new SCH_SHEET or an existing one.
 
virtual void SaveSchematicFile (const wxString &aFileName, SCH_SHEET *aSheet, SCHEMATIC *aSchematic, const STRING_UTF8_MAP *aProperties=nullptr)
 Write aSchematic to a storage file in a format that this SCH_IO implementation knows about, or it can be used to write a portion of aSchematic to a special kind of export file.
 
virtual void SaveSymbol (const wxString &aLibraryPath, const LIB_SYMBOL *aSymbol, const STRING_UTF8_MAP *aProperties=nullptr)
 Write aSymbol to an existing library located at aLibraryPath.
 
virtual void DeleteSymbol (const wxString &aLibraryPath, const wxString &aSymbolName, const STRING_UTF8_MAP *aProperties=nullptr)
 Delete the entire LIB_SYMBOL associated with aAliasName from the library aLibraryPath.
 
virtual void GetLibraryOptions (STRING_UTF8_MAP *aListToAppendTo) const override
 Append supported SCH_IO options to aListToAppenTo along with internationalized descriptions.
 
virtual wxString GetSubLibraryDescription (const wxString &aName)
 Gets a description of a sublibrary.
 
virtual const wxString & GetError () const
 Return an error string to the caller.
 
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 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.
 

Protected Attributes

wxString m_name
 Name of the IO loader.
 
REPORTERm_reporter
 Reporter to log errors/warnings to, may be nullptr.
 
PROGRESS_REPORTERm_progressReporter
 Progress reporter to track the progress of the operation, may be nullptr.
 

Private Member Functions

void cacheLib ()
 
void ensureSettings (const wxString &aSettingsPath)
 
void ensureConnection ()
 
void connect ()
 
std::unique_ptr< LIB_SYMBOLloadSymbolFromRow (const wxString &aSymbolName, const DATABASE_LIB_TABLE &aTable, const DATABASE_CONNECTION::ROW &aRow)
 

Static Private Member Functions

static std::optional< bool > boolFromAny (const std::any &aVal)
 

Private Attributes

SYMBOL_LIB_TABLEm_libTable
 
std::unique_ptr< DATABASE_LIB_SETTINGSm_settings
 
std::unique_ptr< DATABASE_CONNECTIONm_conn
 Generally will be null if no valid connection is established.
 
std::set< wxString > m_customFields
 
std::set< wxString > m_defaultShownFields
 
std::map< wxString, std::unique_ptr< LIB_SYMBOL > > m_nameToSymbolcache
 
long long m_cacheTimestamp
 
int m_cacheModifyHash
 
wxString m_lastError
 

Detailed Description

A KiCad database library provides both symbol and footprint metadata, so there are "shim" plugins on both the symbol and footprint side of things that expose the database contents to the schematic and board editors.

The architecture of these is slightly different from the other plugins because the backing file is just a configuration file rather than something that contains symbol or footprint data.

Definition at line 42 of file sch_io_database.h.

Constructor & Destructor Documentation

◆ SCH_IO_DATABASE()

SCH_IO_DATABASE::SCH_IO_DATABASE ( )

Definition at line 37 of file sch_io_database.cpp.

References m_cacheModifyHash, and m_cacheTimestamp.

◆ ~SCH_IO_DATABASE()

SCH_IO_DATABASE::~SCH_IO_DATABASE ( )
virtual

Definition at line 47 of file sch_io_database.cpp.

Member Function Documentation

◆ boolFromAny()

std::optional< bool > SCH_IO_DATABASE::boolFromAny ( const std::any &  aVal)
staticprivate

Definition at line 368 of file sch_io_database.cpp.

Referenced by loadSymbolFromRow().

◆ cacheLib()

◆ 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().

◆ CanReadSchematicFile()

bool SCH_IO::CanReadSchematicFile ( const wxString &  aFileName) const
virtualinherited

◆ connect()

◆ 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
aLibraryPathis a locator for the "library", usually a directory, file, or URL containing several elements.
aPropertiesis 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_ERRORif 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
aLibraryPathis a locator for the "library", usually a directory or file which will contain several elements.
aPropertiesis 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_ERRORif 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.

◆ DeleteSymbol()

void SCH_IO::DeleteSymbol ( const wxString &  aLibraryPath,
const wxString &  aSymbolName,
const STRING_UTF8_MAP aProperties = nullptr 
)
virtualinherited

Delete the entire LIB_SYMBOL associated with aAliasName from the library aLibraryPath.

Parameters
aLibraryPathis a locator for the "library", usually a directory, file, or URL containing several symbols.
aSymbolNameis the name of a LIB_SYMBOL associated with it's root LIB_SYMBOL object to delete from the specified library.
aPropertiesis 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_ERRORif there is a problem finding the alias or the library or deleting it.

Reimplemented in SCH_IO_KICAD_LEGACY, and SCH_IO_KICAD_SEXPR.

Definition at line 117 of file sch_io.cpp.

References NOT_IMPLEMENTED.

Referenced by LIB_BUFFER::SaveBuffer().

◆ ensureConnection()

void SCH_IO_DATABASE::ensureConnection ( )
private

Definition at line 290 of file sch_io_database.cpp.

References _, connect(), m_conn, m_lastError, m_settings, and THROW_IO_ERROR.

Referenced by EnumerateSymbolLib(), and LoadSymbol().

◆ ensureSettings()

void SCH_IO_DATABASE::ensureSettings ( const wxString &  aSettingsPath)
private

Definition at line 250 of file sch_io_database.cpp.

References _, m_conn, m_settings, path, THROW_IO_ERROR, and traceDatabase.

Referenced by EnumerateSymbolLib(), GetSubLibraryNames(), and LoadSymbol().

◆ EnumerateSymbolLib() [1/2]

void SCH_IO_DATABASE::EnumerateSymbolLib ( std::vector< LIB_SYMBOL * > &  aSymbolList,
const wxString &  aLibraryPath,
const STRING_UTF8_MAP aProperties = nullptr 
)
overridevirtual

Populate a list of LIB_SYMBOL aliases contained within the library aLibraryPath.

Note
It is the responsibility of the caller to delete the returned object from the heap. Failure to do this will result in memory leaks.
Parameters
aSymbolListis an array to populate with the LIB_SYMBOL pointers associated with the library.
aLibraryPathis a locator for the "library", usually a directory, file, or URL containing one or more LIB_SYMBOL objects.
aPropertiesis 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_ERRORif the library cannot be found, the part library cannot be loaded.

Reimplemented from SCH_IO.

Definition at line 64 of file sch_io_database.cpp.

References cacheLib(), ensureConnection(), ensureSettings(), LIB_SYMBOL::IsPower(), m_conn, m_lastError, m_libTable, m_nameToSymbolcache, SYMBOL_LIB_TABLE::PropPowerSymsOnly, and THROW_IO_ERROR.

◆ EnumerateSymbolLib() [2/2]

void SCH_IO_DATABASE::EnumerateSymbolLib ( wxArrayString &  aSymbolNameList,
const wxString &  aLibraryPath,
const STRING_UTF8_MAP aProperties = nullptr 
)
overridevirtual

Populate a list of LIB_SYMBOL alias names contained within the library aLibraryPath.

Parameters
aSymbolNameListis an array to populate with the LIB_SYMBOL names associated with the library.
aLibraryPathis a locator for the "library", usually a directory, file, or URL containing one or more LIB_SYMBOL objects.
aPropertiesis 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_ERRORif the library cannot be found, the part library cannot be loaded.

Reimplemented from SCH_IO.

Definition at line 52 of file sch_io_database.cpp.

References EnumerateSymbolLib().

Referenced by EnumerateSymbolLib().

◆ GetAvailableSymbolFields()

void SCH_IO_DATABASE::GetAvailableSymbolFields ( std::vector< wxString > &  aNames)
overridevirtual

Retrieves a list of (custom) field names that are present on symbols in this library.

The plugin is responsible for guaranteeing that this list contains the set of unique custom field names present on any symbols contained in the library.

The required KiCad fields are not included in this list.

Parameters
aNameswill be filled with any custom fields present in this library.

Reimplemented from SCH_IO.

Definition at line 177 of file sch_io_database.cpp.

References m_customFields.

◆ GetDefaultSymbolFields()

void SCH_IO_DATABASE::GetDefaultSymbolFields ( std::vector< wxString > &  aNames)
overridevirtual

Retrieves a list of (custom) field names that should be shown by default for this library in the symbol chooser.

This list should be a subset of the result returned by GetAvailableSymbolFields().

The preference for which fields to hide and show for a given library is stored on a per-library basis in a user's preferences (or in the project local settings for a project- local library). The set of fields returned by GetDefaultSymbolFields() will be used if this preference is missing.

Parameters
aNameswill be filled with the custom field names that should be shown by default

Reimplemented from SCH_IO.

Definition at line 183 of file sch_io_database.cpp.

References m_defaultShownFields.

◆ GetError()

const wxString & SCH_IO::GetError ( ) const
virtualinherited

Return an error string to the caller.

This is useful for schematic loaders that can load partial schematics where throwing an exception would be problematic such as the KiCad legacy plugin.

Returns
an unformatted string containing errors if any.

Reimplemented in SCH_IO_HTTP_LIB, SCH_IO_KICAD_LEGACY, and SCH_IO_KICAD_SEXPR.

Definition at line 140 of file sch_io.cpp.

References NOT_IMPLEMENTED.

◆ GetLibraryDesc()

const IO_BASE::IO_FILE_DESC SCH_IO_DATABASE::GetLibraryDesc ( ) const
inlineoverridevirtual

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

Returns
File descriptor for the container of the library elements

Implements IO_BASE.

Definition at line 49 of file sch_io_database.h.

References _HKI, and FILEEXT::DatabaseLibraryFileExtension.

◆ 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 102 of file io_base.h.

References IO_BASE::GetLibraryDesc().

Referenced by PCB_IO::CanReadFootprint().

◆ GetLibraryOptions()

void SCH_IO::GetLibraryOptions ( STRING_UTF8_MAP aListToAppendTo) const
overridevirtualinherited

Append supported SCH_IO options to aListToAppenTo along with internationalized descriptions.

Options are typically appended so that a derived SCH_IO can call its base class function by the same name first, thus inheriting options declared there. (Some base class options could pertain to all Symbol*() functions in all derived SCH_IOs.) Note that since aListToAppendTo is a PROPERTIES object, all options will be unique and last guy wins.

Parameters
aListToAppendToholds 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 SCH_IO, which has been avoided to date.

Reimplemented from IO_BASE.

Reimplemented in SCH_IO_CADSTAR_ARCHIVE.

Definition at line 125 of file sch_io.cpp.

References IO_BASE::GetLibraryOptions().

◆ GetModifyHash()

int SCH_IO_DATABASE::GetModifyHash ( ) const
inlineoverridevirtual

Return the modification hash from the library cache.

Note
This is temporary until the new s-expr file format is implement. The new file format will embed symbols instead of referencing them from the library. This function can be removed when the new file format is implemented.
Returns
the modification hash of the library cache.

Implements SCH_IO.

Definition at line 55 of file sch_io_database.h.

◆ GetName()

const wxString & IO_BASE::GetName ( ) const
inlineinherited

Return a brief hard coded name for this IO interface.

Definition at line 71 of file io_base.h.

References IO_BASE::m_name.

Referenced by SCH_IO_ALTIUM::ParseLibFile().

◆ GetSchematicFileDesc()

const IO_BASE::IO_FILE_DESC SCH_IO::GetSchematicFileDesc ( ) const
virtualinherited

Returns schematic file description for the SCH_IO.

Reimplemented in SCH_IO_ALTIUM, SCH_IO_CADSTAR_ARCHIVE, SCH_IO_EAGLE, SCH_IO_EASYEDA, SCH_IO_EASYEDAPRO, SCH_IO_KICAD_LEGACY, SCH_IO_KICAD_SEXPR, and SCH_IO_LTSPICE.

Definition at line 40 of file sch_io.cpp.

Referenced by SCH_IO::CanReadSchematicFile().

◆ GetSubLibraryDescription()

virtual wxString SCH_IO::GetSubLibraryDescription ( const wxString &  aName)
inlinevirtualinherited

Gets a description of a sublibrary.

Has no effect if SupportsSubLibraries() returns false.

Parameters
aNamecontains the name of the sublibrary for which the description is retrieved
Returns
the description of the sublibrary

Reimplemented in SCH_IO_HTTP_LIB.

Definition at line 313 of file sch_io.h.

◆ GetSubLibraryNames()

void SCH_IO_DATABASE::GetSubLibraryNames ( std::vector< wxString > &  aNames)
overridevirtual

Retrieves a list of sub-libraries in this library.

Some types of symbol library support sub-libraries, which are a single-level organizational hierarchy that is implementation-defined per plugin. Most of KiCad ignores sub-libraries and treats the hierarchy between library and symbol as flat, but the sub-libraries are used for sorting and grouping symbols in the symbol chooser.

Has no effect if SupportsSubLibraries() returns false.

Parameters
aNameswill be filled with a list of sub-libraries within this symbol library

Reimplemented from SCH_IO.

Definition at line 158 of file sch_io_database.cpp.

References ensureSettings(), m_settings, and DATABASE_LIB_TABLE::name.

Referenced by DIALOG_DATABASE_LIB_SETTINGS::OnBtnReloadConfig().

◆ IsLibraryWritable()

bool SCH_IO_DATABASE::IsLibraryWritable ( const wxString &  aLibraryPath)
inlineoverridevirtual

Return true if the library at aLibraryPath is writable.

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

Parameters
aLibraryPathis a locator for the "library", usually a directory, file, or URL containing several footprints.
Exceptions
IO_ERRORif no library at aLibraryPath exists.

Reimplemented from IO_BASE.

Definition at line 77 of file sch_io_database.h.

◆ LoadSchematicFile()

SCH_SHEET * SCH_IO::LoadSchematicFile ( const wxString &  aFileName,
SCHEMATIC aSchematic,
SCH_SHEET aAppendToMe = nullptr,
const STRING_UTF8_MAP aProperties = nullptr 
)
virtualinherited

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

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

Parameters
aFileNameis the name of the file to use as input and may be foreign in nature or native in nature.
aKiwayis the KIWAY object used to access the symbol libraries loaded by the project.
aAppendToMeis an existing SCH_SHEET to append to, but if NULL then this means "do not append, rather load anew".
aPropertiesis 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.
Returns
the successfully loaded schematic, or the same one as aAppendToMe if aAppendToMe was not NULL, and the caller owns it.
Exceptions
IO_ERRORif 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 SCH_IO_ALTIUM, SCH_IO_CADSTAR_ARCHIVE, SCH_IO_EAGLE, SCH_IO_EASYEDA, SCH_IO_EASYEDAPRO, SCH_IO_KICAD_LEGACY, SCH_IO_KICAD_SEXPR, and SCH_IO_LTSPICE.

Definition at line 68 of file sch_io.cpp.

References NOT_IMPLEMENTED.

◆ LoadSymbol()

LIB_SYMBOL * SCH_IO_DATABASE::LoadSymbol ( const wxString &  aLibraryPath,
const wxString &  aPartName,
const STRING_UTF8_MAP aProperties = nullptr 
)
overridevirtual

Load a LIB_SYMBOL object having aPartName from the aLibraryPath containing a library format that this SCH_IO knows about.

Parameters
aLibraryPathis a locator for the "library", usually a directory, file, or URL containing several symbols.
aPartNameis the name of the LIB_SYMBOL to load.
aPropertiesis 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 part created on the heap if found caller shares it or NULL if not found.
Exceptions
IO_ERRORif the library cannot be found or read. No exception is thrown in the case where aAliasName cannot be found.

Reimplemented from SCH_IO.

Definition at line 90 of file sch_io_database.cpp.

References ensureConnection(), ensureSettings(), loadSymbolFromRow(), m_conn, m_lastError, m_libTable, m_settings, DATABASE_LIB_TABLE::name, THROW_IO_ERROR, and traceDatabase.

◆ loadSymbolFromRow()

◆ SaveLibrary()

void SCH_IO::SaveLibrary ( const wxString &  aFileName,
const STRING_UTF8_MAP aProperties = nullptr 
)
virtualinherited

Reimplemented in SCH_IO_KICAD_LEGACY, and SCH_IO_KICAD_SEXPR.

Definition at line 62 of file sch_io.cpp.

References NOT_IMPLEMENTED.

◆ SaveSchematicFile()

void SCH_IO::SaveSchematicFile ( const wxString &  aFileName,
SCH_SHEET aSheet,
SCHEMATIC aSchematic,
const STRING_UTF8_MAP aProperties = nullptr 
)
virtualinherited

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

Parameters
aFileNameis the name of a file to save to on disk.
aSheetis the class SCH_SHEET in memory document tree from which to extract information when writing to aFileName. The caller continues to own the SCHEMATIC, and the plugin should refrain from modifying the SCHEMATIC if possible.
aSchematicis the SCHEMATIC object used to access any schematic-wide or project information needed to save the document.
aPropertiesis 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. Set the #PropSaveCurrentSheetOnly property to only save the current sheet. Otherwise, all hierarchical sheets are saved.
Exceptions
IO_ERRORif there is a problem saving or exporting.

Reimplemented in SCH_IO_KICAD_LEGACY, and SCH_IO_KICAD_SEXPR.

Definition at line 75 of file sch_io.cpp.

References NOT_IMPLEMENTED.

◆ SaveSymbol()

void SCH_IO::SaveSymbol ( const wxString &  aLibraryPath,
const LIB_SYMBOL aSymbol,
const STRING_UTF8_MAP aProperties = nullptr 
)
virtualinherited

Write aSymbol to an existing library located at aLibraryPath.

If a LIB_SYMBOL by the same name already exists or there are any conflicting alias names, the new LIB_SYMBOL will silently overwrite any existing aliases and/or part because libraries cannot have duplicate alias names. It is the responsibility of the caller to check the library for conflicts before saving.

Parameters
aLibraryPathis a locator for the "library", usually a directory, file, or URL containing several symbols.
aSymbolis what to store in the library. The library is refreshed and the caller must update any LIB_SYMBOL pointers that may have changed.
aPropertiesis an associative array that can be used to tell the saver how to save the symbol, 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_ERRORif there is a problem saving.

Reimplemented in SCH_IO_HTTP_LIB, SCH_IO_KICAD_LEGACY, and SCH_IO_KICAD_SEXPR.

Definition at line 109 of file sch_io.cpp.

References NOT_IMPLEMENTED.

Referenced by LIB_BUFFER::SaveBuffer().

◆ SetLibTable()

void SCH_IO_DATABASE::SetLibTable ( SYMBOL_LIB_TABLE aTable)
inlineoverridevirtual

Some library plugins need to have access to their parent library table.

Parameters
aTableis the table this plugin is registered within.

Reimplemented from SCH_IO.

Definition at line 79 of file sch_io_database.h.

References m_libTable.

◆ SetProgressReporter()

virtual void IO_BASE::SetProgressReporter ( PROGRESS_REPORTER aReporter)
inlinevirtualinherited

Set an optional progress reporter.

Reimplemented in SCH_IO_CADSTAR_ARCHIVE.

Definition at line 81 of file io_base.h.

References IO_BASE::m_progressReporter.

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 76 of file io_base.h.

References IO_BASE::m_reporter.

◆ Settings()

DATABASE_LIB_SETTINGS * SCH_IO_DATABASE::Settings ( ) const
inline

Definition at line 84 of file sch_io_database.h.

References m_settings.

Referenced by DIALOG_DATABASE_LIB_SETTINGS::TransferDataToWindow().

◆ SupportsSubLibraries()

bool SCH_IO_DATABASE::SupportsSubLibraries ( ) const
inlineoverridevirtual
Returns
true if this plugin supports libraries that contain sub-libraries.

Reimplemented from SCH_IO.

Definition at line 68 of file sch_io_database.h.

◆ TestConnection()

bool SCH_IO_DATABASE::TestConnection ( wxString *  aErrorMsg = nullptr)

Member Data Documentation

◆ m_cacheModifyHash

int SCH_IO_DATABASE::m_cacheModifyHash
private

Definition at line 118 of file sch_io_database.h.

Referenced by cacheLib(), and SCH_IO_DATABASE().

◆ m_cacheTimestamp

long long SCH_IO_DATABASE::m_cacheTimestamp
private

Definition at line 116 of file sch_io_database.h.

Referenced by cacheLib(), and SCH_IO_DATABASE().

◆ m_conn

std::unique_ptr<DATABASE_CONNECTION> SCH_IO_DATABASE::m_conn
private

Generally will be null if no valid connection is established.

Definition at line 108 of file sch_io_database.h.

Referenced by cacheLib(), connect(), ensureConnection(), ensureSettings(), EnumerateSymbolLib(), LoadSymbol(), and TestConnection().

◆ m_customFields

std::set<wxString> SCH_IO_DATABASE::m_customFields
private

Definition at line 110 of file sch_io_database.h.

Referenced by GetAvailableSymbolFields(), and loadSymbolFromRow().

◆ m_defaultShownFields

std::set<wxString> SCH_IO_DATABASE::m_defaultShownFields
private

Definition at line 112 of file sch_io_database.h.

Referenced by GetDefaultSymbolFields(), and loadSymbolFromRow().

◆ m_lastError

wxString SCH_IO_DATABASE::m_lastError
private

◆ m_libTable

SYMBOL_LIB_TABLE* SCH_IO_DATABASE::m_libTable
private

◆ m_name

wxString IO_BASE::m_name
protectedinherited

Name of the IO loader.

Definition at line 207 of file io_base.h.

Referenced by IO_BASE::GetName().

◆ m_nameToSymbolcache

std::map<wxString, std::unique_ptr<LIB_SYMBOL> > SCH_IO_DATABASE::m_nameToSymbolcache
private

Definition at line 114 of file sch_io_database.h.

Referenced by cacheLib(), and EnumerateSymbolLib().

◆ m_progressReporter

◆ m_reporter

REPORTER* IO_BASE::m_reporter
protectedinherited

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

Definition at line 210 of file io_base.h.

Referenced by SCH_IO_ALTIUM::AddLibTextBox(), SCH_IO_CADSTAR_ARCHIVE::ensureLoadedLibrary(), PCB_IO_ALTIUM_DESIGNER::FootprintLoad(), PCB_IO_ALTIUM_CIRCUIT_STUDIO::LoadBoard(), PCB_IO_ALTIUM_CIRCUIT_MAKER::LoadBoard(), PCB_IO_ALTIUM_DESIGNER::LoadBoard(), PCB_IO_SOLIDWORKS::LoadBoard(), SCH_IO_EAGLE::loadInstance(), SCH_IO_CADSTAR_ARCHIVE::LoadSchematicFile(), SCH_IO_LTSPICE::LoadSchematicFile(), SCH_IO_ALTIUM::ParseAltiumSch(), SCH_IO_ALTIUM::ParseArc(), SCH_IO_ALTIUM::ParseBezier(), SCH_IO_ALTIUM::ParseCircle(), SCH_IO_ALTIUM::ParseComponent(), SCH_IO_ALTIUM::ParseDesignator(), SCH_IO_ALTIUM::ParseEllipse(), SCH_IO_ALTIUM::ParseEllipticalArc(), SCH_IO_ALTIUM::ParseFileName(), SCH_IO_ALTIUM::ParseHarnessConnector(), SCH_IO_ALTIUM::ParseHarnessEntry(), SCH_IO_ALTIUM::ParseHarnessPort(), SCH_IO_ALTIUM::ParseHarnessType(), SCH_IO_ALTIUM::ParseImage(), SCH_IO_ALTIUM::ParseImplementation(), SCH_IO_ALTIUM::ParseLabel(), SCH_IO_ALTIUM::ParseLibFile(), SCH_IO_ALTIUM::ParseLine(), SCH_IO_ALTIUM::ParsePieChart(), SCH_IO_ALTIUM::ParsePin(), SCH_IO_ALTIUM::ParsePolygon(), SCH_IO_ALTIUM::ParsePolyline(), SCH_IO_ALTIUM::ParsePort(), SCH_IO_ALTIUM::ParsePowerPort(), SCH_IO_ALTIUM::ParseRecord(), SCH_IO_ALTIUM::ParseRectangle(), SCH_IO_ALTIUM::ParseRoundRectangle(), SCH_IO_ALTIUM::ParseSheetEntry(), SCH_IO_ALTIUM::ParseSheetName(), SCH_IO_ALTIUM::ParseSignalHarness(), SCH_IO_ALTIUM::ParseStorage(), PCB_IO_ALTIUM_DESIGNER::PCB_IO_ALTIUM_DESIGNER(), PCB_IO_SOLIDWORKS::PCB_IO_SOLIDWORKS(), SCH_IO_ALTIUM::SCH_IO_ALTIUM(), SCH_IO_CADSTAR_ARCHIVE::SCH_IO_CADSTAR_ARCHIVE(), SCH_IO_EAGLE::SCH_IO_EAGLE(), SCH_IO_EASYEDA::SCH_IO_EASYEDA(), SCH_IO_EASYEDAPRO::SCH_IO_EASYEDAPRO(), SCH_IO_LTSPICE::SCH_IO_LTSPICE(), IO_BASE::SetReporter(), and SCH_IO_CADSTAR_ARCHIVE::SetReporter().

◆ m_settings

std::unique_ptr<DATABASE_LIB_SETTINGS> SCH_IO_DATABASE::m_settings
private

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