SCH_IO_MGR Class Reference

A factory which returns an instance of a SCH_IO. More...

#include <sch_io_mgr.h>

Inheritance diagram for SCH_IO_MGR:

Public Member Functions
	DEFINE_ENUM_VECTOR (SCH_FILE_T, { SCH_KICAD, SCH_LEGACY, SCH_ALTIUM, SCH_CADSTAR_ARCHIVE, SCH_DATABASE, SCH_EAGLE, SCH_EASYEDA, SCH_EASYEDAPRO, SCH_EASYEDAPRO_V3, SCH_GEDA, SCH_LTSPICE, SCH_HTTP, SCH_PADS, SCH_DIPTRACE, SCH_PCAD, SCH_ORCAD, SCH_EASYPC, SCH_FILE_UNKNOWN, SCH_NESTED_TABLE }) APIEXPORT static SCH_IO *FindPlugin(SCH_FILE_T aFileType)
	A set of file types that the SCH_IO_MGR knows about, and for which there has been a plugin written, in alphabetical order.

Static Public Member Functions
static const wxString	ShowType (SCH_FILE_T aFileType)
	Return a brief name for a plugin, given aFileType enum.
static SCH_FILE_T	EnumFromStr (const wxString &aFileType)
	Return the file type from the corresponding plugin type name: "kicad", "legacy", etc.
static SCH_FILE_T	GuessPluginTypeFromLibPath (const wxString &aLibPath, int aCtl=0)
	Return a plugin type given a symbol library using the file extension of aLibPath.
static SCH_FILE_T	GuessPluginTypeFromSchPath (const wxString &aSchematicPath, int aCtl=0)
	Return a plugin type given a schematic using the file extension of aSchematicPath.
static bool	ConvertLibrary (std::map< std::string, UTF8 > *aOldFileProps, const wxString &aOldFilePath, const wxString &aNewFilepath, REPORTER *aReporter=nullptr)
	Convert a schematic symbol library to the latest KiCad format.

Detailed Description

A factory which returns an instance of a SCH_IO.

Definition at line 49 of file sch_io_mgr.h.

Member Function Documentation

ConvertLibrary()

bool SCH_IO_MGR::ConvertLibrary ( std::map< std::string, UTF8 > * aOldFileProps, const wxString & aOldFilePath, const wxString & aNewFilepath, REPORTER * aReporter = nullptr )

static

Convert a schematic symbol library to the latest KiCad format.

Definition at line 248 of file sch_io_mgr.cpp.

References _, CTX_LIBID, EscapeString(), GuessPluginTypeFromLibPath(), REPORTER::Report(), RPT_SEVERITY_ACTION, RPT_SEVERITY_ERROR, and IO_ERROR::What().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), EESCHEMA_JOBS_HANDLER::JobSymUpgrade(), and PANEL_SYM_LIB_TABLE::onConvertLegacyLibraries().

DEFINE_ENUM_VECTOR()

SCH_IO_MGR::DEFINE_ENUM_VECTOR	(	SCH_FILE_T	,
		{ SCH_KICAD, SCH_LEGACY, SCH_ALTIUM, SCH_CADSTAR_ARCHIVE, SCH_DATABASE, SCH_EAGLE, SCH_EASYEDA, SCH_EASYEDAPRO, SCH_EASYEDAPRO_V3, SCH_GEDA, SCH_LTSPICE, SCH_HTTP, SCH_PADS, SCH_DIPTRACE, SCH_PCAD, SCH_ORCAD, SCH_EASYPC, SCH_FILE_UNKNOWN, SCH_NESTED_TABLE }	)

A set of file types that the SCH_IO_MGR knows about, and for which there has been a plugin written, in alphabetical order.

Return a SCH_IO plugin which the caller can use to import, export, save, or load design documents.

Parameters

aFileType

is the file type of which plugin to find.

Returns

the plugin corresponding to aFileType or NULL if not found. Caller owns the returned object.

EnumFromStr()

SCH_IO_MGR::SCH_FILE_T SCH_IO_MGR::EnumFromStr ( const wxString & aFileType )

static

Return the file type from the corresponding plugin type name: "kicad", "legacy", etc.

Definition at line 132 of file sch_io_mgr.cpp.

References LIBRARY_TABLE_ROW::TABLE_TYPE_NAME.

Referenced by SYMBOL_LIBRARY_ADAPTER::createPlugin(), SCH_EDITOR_CONTROL::ExportSymbolsToLibrary(), SYMBOL_LIB_TABLE_GRID_DATA_MODEL::getFileTypes(), SYMBOL_EDIT_FRAME::LoadSymbol(), SYMBOL_LIB_TABLE_RESCUER::OpenRescueLibrary(), SYMBOL_GRID_TRICKS::optionsEditor(), and SYMBOL_LIB_TABLE_RESCUER::WriteRescueLibrary().

GuessPluginTypeFromLibPath()

SCH_IO_MGR::SCH_FILE_T SCH_IO_MGR::GuessPluginTypeFromLibPath ( const wxString & aLibPath, int aCtl = 0 )

static

Return a plugin type given a symbol library using the file extension of aLibPath.

Definition at line 179 of file sch_io_mgr.cpp.

References fileType(), KICTL_CREATE, KICTL_KICAD_ONLY, KICTL_NONKICAD_ONLY, and LIBRARY_TABLE_PARSER::Parse().

Referenced by SYMBOL_LIBRARY_MANAGER::addLibrary(), SYMBOL_EDIT_FRAME::addLibTableEntry(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), ConvertLibrary(), SYMBOL_EDIT_FRAME::ExportSymbol(), SYMBOL_EDIT_FRAME::ImportSymbol(), EESCHEMA_JOBS_HANDLER::JobSymUpgrade(), SCH_EDIT_FRAME::KiwayMailIn(), SYMBOL_EDIT_FRAME::saveLibrary(), SaveSymbolCopyToFile(), and SYMBOL_LIB_TABLE_GRID_DATA_MODEL::SetValue().

GuessPluginTypeFromSchPath()

SCH_IO_MGR::SCH_FILE_T SCH_IO_MGR::GuessPluginTypeFromSchPath ( const wxString & aSchematicPath, int aCtl = 0 )

static

Return a plugin type given a schematic using the file extension of aSchematicPath.

Definition at line 223 of file sch_io_mgr.cpp.

References fileType(), KICTL_KICAD_ONLY, and KICTL_NONKICAD_ONLY.

Referenced by BOOST_AUTO_TEST_CASE(), EESCHEMA_JOBS_HANDLER::JobImport(), SCH_EDIT_FRAME::LoadSheetFromFile(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::saveSchematicFile(), and SCH_API_SAVE::SaveSheetToFile().

ShowType()

const wxString SCH_IO_MGR::ShowType ( SCH_FILE_T aFileType )

static

Return a brief name for a plugin, given aFileType enum.

Definition at line 101 of file sch_io_mgr.cpp.

References _, and LIBRARY_TABLE_ROW::TABLE_TYPE_NAME.

Referenced by SYMBOL_LIBRARY_MANAGER::addLibrary(), SYMBOL_EDIT_FRAME::addLibTableEntry(), PANEL_SYM_LIB_TABLE::appendRowHandler(), PANEL_SYM_LIB_TABLE::browseLibrariesHandler(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), SYMBOL_LIBRARY_MANAGER::GetLibraryNames(), SYMBOL_EDIT_FRAME::IsSymbolFromLegacyLibrary(), EESCHEMA_JOBS_HANDLER::JobImport(), SCH_EDIT_FRAME::KiwayMailIn(), PANEL_SYM_LIB_TABLE::onConvertLegacyLibraries(), SCH_EDIT_FRAME::OpenProjectFiles(), PANEL_SYM_LIB_TABLE::PANEL_SYM_LIB_TABLE(), and SYMBOL_LIB_TABLE_GRID_DATA_MODEL::SetValue().

---

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

• sch_io_mgr.h
• sch_io_mgr.cpp