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

#include <pcb_io_cadstar_archive.h>

Inheritance diagram for PCB_IO_CADSTAR_ARCHIVE:
PCB_IO LAYER_REMAPPABLE_PLUGIN IO_BASE

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.
 
BOARDLoadBoard (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.
 
FOOTPRINTFootprintLoad (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 FOOTPRINTImportFootprint (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 FOOTPRINTGetEnumeratedFootprint (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_IDDefaultLayerMappingCallback (const std::vector< INPUT_LAYER_DESC > &aInputLayerDescriptionVector)
 Return the automapped layers.
 

Protected Attributes

BOARDm_board
 The board BOARD being worked on, no ownership here.
 
const STRING_UTF8_MAPm_props
 Properties passed via Save() or Load(), no ownership, may be NULL.
 
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.
 
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_MAPm_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

typedef std::map<const wxString, std::unique_ptr<FOOTPRINT> > PCB_IO_CADSTAR_ARCHIVE::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 ( )

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

bool PCB_IO_CADSTAR_ARCHIVE::CanReadBoard ( const wxString &  aFileName) const
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()

bool PCB_IO_CADSTAR_ARCHIVE::CanReadFootprint ( const wxString &  aFileName) const
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()

bool PCB_IO_CADSTAR_ARCHIVE::CanReadLibrary ( const wxString &  aFileName) const
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()

bool PCB_IO_CADSTAR_ARCHIVE::checkBoardHeader ( const wxString &  aFileName) const
private

◆ clearLoadedFootprints()

void PCB_IO_CADSTAR_ARCHIVE::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()

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.

◆ DefaultLayerMappingCallback()

std::map< wxString, PCB_LAYER_ID > PCB_IO_CADSTAR_ARCHIVE::DefaultLayerMappingCallback ( const std::vector< INPUT_LAYER_DESC > &  aInputLayerDescriptionVector)
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()

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.

◆ ensureLoadedLibrary()

void PCB_IO_CADSTAR_ARCHIVE::ensureLoadedLibrary ( const wxString &  aLibraryPath)
private

◆ FootprintDelete()

void PCB_IO::FootprintDelete ( const wxString &  aLibraryPath,
const wxString &  aFootprintName,
const STRING_UTF8_MAP aProperties = nullptr 
)
virtualinherited

Delete aFootprintName from the library at aLibraryPath.

Parameters
aLibraryPathis a locator for the "library", usually a directory, file, or URL containing several footprints.
aFootprintNameis the name of a footprint 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 footprint or the library, or deleting it.

Reimplemented in PCB_IO_GEDA, and PCB_IO_KICAD_SEXPR.

Definition at line 166 of file pcb_io.cpp.

References NOT_IMPLEMENTED.

◆ FootprintEnumerate()

void PCB_IO_CADSTAR_ARCHIVE::FootprintEnumerate ( wxArrayString &  aFootprintNames,
const wxString &  aLibraryPath,
bool  aBestEfforts,
const STRING_UTF8_MAP aProperties = nullptr 
)
overridevirtual

Return a list of footprint names contained within the library at aLibraryPath.

Parameters
aLibraryPathis a locator for the "library", usually a directory, file, or URL containing several footprints.
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.
aFootprintNamesis the array of available footprint names inside a library.
aBestEffortsif true, don't throw on errors, just return an empty list.
Exceptions
IO_ERRORif 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()

bool PCB_IO_CADSTAR_ARCHIVE::FootprintExists ( const wxString &  aLibraryPath,
const wxString &  aFootprintName,
const STRING_UTF8_MAP aProperties = nullptr 
)
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()

FOOTPRINT * PCB_IO_CADSTAR_ARCHIVE::FootprintLoad ( const wxString &  aLibraryPath,
const wxString &  aFootprintName,
bool  aKeepUUID = false,
const STRING_UTF8_MAP aProperties = nullptr 
)
overridevirtual

Load a footprint having aFootprintName from the aLibraryPath containing a library format that this PCB_IO knows about.

Parameters
aLibraryPathis a locator for the "library", usually a directory, file, or URL containing several footprints.
aFootprintNameis the name of the footprint 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.
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_ERRORif 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()

void PCB_IO::FootprintSave ( const wxString &  aLibraryPath,
const FOOTPRINT aFootprint,
const STRING_UTF8_MAP aProperties = nullptr 
)
virtualinherited

Write aFootprint to an existing library located at aLibraryPath.

If a footprint by the same name already exists, it is replaced.

Parameters
aLibraryPathis a locator for the "library", usually a directory, file, or URL containing several footprints.
aFootprintis what to store in the library. The caller continues to own the footprint after this call.
aPropertiesis 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_ERRORif there is a problem saving.

Reimplemented in PCB_IO_KICAD_SEXPR.

Definition at line 158 of file pcb_io.cpp.

References NOT_IMPLEMENTED.

◆ GetBoardFileDesc()

const IO_BASE::IO_FILE_DESC PCB_IO_CADSTAR_ARCHIVE::GetBoardFileDesc ( ) const
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()

const FOOTPRINT * PCB_IO::GetEnumeratedFootprint ( const wxString &  aLibraryPath,
const wxString &  aFootprintName,
const STRING_UTF8_MAP aProperties = nullptr 
)
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 133 of file pcb_io.cpp.

References PCB_IO::FootprintLoad().

◆ GetImportedCachedLibraryFootprints()

std::vector< FOOTPRINT * > PCB_IO_CADSTAR_ARCHIVE::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()

const IO_BASE::IO_FILE_DESC PCB_IO_CADSTAR_ARCHIVE::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 40 of file pcb_io_cadstar_archive.h.

References GetBoardFileDesc().

◆ 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 PCB_IO::GetLibraryOptions ( STRING_UTF8_MAP aListToAppendTo) const
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
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 PLUGIN, which has been avoided to date.

Reimplemented from IO_BASE.

Definition at line 174 of file pcb_io.cpp.

References _, and IO_BASE::GetLibraryOptions().

◆ GetLibraryTimestamp()

long long PCB_IO_CADSTAR_ARCHIVE::GetLibraryTimestamp ( const wxString &  aLibraryPath) const
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()

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

◆ ImportFootprint()

FOOTPRINT * PCB_IO::ImportFootprint ( const wxString &  aFootprintPath,
wxString &  aFootprintNameOut,
const STRING_UTF8_MAP aProperties = nullptr 
)
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
aLibraryPathis a path of the footprint file.
aFootprintNameOutis the name output of the loaded footprint.
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 FOOTPRINT object if found, caller owns it, else NULL if not found.
Exceptions
IO_ERRORif 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()

bool PCB_IO_CADSTAR_ARCHIVE::IsLibraryWritable ( const wxString &  aLibraryPath)
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()

BOARD * PCB_IO_CADSTAR_ARCHIVE::LoadBoard ( const wxString &  aFileName,
BOARD aAppendToMe,
const STRING_UTF8_MAP aProperties = nullptr,
PROJECT aProject = nullptr 
)
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
aFileNameis the name of the file to use as input and may be foreign in nature or native in nature.
aAppendToMeis an existing BOARD 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.
aProjectis 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_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 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()

void PCB_IO::PrefetchLib ( const wxString &  aLibraryPath,
const STRING_UTF8_MAP aProperties = nullptr 
)
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
aLibraryPathis a locator for the "library", usually a directory, file, or URL containing several footprints.
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 there is an error prefetching the library.

Definition at line 104 of file pcb_io.cpp.

◆ RegisterLayerMappingCallback()

void PCB_IO_CADSTAR_ARCHIVE::RegisterLayerMappingCallback ( LAYER_MAPPING_HANDLER  aLayerMappingHandler)
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()

void PCB_IO::SaveBoard ( const wxString &  aFileName,
BOARD aBoard,
const STRING_UTF8_MAP aProperties = nullptr 
)
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
aFileNameis the name of a file to save to on disk.
aBoardis 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.
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.
Exceptions
IO_ERRORif 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()

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

◆ SetQueryUserCallback()

virtual void PCB_IO::SetQueryUserCallback ( std::function< bool(wxString aTitle, int aIcon, wxString aMessage, wxString aAction)>  aCallback)
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()

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.

Member Data Documentation

◆ m_board

◆ m_cache

std::map<wxString, NAME_TO_FOOTPRINT_MAP> PCB_IO_CADSTAR_ARCHIVE::m_cache
private

◆ m_layer_mapping_handler

◆ m_loaded_footprints

std::vector<FOOTPRINT*> PCB_IO_CADSTAR_ARCHIVE::m_loaded_footprints
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_progressReporter

◆ m_props

◆ 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_show_layer_mapping_warnings

bool PCB_IO_CADSTAR_ARCHIVE::m_show_layer_mapping_warnings
private

◆ m_timestamps

std::map<wxString, long long> PCB_IO_CADSTAR_ARCHIVE::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: