KiCad PCB EDA Suite
Loading...
Searching...
No Matches
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:
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. More...
 

Static Public Member Functions

static const wxString ShowType (SCH_FILE_T aFileType)
 Return a brief name for a plugin, given aFileType enum. More...
 
static SCH_FILE_T EnumFromStr (const wxString &aFileType)
 Return the #SCH_FILE_T from the corresponding plugin type name: "kicad", "legacy", etc. More...
 
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. More...
 
static SCH_FILE_T GuessPluginTypeFromSchPath (const wxString &aSchematicPath, int aCtl=0)
 Return a plugin type given a schematic using the file extension of aSchematicPath. More...
 

Detailed Description

A factory which returns an instance of a SCH_IO.

Definition at line 51 of file sch_io_mgr.h.

Member Function Documentation

◆ 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
aFileTypeis 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 106 of file sch_io_mgr.cpp.

Referenced by SCH_EDITOR_CONTROL::ExportSymbolsToLibrary(), SYMBOL_LIB_TABLE_RESCUER::OpenRescueLibrary(), SYMBOL_GRID_TRICKS::optionsEditor(), SYMBOL_LIB_TABLE_ROW::SetType(), and SYMBOL_LIB_TABLE_RESCUER::WriteRescueLibrary().

◆ GuessPluginTypeFromLibPath()

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

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


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