#include <pcb_io_cadstar_archive.h>
Public Member Functions | |
| const IO_BASE::IO_FILE_DESC | GetBoardFileDesc () const override |
| Returns board file description for the PCB_IO. | |
| const IO_BASE::IO_FILE_DESC | GetLibraryDesc () const override |
| Get the descriptor for the library container that this IO plugin operates on. | |
| bool | CanReadBoard (const wxString &aFileName) const override |
| Checks if this PCB_IO can read the specified board file. | |
| bool | CanReadLibrary (const wxString &aFileName) const override |
| Checks if this IO object can read the specified library file/directory. | |
| bool | CanReadFootprint (const wxString &aFileName) const override |
| Checks if this PCB_IO can read a footprint from specified file or directory. | |
| BOARD * | LoadBoard (const wxString &aFileName, BOARD *aAppendToMe, const STRING_UTF8_MAP *aProperties=nullptr, PROJECT *aProject=nullptr) override |
| Load information from some input file format that this PCB_IO implementation knows about into either a new BOARD or an existing one. | |
| std::vector< FOOTPRINT * > | GetImportedCachedLibraryFootprints () override |
| Return a container with the cached library footprints generated in the last call to Load. | |
| void | RegisterLayerMappingCallback (LAYER_MAPPING_HANDLER aLayerMappingHandler) override |
| Register a different handler to be called when mapping of Cadstar to KiCad layers occurs. | |
| void | FootprintEnumerate (wxArrayString &aFootprintNames, const wxString &aLibraryPath, bool aBestEfforts, const STRING_UTF8_MAP *aProperties=nullptr) override |
| Return a list of footprint names contained within the library at aLibraryPath. | |
| bool | FootprintExists (const wxString &aLibraryPath, const wxString &aFootprintName, const STRING_UTF8_MAP *aProperties=nullptr) override |
| Check for the existence of a footprint. | |
| FOOTPRINT * | FootprintLoad (const wxString &aLibraryPath, const wxString &aFootprintName, bool aKeepUUID=false, const STRING_UTF8_MAP *aProperties=nullptr) override |
| Load a footprint having aFootprintName from the aLibraryPath containing a library format that this PCB_IO knows about. | |
| long long | GetLibraryTimestamp (const wxString &aLibraryPath) const override |
| Generate a timestamp representing all the files in the library (including the library directory). | |
| bool | IsLibraryWritable (const wxString &aLibraryPath) override |
| CADSTAR Plugin is read-only. | |
| PCB_IO_CADSTAR_ARCHIVE () | |
| ~PCB_IO_CADSTAR_ARCHIVE () | |
| 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 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 | 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 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 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. | |
| 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 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. | |
Static Public Member Functions | |
| static std::map< wxString, PCB_LAYER_ID > | DefaultLayerMappingCallback (const std::vector< INPUT_LAYER_DESC > &aInputLayerDescriptionVector) |
| Return the automapped layers. | |
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. | |
| LAYER_MAPPING_HANDLER | m_layer_mapping_handler |
| Callback to get layer mapping. | |
Private Types | |
| typedef std::map< const wxString, std::unique_ptr< FOOTPRINT > > | NAME_TO_FOOTPRINT_MAP |
Private Member Functions | |
| void | clearLoadedFootprints () |
| void | ensureLoadedLibrary (const wxString &aLibraryPath) |
| bool | checkBoardHeader (const wxString &aFileName) const |
Private Attributes | |
| std::map< wxString, NAME_TO_FOOTPRINT_MAP > | m_cache |
| std::map< wxString, long long > | m_timestamps |
| std::vector< FOOTPRINT * > | m_loaded_footprints |
| bool | m_show_layer_mapping_warnings |
Detailed Description
Definition at line 32 of file pcb_io_cadstar_archive.h.
Member Typedef Documentation
◆ NAME_TO_FOOTPRINT_MAP
|
private |
Definition at line 94 of file pcb_io_cadstar_archive.h.
Constructor & Destructor Documentation
◆ PCB_IO_CADSTAR_ARCHIVE()
| PCB_IO_CADSTAR_ARCHIVE::PCB_IO_CADSTAR_ARCHIVE | ( | ) |
Definition at line 58 of file pcb_io_cadstar_archive.cpp.
References DefaultLayerMappingCallback(), m_show_layer_mapping_warnings, and LAYER_REMAPPABLE_PLUGIN::RegisterLayerMappingCallback().
◆ ~PCB_IO_CADSTAR_ARCHIVE()
| PCB_IO_CADSTAR_ARCHIVE::~PCB_IO_CADSTAR_ARCHIVE | ( | ) |
Definition at line 66 of file pcb_io_cadstar_archive.cpp.
References clearLoadedFootprints().
Member Function Documentation
◆ CanReadBoard()
|
overridevirtual |
Checks if this PCB_IO can read the specified board file.
If not overriden, extension check is used.
Reimplemented from PCB_IO.
Definition at line 144 of file pcb_io_cadstar_archive.cpp.
References PCB_IO::CanReadBoard(), and checkBoardHeader().
◆ CanReadFootprint()
|
overridevirtual |
Checks if this PCB_IO can read a footprint from specified file or directory.
If not overriden, extension check is used.
Reimplemented from PCB_IO.
Definition at line 162 of file pcb_io_cadstar_archive.cpp.
References PCB_IO::CanReadFootprint(), and checkBoardHeader().
◆ CanReadLibrary()
|
overridevirtual |
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 from IO_BASE.
Definition at line 153 of file pcb_io_cadstar_archive.cpp.
References IO_BASE::CanReadLibrary(), and checkBoardHeader().
◆ checkBoardHeader()
|
private |
Definition at line 138 of file pcb_io_cadstar_archive.cpp.
References IO_UTILS::fileStartsWithPrefix().
Referenced by CanReadBoard(), CanReadFootprint(), and CanReadLibrary().
◆ clearLoadedFootprints()
|
private |
Definition at line 72 of file pcb_io_cadstar_archive.cpp.
References m_loaded_footprints.
Referenced by LoadBoard(), and ~PCB_IO_CADSTAR_ARCHIVE().
◆ CreateLibrary()
|
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.
◆ DefaultLayerMappingCallback()
|
static |
Return the automapped layers.
Pcbnew PLUGIN for CADSTAR PCB Archive (*.cpa) format: an ASCII format based on S-expressions.
- Parameters
-
aInputLayerDescriptionVector
- Returns
- Auto-mapped layers
Definition at line 35 of file pcb_io_cadstar_archive.cpp.
Referenced by PCB_IO_CADSTAR_ARCHIVE().
◆ DeleteLibrary()
|
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.
◆ ensureLoadedLibrary()
|
private |
Definition at line 233 of file pcb_io_cadstar_archive.cpp.
References GetLibraryTimestamp(), CADSTAR_PCB_ARCHIVE_LOADER::LoadLibrary(), m_cache, LAYER_REMAPPABLE_PLUGIN::m_layer_mapping_handler, and m_timestamps.
Referenced by FootprintEnumerate(), FootprintExists(), and FootprintLoad().
◆ FootprintDelete()
|
virtualinherited |
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()
|
overridevirtual |
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 from PCB_IO.
Definition at line 171 of file pcb_io_cadstar_archive.cpp.
References ensureLoadedLibrary(), m_cache, and name.
◆ FootprintExists()
|
overridevirtual |
Check for the existence of a footprint.
Reimplemented from PCB_IO.
Definition at line 186 of file pcb_io_cadstar_archive.cpp.
References ensureLoadedLibrary(), and m_cache.
◆ FootprintLoad()
|
overridevirtual |
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 from PCB_IO.
Definition at line 202 of file pcb_io_cadstar_archive.cpp.
References ensureLoadedLibrary(), and m_cache.
◆ FootprintSave()
|
virtualinherited |
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()
|
inlineoverridevirtual |
Returns board file description for the PCB_IO.
Reimplemented from PCB_IO.
Definition at line 35 of file pcb_io_cadstar_archive.h.
References _HKI.
Referenced by GetLibraryDesc().
◆ GetEnumeratedFootprint()
|
virtualinherited |
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 PCB_IO::FootprintLoad().
◆ GetImportedCachedLibraryFootprints()
|
overridevirtual |
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 from PCB_IO.
Definition at line 83 of file pcb_io_cadstar_archive.cpp.
References m_loaded_footprints.
◆ GetLibraryDesc()
|
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 40 of file pcb_io_cadstar_archive.h.
References GetBoardFileDesc().
◆ GetLibraryFileDesc()
|
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()
|
overridevirtualinherited |
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()
|
overridevirtual |
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.
Implements PCB_IO.
Definition at line 222 of file pcb_io_cadstar_archive.cpp.
Referenced by ensureLoadedLibrary().
◆ GetName()
|
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().
◆ ImportFootprint()
|
virtualinherited |
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 _, PCB_IO::FootprintEnumerate(), and PCB_IO::FootprintLoad().
◆ IsLibraryWritable()
|
inlineoverridevirtual |
CADSTAR Plugin is read-only.
- Returns
- Always false
Reimplemented from IO_BASE.
Definition at line 85 of file pcb_io_cadstar_archive.h.
◆ LoadBoard()
|
overridevirtual |
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 from PCB_IO.
Definition at line 96 of file pcb_io_cadstar_archive.cpp.
References UTF8::c_str(), clearLoadedFootprints(), BOARD::GetBoardEdgesBoundingBox(), BOX2< Vec >::GetHeight(), CADSTAR_PCB_ARCHIVE_LOADER::GetLoadedLibraryFootpints(), BOX2< Vec >::GetWidth(), BOX2< Vec >::GetX(), BOX2< Vec >::GetY(), CADSTAR_PCB_ARCHIVE_LOADER::Load(), PCB_IO::m_board, LAYER_REMAPPABLE_PLUGIN::m_layer_mapping_handler, BOARD::m_LegacyDesignSettingsLoaded, BOARD::m_LegacyNetclassesLoaded, m_loaded_footprints, IO_BASE::m_progressReporter, PCB_IO::m_props, m_show_layer_mapping_warnings, BOARD::Move(), and STRING_UTF8_MAP::Value().
◆ PrefetchLib()
|
virtualinherited |
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.
◆ RegisterLayerMappingCallback()
|
overridevirtual |
Register a different handler to be called when mapping of Cadstar to KiCad layers occurs.
- Parameters
-
aLayerMappingHandler
Reimplemented from LAYER_REMAPPABLE_PLUGIN.
Definition at line 50 of file pcb_io_cadstar_archive.cpp.
References m_show_layer_mapping_warnings, and LAYER_REMAPPABLE_PLUGIN::RegisterLayerMappingCallback().
◆ SaveBoard()
|
virtualinherited |
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()
|
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().
◆ SetQueryUserCallback()
|
inlinevirtualinherited |
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()
|
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.
Member Data Documentation
◆ m_board
|
protectedinherited |
The board BOARD being worked on, no ownership here.
Definition at line 343 of file pcb_io.h.
Referenced by PCB_IO_ALTIUM_DESIGNER::FootprintLoad(), PCB_IO_KICAD_SEXPR::formatBoardLayers(), PCB_IO_EAGLE::init(), PCB_IO_KICAD_LEGACY::init(), PCB_IO_KICAD_SEXPR::init(), PCB_IO_KICAD_LEGACY::loadAllSections(), PCB_IO_ALTIUM_CIRCUIT_STUDIO::LoadBoard(), PCB_IO_ALTIUM_CIRCUIT_MAKER::LoadBoard(), PCB_IO_ALTIUM_DESIGNER::LoadBoard(), PCB_IO_SOLIDWORKS::LoadBoard(), LoadBoard(), PCB_IO_EAGLE::LoadBoard(), PCB_IO_EASYEDA::LoadBoard(), PCB_IO_EASYEDAPRO::LoadBoard(), PCB_IO_FABMASTER::LoadBoard(), PCB_IO_KICAD_LEGACY::LoadBoard(), PCB_IO_PCAD::LoadBoard(), PCB_IO_KICAD_LEGACY::loadDIMENSION(), PCB_IO_KICAD_LEGACY::loadGENERAL(), PCB_IO_EAGLE::loadLayerDefs(), LP_CACHE::LoadModules(), PCB_IO_KICAD_LEGACY::loadNETCLASS(), PCB_IO_KICAD_LEGACY::loadNETINFO_ITEM(), PCB_IO_KICAD_LEGACY::loadPAD(), PCB_IO_KICAD_LEGACY::loadPCB_LINE(), PCB_IO_KICAD_LEGACY::loadPCB_TARGET(), PCB_IO_KICAD_LEGACY::loadPCB_TEXT(), PCB_IO_EAGLE::loadPlain(), PCB_IO_KICAD_LEGACY::loadSETUP(), PCB_IO_KICAD_LEGACY::loadSHEET(), PCB_IO_KICAD_LEGACY::loadTrackList(), PCB_IO_KICAD_LEGACY::loadZONE_CONTAINER(), CLIPBOARD_IO::SaveBoard(), PCB_IO_KICAD_SEXPR::SaveBoard(), CLIPBOARD_IO::SaveSelection(), and CLIPBOARD_IO::SetBoard().
◆ m_cache
|
private |
Definition at line 96 of file pcb_io_cadstar_archive.h.
Referenced by ensureLoadedLibrary(), FootprintEnumerate(), FootprintExists(), and FootprintLoad().
◆ m_layer_mapping_handler
|
protectedinherited |
Callback to get layer mapping.
Definition at line 80 of file plugin_common_layer_mapping.h.
Referenced by ensureLoadedLibrary(), LoadBoard(), and LAYER_REMAPPABLE_PLUGIN::RegisterLayerMappingCallback().
◆ m_loaded_footprints
|
private |
Definition at line 99 of file pcb_io_cadstar_archive.h.
Referenced by clearLoadedFootprints(), GetImportedCachedLibraryFootprints(), and LoadBoard().
◆ m_name
|
protectedinherited |
◆ m_progressReporter
|
protectedinherited |
Progress reporter to track the progress of the operation, may be nullptr.
Definition at line 213 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(), 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
|
protectedinherited |
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(), LoadBoard(), PCB_IO_EASYEDA::LoadBoard(), PCB_IO_EASYEDAPRO::LoadBoard(), PCB_IO_FABMASTER::LoadBoard(), and PCB_IO_PCAD::LoadBoard().
◆ 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(), 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::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(), 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_show_layer_mapping_warnings
|
private |
Definition at line 100 of file pcb_io_cadstar_archive.h.
Referenced by LoadBoard(), PCB_IO_CADSTAR_ARCHIVE(), and RegisterLayerMappingCallback().
◆ m_timestamps
|
private |
Definition at line 97 of file pcb_io_cadstar_archive.h.
Referenced by ensureLoadedLibrary().
The documentation for this class was generated from the following files:
