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

#include <pcb_io_ipc2581.h>

Inheritance diagram for PCB_IO_IPC2581:
PCB_IO IO_BASE

Public Member Functions

 PCB_IO_IPC2581 ()
 PCB_IO_IPC2581.
 
 ~PCB_IO_IPC2581 () override
 This program source code file is part of KiCad, a free EDA CAD application.
 
void SaveBoard (const wxString &aFileName, BOARD *aBoard, const STRING_UTF8_MAP *aProperties=nullptr) override
 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.
 
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.
 
std::vector< FOOTPRINT * > GetImportedCachedLibraryFootprints () override
 Return a container with the cached library footprints generated in the last call to Load.
 
long long GetLibraryTimestamp (const wxString &aLibraryPath) const override
 Generate a timestamp representing all the files in the library (including the library directory).
 
bool CanReadBoard (const wxString &aFileName) const override
 Checks if this PCB_IO can read the specified board file.
 
bool CanReadFootprint (const wxString &aFileName) const override
 Checks if this PCB_IO can read a footprint from specified file or directory.
 
bool CanReadLibrary (const wxString &aFileName) const override
 Checks if this IO object can read the specified library file/directory.
 
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 BOARDLoadBoard (const wxString &aFileName, BOARD *aAppendToMe, const STRING_UTF8_MAP *aProperties=nullptr, PROJECT *aProject=nullptr)
 Load information from some input file format that this PCB_IO implementation knows about into either a new BOARD or an existing one.
 
virtual void FootprintEnumerate (wxArrayString &aFootprintNames, const wxString &aLibraryPath, bool aBestEfforts, const STRING_UTF8_MAP *aProperties=nullptr)
 Return a list of footprint names contained within the library at aLibraryPath.
 
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 FOOTPRINTFootprintLoad (const wxString &aLibraryPath, const wxString &aFootprintName, bool aKeepUUID=false, const STRING_UTF8_MAP *aProperties=nullptr)
 Load a footprint having aFootprintName from the aLibraryPath containing a library format that this PCB_IO knows about.
 
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 bool FootprintExists (const wxString &aLibraryPath, const wxString &aFootprintName, const STRING_UTF8_MAP *aProperties=nullptr)
 Check for the existence of a footprint.
 
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.
 
virtual bool IsLibraryWritable (const wxString &aLibraryPath)
 Return true if the library at aLibraryPath is writable.
 

Protected Attributes

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.
 

Private Member Functions

void clearLoadedFootprints ()
 Frees the memory allocated for the loaded footprints in m_loaded_footprints.
 
wxXmlNode * generateXmlHeader ()
 Creates the XML header for IPC-2581.
 
wxXmlNode * generateContentSection ()
 Creates the Content section of the XML file.
 
wxXmlNode * generateLogisticSection ()
 Creates the logistical data header.
 
wxXmlNode * generateHistorySection ()
 Creates the history section.
 
wxXmlNode * generateBOMSection (wxXmlNode *aEcadNode)
 Creates the BOM section.
 
wxXmlNode * generateEcadSection ()
 Creates the ECAD section.
 
wxXmlNode * generateAvlSection ()
 Creates the Approved Vendor List section.
 
void generateCadLayers (wxXmlNode *aCadLayerNode)
 
void generateDrillLayers (wxXmlNode *aCadLayerNode)
 
void generateStepSection (wxXmlNode *aCadNode)
 
void generateProfile (wxXmlNode *aStepNode)
 
void generateLogicalNets (wxXmlNode *aStepNode)
 
void generatePhyNetGroup (wxXmlNode *aStepNode)
 
void generateLayerFeatures (wxXmlNode *aStepNode)
 
void generateLayerSetDrill (wxXmlNode *aStepNode)
 
void generateLayerSetNet (wxXmlNode *aLayerNode, PCB_LAYER_ID aLayer, std::vector< BOARD_ITEM * > &aItems)
 
wxXmlNode * generateContentStackup (wxXmlNode *aContentNode)
 
void generateComponents (wxXmlNode *aStepNode)
 
void addCadHeader (wxXmlNode *aEcadNode)
 
wxXmlNode * addPackage (wxXmlNode *aStepNode, FOOTPRINT *aFootprint)
 
void addPad (wxXmlNode *aContentNode, const PAD *aPad, PCB_LAYER_ID aLayer)
 
void addVia (wxXmlNode *aContentNode, const PCB_VIA *aVia, PCB_LAYER_ID aLayer)
 
void addPadStack (wxXmlNode *aContentNode, const PAD *aPad)
 
void addPadStack (wxXmlNode *aContentNode, const PCB_VIA *aVia)
 
void addLocationNode (wxXmlNode *aContentNode, double aX, double aY)
 
void addLocationNode (wxXmlNode *aContentNode, const PAD &aPad, bool aRelative)
 
void addLocationNode (wxXmlNode *aContentNode, const PCB_SHAPE &aShape)
 
void addShape (wxXmlNode *aContentNode, const PCB_SHAPE &aShape)
 
void addShape (wxXmlNode *aContentNode, const PAD &aPad, PCB_LAYER_ID aLayer)
 
void addSlotCavity (wxXmlNode *aContentNode, const PAD &aPad, const wxString &aName)
 
void addText (wxXmlNode *aContentNode, EDA_TEXT *aShape, const KIFONT::METRICS &aFontMetrics)
 
void addLineDesc (wxXmlNode *aNode, int aWidth, LINE_STYLE aDashType, bool aForce=false)
 
void addFillDesc (wxXmlNode *aNode, FILL_T aFillType, bool aForce=false)
 
bool addPolygonNode (wxXmlNode *aParentNode, const SHAPE_POLY_SET::POLYGON &aPolygon, FILL_T aFillType=FILL_T::FILLED_SHAPE, int aWidth=0, LINE_STYLE aDashType=LINE_STYLE::SOLID)
 
bool addPolygonCutouts (wxXmlNode *aParentNode, const SHAPE_POLY_SET::POLYGON &aPolygon)
 
bool addOutlineNode (wxXmlNode *aParentNode, const SHAPE_POLY_SET &aPolySet, int aWidth=0, LINE_STYLE aDashType=LINE_STYLE::SOLID)
 
bool addContourNode (wxXmlNode *aParentNode, const SHAPE_POLY_SET &aPolySet, int aOutline=0, FILL_T aFillType=FILL_T::FILLED_SHAPE, int aWidth=0, LINE_STYLE aDashType=LINE_STYLE::SOLID)
 
size_t lineHash (int aWidth, LINE_STYLE aDashType)
 
size_t shapeHash (const PCB_SHAPE &aShape)
 
wxString genString (const wxString &aStr, const char *aPrefix=nullptr) const
 
wxString floatVal (double aVal)
 
wxString pinName (const PAD *aPad) const
 
wxString componentName (FOOTPRINT *aFootprint)
 
void addXY (wxXmlNode *aNode, const VECTOR2I &aVec, const char *aXName=nullptr, const char *aYName=nullptr)
 
void addAttribute (wxXmlNode *aNode, const wxString &aName, const wxString &aValue)
 
wxXmlNode * insertNode (wxXmlNode *aParent, const wxString &aName)
 
wxXmlNode * appendNode (wxXmlNode *aParent, const wxString &aName)
 
void appendNode (wxXmlNode *aParent, wxXmlNode *aNode)
 
void insertNode (wxXmlNode *aParent, wxXmlNode *aNode)
 
void insertNodeAfter (wxXmlNode *aPrev, wxXmlNode *aNode)
 
void addLayerAttributes (wxXmlNode *aNode, PCB_LAYER_ID aLayer)
 
bool isValidLayerFor2581 (PCB_LAYER_ID aLayer)
 

Private Attributes

size_t m_total_bytes
 
wxString m_units_str
 
double m_scale
 
int m_sigfig
 
char m_version
 
wxString m_OEMRef
 
wxString m_mpn
 
wxString m_mfg
 
wxString m_distpn
 
wxString m_dist
 
wxXmlNode * m_enterpriseNode
 
BOARDm_board
 
std::vector< FOOTPRINT * > m_loaded_footprints
 
const STRING_UTF8_MAPm_props
 
std::map< size_t, wxString > m_user_shape_dict
 
wxXmlNode * m_shape_user_node
 
std::map< size_t, wxString > m_std_shape_dict
 
wxXmlNode * m_shape_std_node
 
std::map< size_t, wxString > m_line_dict
 
wxXmlNode * m_line_node
 
std::map< size_t, wxString > m_padstack_dict
 
std::vector< wxXmlNode * > m_padstacks
 
wxXmlNode * m_last_padstack
 
std::map< size_t, wxString > m_footprint_dict
 
std::map< wxString, FOOTPRINT * > m_footprint_refdes_dict
 
std::map< FOOTPRINT *, wxString > m_footprint_refdes_reverse_dict
 
std::map< FOOTPRINT *, wxString > m_OEMRef_dict
 
std::map< int, std::vector< std::pair< wxString, wxString > > > m_net_pin_dict
 
std::map< PCB_LAYER_ID, wxString > m_layer_name_map
 
std::map< std::pair< PCB_LAYER_ID, PCB_LAYER_ID >, std::vector< BOARD_ITEM * > > m_drill_layers
 
std::map< std::pair< PCB_LAYER_ID, PCB_LAYER_ID >, std::vector< PAD * > > m_slot_holes
 
PROGRESS_REPORTERm_progress_reporter
 
std::set< wxUniChar > m_acceptable_chars
 
wxXmlDocument * m_xml_doc
 
wxXmlNode * m_xml_root
 

Detailed Description

Definition at line 49 of file pcb_io_ipc2581.h.

Constructor & Destructor Documentation

◆ PCB_IO_IPC2581()

◆ ~PCB_IO_IPC2581()

PCB_IO_IPC2581::~PCB_IO_IPC2581 ( )
override

This program source code file is part of KiCad, a free EDA CAD application.

Copyright (C) 2023 KiCad Developers, see AUTHORS.txt for contributors.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Definition at line 58 of file pcb_io_ipc2581.cpp.

References clearLoadedFootprints().

Member Function Documentation

◆ addAttribute()

◆ addCadHeader()

void PCB_IO_IPC2581::addCadHeader ( wxXmlNode *  aEcadNode)
private

Definition at line 1339 of file pcb_io_ipc2581.cpp.

References addAttribute(), appendNode(), and m_units_str.

Referenced by generateEcadSection().

◆ addContourNode()

bool PCB_IO_IPC2581::addContourNode ( wxXmlNode *  aParentNode,
const SHAPE_POLY_SET aPolySet,
int  aOutline = 0,
FILL_T  aFillType = FILL_T::FILLED_SHAPE,
int  aWidth = 0,
LINE_STYLE  aDashType = LINE_STYLE::SOLID 
)
private

◆ addFillDesc()

void PCB_IO_IPC2581::addFillDesc ( wxXmlNode *  aNode,
FILL_T  aFillType,
bool  aForce = false 
)
private

Definition at line 509 of file pcb_io_ipc2581.cpp.

References addAttribute(), and appendNode().

Referenced by addPolygonNode(), and addShape().

◆ addLayerAttributes()

void PCB_IO_IPC2581::addLayerAttributes ( wxXmlNode *  aNode,
PCB_LAYER_ID  aLayer 
)
private

◆ addLineDesc()

void PCB_IO_IPC2581::addLineDesc ( wxXmlNode *  aNode,
int  aWidth,
LINE_STYLE  aDashType,
bool  aForce = false 
)
private

◆ addLocationNode() [1/3]

void PCB_IO_IPC2581::addLocationNode ( wxXmlNode *  aContentNode,
const PAD aPad,
bool  aRelative 
)
private

◆ addLocationNode() [2/3]

void PCB_IO_IPC2581::addLocationNode ( wxXmlNode *  aContentNode,
const PCB_SHAPE aShape 
)
private

◆ addLocationNode() [3/3]

void PCB_IO_IPC2581::addLocationNode ( wxXmlNode *  aContentNode,
double  aX,
double  aY 
)
private

◆ addOutlineNode()

bool PCB_IO_IPC2581::addOutlineNode ( wxXmlNode *  aParentNode,
const SHAPE_POLY_SET aPolySet,
int  aWidth = 0,
LINE_STYLE  aDashType = LINE_STYLE::SOLID 
)
private

◆ addPackage()

wxXmlNode * PCB_IO_IPC2581::addPackage ( wxXmlNode *  aStepNode,
FOOTPRINT aFootprint 
)
private

◆ addPad()

◆ addPadStack() [1/2]

◆ addPadStack() [2/2]

◆ addPolygonCutouts()

bool PCB_IO_IPC2581::addPolygonCutouts ( wxXmlNode *  aParentNode,
const SHAPE_POLY_SET::POLYGON aPolygon 
)
private

Definition at line 1797 of file pcb_io_ipc2581.cpp.

References addXY(), and appendNode().

Referenced by addContourNode().

◆ addPolygonNode()

bool PCB_IO_IPC2581::addPolygonNode ( wxXmlNode *  aParentNode,
const SHAPE_POLY_SET::POLYGON aPolygon,
FILL_T  aFillType = FILL_T::FILLED_SHAPE,
int  aWidth = 0,
LINE_STYLE  aDashType = LINE_STYLE::SOLID 
)
private

◆ addShape() [1/2]

◆ addShape() [2/2]

◆ addSlotCavity()

void PCB_IO_IPC2581::addSlotCavity ( wxXmlNode *  aContentNode,
const PAD aPad,
const wxString &  aName 
)
private

◆ addText()

◆ addVia()

void PCB_IO_IPC2581::addVia ( wxXmlNode *  aContentNode,
const PCB_VIA aVia,
PCB_LAYER_ID  aLayer 
)
private

◆ addXY()

void PCB_IO_IPC2581::addXY ( wxXmlNode *  aNode,
const VECTOR2I aVec,
const char *  aXName = nullptr,
const char *  aYName = nullptr 
)
private

◆ appendNode() [1/2]

◆ appendNode() [2/2]

void PCB_IO_IPC2581::appendNode ( wxXmlNode *  aParent,
wxXmlNode *  aNode 
)
private

Definition at line 124 of file pcb_io_ipc2581.cpp.

References m_total_bytes.

◆ CanReadBoard()

bool PCB_IO_IPC2581::CanReadBoard ( const wxString &  aFileName) const
inlineoverridevirtual

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 104 of file pcb_io_ipc2581.h.

◆ CanReadFootprint()

bool PCB_IO_IPC2581::CanReadFootprint ( const wxString &  aFileName) const
inlineoverridevirtual

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 110 of file pcb_io_ipc2581.h.

◆ CanReadLibrary()

bool PCB_IO_IPC2581::CanReadLibrary ( const wxString &  aFileName) const
inlineoverridevirtual

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 116 of file pcb_io_ipc2581.h.

◆ clearLoadedFootprints()

void PCB_IO_IPC2581::clearLoadedFootprints ( )
private

Frees the memory allocated for the loaded footprints in m_loaded_footprints.

Definition at line 64 of file pcb_io_ipc2581.cpp.

References m_loaded_footprints.

Referenced by ~PCB_IO_IPC2581().

◆ componentName()

wxString PCB_IO_IPC2581::componentName ( FOOTPRINT aFootprint)
private

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

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

◆ floatVal()

wxString PCB_IO_IPC2581::floatVal ( double  aVal)
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::FootprintEnumerate ( wxArrayString &  aFootprintNames,
const wxString &  aLibraryPath,
bool  aBestEfforts,
const STRING_UTF8_MAP aProperties = nullptr 
)
virtualinherited

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 in PCB_IO_ALTIUM_DESIGNER, PCB_IO_CADSTAR_ARCHIVE, PCB_IO_EAGLE, PCB_IO_EASYEDA, PCB_IO_EASYEDAPRO, PCB_IO_GEDA, PCB_IO_KICAD_LEGACY, and PCB_IO_KICAD_SEXPR.

Definition at line 96 of file pcb_io.cpp.

References NOT_IMPLEMENTED.

Referenced by PCB_IO::ImportFootprint().

◆ FootprintExists()

bool PCB_IO::FootprintExists ( const wxString &  aLibraryPath,
const wxString &  aFootprintName,
const STRING_UTF8_MAP aProperties = nullptr 
)
virtualinherited

Check for the existence of a footprint.

Reimplemented in PCB_IO_CADSTAR_ARCHIVE, and PCB_IO_KICAD_SEXPR.

Definition at line 142 of file pcb_io.cpp.

References PCB_IO::FootprintLoad().

◆ FootprintLoad()

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

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 in PCB_IO_ALTIUM_DESIGNER, PCB_IO_CADSTAR_ARCHIVE, PCB_IO_EAGLE, PCB_IO_EASYEDA, PCB_IO_EASYEDAPRO, PCB_IO_GEDA, PCB_IO_KICAD_LEGACY, and PCB_IO_KICAD_SEXPR.

Definition at line 150 of file pcb_io.cpp.

References NOT_IMPLEMENTED.

Referenced by PCB_IO::FootprintExists(), PCB_IO::GetEnumeratedFootprint(), and PCB_IO::ImportFootprint().

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

◆ generateAvlSection()

wxXmlNode * PCB_IO_IPC2581::generateAvlSection ( )
private

Creates the Approved Vendor List section.

If the user chooses, this will associate BOM items with vendor numbers and names.

Definition at line 2746 of file pcb_io_ipc2581.cpp.

References _, addAttribute(), PROGRESS_REPORTER::AdvancePhase(), appendNode(), empty(), genString(), PCB_TEXT::GetShownText(), insertNodeAfter(), m_dist, m_distpn, m_enterpriseNode, m_mfg, m_mpn, m_OEMRef_dict, IO_BASE::m_progressReporter, m_xml_root, and name.

Referenced by SaveBoard().

◆ generateBOMSection()

wxXmlNode * PCB_IO_IPC2581::generateBOMSection ( wxXmlNode *  aEcadNode)
private

Creates the BOM section.

This section defines the BOM data for the board. This includes the part number, manufacturer, and distributor information for each component on the board.

We assume that the m_OEMRef_dict is populated already by the generateComponents function This will either place a unique string in the dictionary or field reference.

Definition at line 1159 of file pcb_io_ipc2581.cpp.

References _, addAttribute(), PROGRESS_REPORTER::AdvancePhase(), ANGLE_0, appendNode(), componentName(), F_Cu, BOARD::Footprints(), FP_EXCLUDE_FROM_BOM, genString(), BOARD::GetFileName(), hash_fp_item(), HASH_POS, m_board, m_footprint_dict, m_layer_name_map, m_OEMRef_dict, IO_BASE::m_progressReporter, m_xml_root, REFDES, and REL_COORD.

Referenced by SaveBoard().

◆ generateCadLayers()

◆ generateComponents()

◆ generateContentSection()

wxXmlNode * PCB_IO_IPC2581::generateContentSection ( )
private

Creates the Content section of the XML file.

This holds the overview of the rest of the board data. Includes references to the step, bom, and layers as well as the content dictionaries

Definition at line 310 of file pcb_io_ipc2581.cpp.

References _, addAttribute(), PROGRESS_REPORTER::AdvancePhase(), appendNode(), generateContentStackup(), genString(), BOARD::GetFileName(), m_board, m_line_node, IO_BASE::m_progressReporter, m_shape_std_node, m_shape_user_node, m_units_str, m_version, and m_xml_root.

Referenced by SaveBoard().

◆ generateContentStackup()

◆ generateDrillLayers()

void PCB_IO_IPC2581::generateDrillLayers ( wxXmlNode *  aCadLayerNode)
private

◆ generateEcadSection()

wxXmlNode * PCB_IO_IPC2581::generateEcadSection ( )
private

Creates the ECAD section.

This describes the layout, layers, and design as well as component placement and netlist information

Definition at line 1320 of file pcb_io_ipc2581.cpp.

References _, addAttribute(), addCadHeader(), PROGRESS_REPORTER::AdvancePhase(), appendNode(), generateCadLayers(), generateDrillLayers(), generateStepSection(), IO_BASE::m_progressReporter, and m_xml_root.

Referenced by SaveBoard().

◆ generateHistorySection()

wxXmlNode * PCB_IO_IPC2581::generateHistorySection ( )
private

Creates the history section.

This section defines the history of the file, the revision number, and the date of the revision as well as software used to create the file. Optionally, the data could include information about the git revision and tag

Definition at line 1132 of file pcb_io_ipc2581.cpp.

References _, addAttribute(), PROGRESS_REPORTER::AdvancePhase(), appendNode(), GetMajorMinorPatchVersion(), IO_BASE::m_progressReporter, and m_xml_root.

Referenced by SaveBoard().

◆ generateLayerFeatures()

void PCB_IO_IPC2581::generateLayerFeatures ( wxXmlNode *  aStepNode)
private

◆ generateLayerSetDrill()

void PCB_IO_IPC2581::generateLayerSetDrill ( wxXmlNode *  aStepNode)
private

◆ generateLayerSetNet()

◆ generateLogicalNets()

void PCB_IO_IPC2581::generateLogicalNets ( wxXmlNode *  aStepNode)
private

◆ generateLogisticSection()

wxXmlNode * PCB_IO_IPC2581::generateLogisticSection ( )
private

Creates the logistical data header.

This section defines the organization and person creating the file. Can be used for contact information and config management

Definition at line 1111 of file pcb_io_ipc2581.cpp.

References addAttribute(), appendNode(), m_enterpriseNode, and m_xml_root.

Referenced by SaveBoard().

◆ generatePhyNetGroup()

void PCB_IO_IPC2581::generatePhyNetGroup ( wxXmlNode *  aStepNode)
private

◆ generateProfile()

void PCB_IO_IPC2581::generateProfile ( wxXmlNode *  aStepNode)
private

◆ generateStepSection()

◆ generateXmlHeader()

wxXmlNode * PCB_IO_IPC2581::generateXmlHeader ( )
private

Creates the XML header for IPC-2581.

Definition at line 291 of file pcb_io_ipc2581.cpp.

References addAttribute(), m_version, and m_xml_doc.

Referenced by SaveBoard().

◆ genString()

◆ GetBoardFileDesc()

const IO_BASE::IO_FILE_DESC PCB_IO_IPC2581::GetBoardFileDesc ( ) const
inlineoverridevirtual

Returns board file description for the PCB_IO.

Reimplemented from PCB_IO.

Definition at line 85 of file pcb_io_ipc2581.h.

◆ 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_IPC2581::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 75 of file pcb_io_ipc2581.cpp.

References m_loaded_footprints.

◆ GetLibraryDesc()

const IO_BASE::IO_FILE_DESC PCB_IO_IPC2581::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 90 of file pcb_io_ipc2581.h.

◆ 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_IPC2581::GetLibraryTimestamp ( const wxString &  aLibraryPath) const
inlineoverridevirtual

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 98 of file pcb_io_ipc2581.h.

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

◆ insertNode() [1/2]

wxXmlNode * PCB_IO_IPC2581::insertNode ( wxXmlNode *  aParent,
const wxString &  aName 
)
private

Definition at line 114 of file pcb_io_ipc2581.cpp.

References insertNode(), and m_total_bytes.

Referenced by addPackage(), generateComponents(), generateStepSection(), and insertNode().

◆ insertNode() [2/2]

void PCB_IO_IPC2581::insertNode ( wxXmlNode *  aParent,
wxXmlNode *  aNode 
)
private

Definition at line 88 of file pcb_io_ipc2581.cpp.

References m_total_bytes.

◆ insertNodeAfter()

void PCB_IO_IPC2581::insertNodeAfter ( wxXmlNode *  aPrev,
wxXmlNode *  aNode 
)
private

Definition at line 103 of file pcb_io_ipc2581.cpp.

References m_total_bytes.

Referenced by addPadStack(), and generateAvlSection().

◆ IsLibraryWritable()

bool IO_BASE::IsLibraryWritable ( const wxString &  aLibraryPath)
virtualinherited

Return true if the library at aLibraryPath is writable.

The system libraries are typically read only because of where they are installed..

Parameters
aLibraryPathis a locator for the "library", usually a directory, file, or URL containing several footprints.
Exceptions
IO_ERRORif no library at aLibraryPath exists.

Reimplemented in SCH_IO_ALTIUM, SCH_IO_CADSTAR_ARCHIVE, SCH_IO_DATABASE, SCH_IO_EAGLE, SCH_IO_EASYEDA, SCH_IO_EASYEDAPRO, SCH_IO_HTTP_LIB, SCH_IO_KICAD_LEGACY, SCH_IO_KICAD_SEXPR, PCB_IO_ALTIUM_DESIGNER, PCB_IO_CADSTAR_ARCHIVE, PCB_IO_EAGLE, PCB_IO_EASYEDA, PCB_IO_EASYEDAPRO, PCB_IO_GEDA, PCB_IO_KICAD_LEGACY, and PCB_IO_KICAD_SEXPR.

Definition at line 56 of file io_base.cpp.

References NOT_IMPLEMENTED.

◆ isValidLayerFor2581()

bool PCB_IO_IPC2581::isValidLayerFor2581 ( PCB_LAYER_ID  aLayer)
private

Definition at line 1346 of file pcb_io_ipc2581.cpp.

References F_Cu, UNDEFINED_LAYER, and User_9.

Referenced by generateCadLayers().

◆ lineHash()

size_t PCB_IO_IPC2581::lineHash ( int  aWidth,
LINE_STYLE  aDashType 
)
private

Definition at line 418 of file pcb_io_ipc2581.cpp.

References hash_combine(), and hash_val().

Referenced by addLineDesc().

◆ LoadBoard()

BOARD * PCB_IO::LoadBoard ( const wxString &  aFileName,
BOARD aAppendToMe,
const STRING_UTF8_MAP aProperties = nullptr,
PROJECT aProject = nullptr 
)
virtualinherited

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 in PCB_IO_ALTIUM_CIRCUIT_STUDIO, PCB_IO_ALTIUM_CIRCUIT_MAKER, PCB_IO_ALTIUM_DESIGNER, PCB_IO_SOLIDWORKS, CLIPBOARD_IO, PCB_IO_CADSTAR_ARCHIVE, PCB_IO_EAGLE, PCB_IO_EASYEDA, PCB_IO_EASYEDAPRO, PCB_IO_FABMASTER, PCB_IO_KICAD_LEGACY, PCB_IO_KICAD_SEXPR, and PCB_IO_PCAD.

Definition at line 75 of file pcb_io.cpp.

References NOT_IMPLEMENTED.

Referenced by PCB_CONTROL::AppendBoard().

◆ pinName()

wxString PCB_IO_IPC2581::pinName ( const PAD aPad) const
private

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

◆ SaveBoard()

void PCB_IO_IPC2581::SaveBoard ( const wxString &  aFileName,
BOARD aBoard,
const STRING_UTF8_MAP aProperties = nullptr 
)
overridevirtual

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 from PCB_IO.

Definition at line 2839 of file pcb_io_ipc2581.cpp.

References _, PROGRESS_REPORTER::AdvancePhase(), PROGRESS_REPORTER::BeginPhase(), generateAvlSection(), generateBOMSection(), generateContentSection(), generateEcadSection(), generateHistorySection(), generateLogisticSection(), generateXmlHeader(), m_acceptable_chars, m_board, m_dist, m_distpn, m_mfg, m_mpn, m_OEMRef, IO_BASE::m_progressReporter, m_scale, m_sigfig, m_total_bytes, m_units_str, m_version, m_xml_doc, m_xml_root, PCB_IU_PER_MM, PROGRESS_REPORTER::Report(), PROGRESS_REPORTER::SetCurrentProgress(), PROGRESS_REPORTER::SetNumPhases(), and wxFileOutputStreamWithProgress::SetProgressCallback().

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

◆ shapeHash()

size_t PCB_IO_IPC2581::shapeHash ( const PCB_SHAPE aShape)
private

Definition at line 426 of file pcb_io_ipc2581.cpp.

References hash_fp_item(), HASH_POS, and REL_COORD.

Referenced by addShape().

Member Data Documentation

◆ m_acceptable_chars

std::set<wxUniChar> PCB_IO_IPC2581::m_acceptable_chars
private

Definition at line 330 of file pcb_io_ipc2581.h.

Referenced by genString(), and SaveBoard().

◆ m_board

◆ m_dist

wxString PCB_IO_IPC2581::m_dist
private

Definition at line 281 of file pcb_io_ipc2581.h.

Referenced by generateAvlSection(), and SaveBoard().

◆ m_distpn

wxString PCB_IO_IPC2581::m_distpn
private

Definition at line 280 of file pcb_io_ipc2581.h.

Referenced by generateAvlSection(), and SaveBoard().

◆ m_drill_layers

std::map<std::pair<PCB_LAYER_ID, PCB_LAYER_ID>, std::vector<BOARD_ITEM*> > PCB_IO_IPC2581::m_drill_layers
private

Definition at line 323 of file pcb_io_ipc2581.h.

Referenced by generateDrillLayers(), and generateLayerSetDrill().

◆ m_enterpriseNode

wxXmlNode* PCB_IO_IPC2581::m_enterpriseNode
private

Definition at line 285 of file pcb_io_ipc2581.h.

Referenced by generateAvlSection(), generateLogisticSection(), and PCB_IO_IPC2581().

◆ m_footprint_dict

std::map<size_t, wxString> PCB_IO_IPC2581::m_footprint_dict
private

Definition at line 305 of file pcb_io_ipc2581.h.

Referenced by addPackage(), and generateBOMSection().

◆ m_footprint_refdes_dict

std::map<wxString, FOOTPRINT*> PCB_IO_IPC2581::m_footprint_refdes_dict
private

Definition at line 308 of file pcb_io_ipc2581.h.

Referenced by componentName().

◆ m_footprint_refdes_reverse_dict

std::map<FOOTPRINT*, wxString> PCB_IO_IPC2581::m_footprint_refdes_reverse_dict
private

Definition at line 311 of file pcb_io_ipc2581.h.

Referenced by componentName().

◆ m_last_padstack

wxXmlNode* PCB_IO_IPC2581::m_last_padstack
private

◆ m_layer_name_map

std::map<PCB_LAYER_ID, wxString> PCB_IO_IPC2581::m_layer_name_map
private

◆ m_line_dict

std::map<size_t, wxString> PCB_IO_IPC2581::m_line_dict
private

Definition at line 297 of file pcb_io_ipc2581.h.

Referenced by addLineDesc().

◆ m_line_node

wxXmlNode* PCB_IO_IPC2581::m_line_node
private

Definition at line 298 of file pcb_io_ipc2581.h.

Referenced by addLineDesc(), generateContentSection(), and PCB_IO_IPC2581().

◆ m_loaded_footprints

std::vector<FOOTPRINT*> PCB_IO_IPC2581::m_loaded_footprints
private

Definition at line 288 of file pcb_io_ipc2581.h.

Referenced by clearLoadedFootprints(), and GetImportedCachedLibraryFootprints().

◆ m_mfg

wxString PCB_IO_IPC2581::m_mfg
private

Definition at line 279 of file pcb_io_ipc2581.h.

Referenced by generateAvlSection(), and SaveBoard().

◆ m_mpn

wxString PCB_IO_IPC2581::m_mpn
private

Definition at line 278 of file pcb_io_ipc2581.h.

Referenced by generateAvlSection(), and SaveBoard().

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

std::map<int, std::vector<std::pair<wxString, wxString> > > PCB_IO_IPC2581::m_net_pin_dict
private

Definition at line 317 of file pcb_io_ipc2581.h.

Referenced by addPackage(), and generateLogicalNets().

◆ m_OEMRef

wxString PCB_IO_IPC2581::m_OEMRef
private

Definition at line 277 of file pcb_io_ipc2581.h.

Referenced by generateComponents(), and SaveBoard().

◆ m_OEMRef_dict

std::map<FOOTPRINT*, wxString> PCB_IO_IPC2581::m_OEMRef_dict
private

Definition at line 314 of file pcb_io_ipc2581.h.

Referenced by generateAvlSection(), generateBOMSection(), and generateComponents().

◆ m_padstack_dict

std::map<size_t, wxString> PCB_IO_IPC2581::m_padstack_dict
private

Definition at line 300 of file pcb_io_ipc2581.h.

Referenced by addPadStack(), and generateLayerSetDrill().

◆ m_padstacks

std::vector<wxXmlNode*> PCB_IO_IPC2581::m_padstacks
private

Definition at line 301 of file pcb_io_ipc2581.h.

Referenced by addPadStack(), and generateComponents().

◆ m_progress_reporter

PROGRESS_REPORTER* PCB_IO_IPC2581::m_progress_reporter
private

Definition at line 328 of file pcb_io_ipc2581.h.

Referenced by PCB_IO_IPC2581().

◆ m_progressReporter

◆ m_props

const STRING_UTF8_MAP* PCB_IO_IPC2581::m_props
private

Definition at line 289 of file pcb_io_ipc2581.h.

Referenced by PCB_IO_IPC2581().

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

double PCB_IO_IPC2581::m_scale
private

◆ m_shape_std_node

wxXmlNode* PCB_IO_IPC2581::m_shape_std_node
private

Definition at line 295 of file pcb_io_ipc2581.h.

Referenced by addShape(), generateContentSection(), and PCB_IO_IPC2581().

◆ m_shape_user_node

wxXmlNode* PCB_IO_IPC2581::m_shape_user_node
private

Definition at line 292 of file pcb_io_ipc2581.h.

Referenced by addShape(), generateContentSection(), and PCB_IO_IPC2581().

◆ m_sigfig

int PCB_IO_IPC2581::m_sigfig
private

Definition at line 275 of file pcb_io_ipc2581.h.

Referenced by floatVal(), PCB_IO_IPC2581(), and SaveBoard().

◆ m_slot_holes

std::map<std::pair<PCB_LAYER_ID, PCB_LAYER_ID>, std::vector<PAD*> > PCB_IO_IPC2581::m_slot_holes
private

Definition at line 326 of file pcb_io_ipc2581.h.

Referenced by generateDrillLayers(), and generateLayerSetDrill().

◆ m_std_shape_dict

std::map<size_t, wxString> PCB_IO_IPC2581::m_std_shape_dict
private

Definition at line 294 of file pcb_io_ipc2581.h.

Referenced by addShape().

◆ m_total_bytes

size_t PCB_IO_IPC2581::m_total_bytes
private

◆ m_units_str

wxString PCB_IO_IPC2581::m_units_str
private

Definition at line 273 of file pcb_io_ipc2581.h.

Referenced by addCadHeader(), generateContentSection(), and SaveBoard().

◆ m_user_shape_dict

std::map<size_t, wxString> PCB_IO_IPC2581::m_user_shape_dict
private

Definition at line 291 of file pcb_io_ipc2581.h.

Referenced by addShape().

◆ m_version

◆ m_xml_doc

wxXmlDocument* PCB_IO_IPC2581::m_xml_doc
private

Definition at line 332 of file pcb_io_ipc2581.h.

Referenced by generateXmlHeader(), PCB_IO_IPC2581(), and SaveBoard().

◆ m_xml_root


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