KiCad PCB EDA Suite
altium_designer_plugin.cpp
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2019 Thomas Pointhuber <thomas.pointhuber@gmx.at>
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, you may find one here:
18  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19  * or you may search the http://www.gnu.org website for the version 2 license,
20  * or you may write to the Free Software Foundation, Inc.,
21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22  */
23 
29 #include <iomanip>
30 
31 #include <wx/string.h>
32 
33 #include <altium_designer_plugin.h>
34 #include <altium_pcb.h>
35 
36 #include <class_board.h>
37 
38 #include <compoundfilereader.h>
39 #include <utf.h>
40 
42 {
43  m_board = nullptr;
44  m_props = nullptr;
45 }
46 
47 
49 {
50 }
51 
52 
53 const wxString ALTIUM_DESIGNER_PLUGIN::PluginName() const
54 {
55  return wxT( "Altium Designer" );
56 }
57 
58 
60 {
61  return wxT( "PcbDoc" );
62 }
63 
64 
66  const wxString& aFileName, BOARD* aAppendToMe, const PROPERTIES* aProperties )
67 {
68  m_props = aProperties;
69 
70  m_board = aAppendToMe ? aAppendToMe : new BOARD();
71 
72  // Give the filename to the board if it's new
73  if( !aAppendToMe )
74  m_board->SetFileName( aFileName );
75 
76  // clang-format off
77  const std::map<ALTIUM_PCB_DIR, std::string> mapping = {
78  { ALTIUM_PCB_DIR::FILE_HEADER, "FileHeader" },
79  { ALTIUM_PCB_DIR::ARCS6, "Arcs6\\Data" },
80  { ALTIUM_PCB_DIR::BOARD6, "Board6\\Data" },
81  { ALTIUM_PCB_DIR::BOARDREGIONS, "BoardRegions\\Data" },
82  { ALTIUM_PCB_DIR::CLASSES6, "Classes6\\Data" },
83  { ALTIUM_PCB_DIR::COMPONENTS6, "Components6\\Data" },
84  { ALTIUM_PCB_DIR::COMPONENTBODIES6, "ComponentBodies6\\Data" },
85  { ALTIUM_PCB_DIR::DIMENSIONS6, "Dimensions6\\Data" },
86  { ALTIUM_PCB_DIR::FILLS6, "Fills6\\Data" },
87  { ALTIUM_PCB_DIR::MODELS, "Models\\Data" },
88  { ALTIUM_PCB_DIR::NETS6, "Nets6\\Data" },
89  { ALTIUM_PCB_DIR::PADS6, "Pads6\\Data" },
90  { ALTIUM_PCB_DIR::POLYGONS6, "Polygons6\\Data" },
91  { ALTIUM_PCB_DIR::REGIONS6, "Regions6\\Data" },
92  { ALTIUM_PCB_DIR::RULES6, "Rules6\\Data" },
93  { ALTIUM_PCB_DIR::SHAPEBASEDREGIONS6, "ShapeBasedRegions6\\Data" },
94  { ALTIUM_PCB_DIR::TEXTS6, "Texts6\\Data" },
95  { ALTIUM_PCB_DIR::TRACKS6, "Tracks6\\Data" },
96  { ALTIUM_PCB_DIR::VIAS6, "Vias6\\Data" }
97  };
98  // clang-format on
99 
100  ParseAltiumPcb( m_board, aFileName, mapping );
101 
102  return m_board;
103 }
PROPERTIES is a name/value tuple with unique names and optional values.
Definition: properties.h:34
BOARD * Load(const wxString &aFileName, BOARD *aAppendToMe, const PROPERTIES *aProperties) override
Function Load loads information from some input file format that this PLUGIN implementation knows abo...
const wxString GetFileExtension() const override
Function GetFileExtension returns the file extension for the PLUGIN.
void SetFileName(const wxString &aFileName)
Definition: class_board.h:242
const wxString PluginName() const override
Function PluginName returns a brief hard coded name for this PLUGIN.
BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:178
void ParseAltiumPcb(BOARD *aBoard, const wxString &aFileName, const std::map< ALTIUM_PCB_DIR, std::string > &aFileMapping)
Helper method which opens a Altium Board File and parses it.
Definition: altium_pcb.cpp:50