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_LTSPICE, SCH_HTTP, SCH_FILE_UNKNOWN }) 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 #SCH_FILE_T 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)
	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 )

static

Convert a schematic symbol library to the latest KiCad format.

Definition at line 205 of file sch_io_mgr.cpp.

References CTX_LIBID, EscapeString(), and GuessPluginTypeFromLibPath().

Referenced by 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_LTSPICE, SCH_HTTP, SCH_FILE_UNKNOWN }	)

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 which the caller can use to import, export, save, or load design documents.

Parameters

aFileType

is from #SCH_FILE_T and tells 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 #SCH_FILE_T from the corresponding plugin type name: "kicad", "legacy", etc.

Definition at line 107 of file sch_io_mgr.cpp.

Referenced by SYMBOL_LIBRARY_ADAPTER::createPlugin(), SCH_EDITOR_CONTROL::ExportSymbolsToLibrary(), 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 140 of file sch_io_mgr.cpp.

References fileType(), KICTL_CREATE, KICTL_KICAD_ONLY, and KICTL_NONKICAD_ONLY.

Referenced by SYMBOL_LIBRARY_MANAGER::addLibrary(), SYMBOL_EDIT_FRAME::addLibTableEntry(), PANEL_SYM_LIB_TABLE::browseLibrariesHandler(), ConvertLibrary(), SYMBOL_EDIT_FRAME::ExportSymbol(), SYMBOL_EDIT_FRAME::ImportSymbol(), EESCHEMA_JOBS_HANDLER::JobSymUpgrade(), SCH_EDIT_FRAME::KiwayMailIn(), SYMBOL_EDIT_FRAME::saveLibrary(), and SYMBOL_LIB_TABLE_GRID::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 179 of file sch_io_mgr.cpp.

References fileType(), KICTL_KICAD_ONLY, and KICTL_NONKICAD_ONLY.

Referenced by SCH_EDIT_FRAME::LoadSheetFromFile(), SCH_EDIT_FRAME::OpenProjectFiles(), and SCH_EDIT_FRAME::saveSchematicFile().

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 83 of file sch_io_mgr.cpp.

References _.

Referenced by SYMBOL_LIBRARY_MANAGER::addLibrary(), SYMBOL_EDIT_FRAME::addLibTableEntry(), PANEL_SYM_LIB_TABLE::browseLibrariesHandler(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), SYMBOL_LIBRARY_MANAGER::GetLibraryNames(), SYMBOL_EDIT_FRAME::IsSymbolFromLegacyLibrary(), SCH_EDIT_FRAME::KiwayMailIn(), PANEL_SYM_LIB_TABLE::onConvertLegacyLibraries(), PANEL_SYM_LIB_TABLE::PANEL_SYM_LIB_TABLE(), and SYMBOL_LIB_TABLE_GRID::SetValue().

---

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

• sch_io_mgr.h
• sch_io_mgr.cpp