KiCad PCB EDA Suite
Loading...
Searching...
No Matches
job_pcb_import.h
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 The KiCad Developers, see AUTHORS.txt for contributors.
5 *
6 * This program is free software: you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation, either version 3 of the License, or (at your
9 * option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * 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, see <https://www.gnu.org/licenses/>.
18 */
19
20#ifndef JOB_PCB_IMPORT_H
21#define JOB_PCB_IMPORT_H
22
23#include <kicommon.h>
24#include <core/utf8.h>
25#include <map>
26#include <string>
27#include <utility>
28#include <vector>
29
31
32#include "job.h"
33#include "job_import_utils.h"
34
42{
43public:
45
46 wxString GetDefaultDescription() const override;
47 wxString GetSettingsDialogTitle() const override;
48
62
63 wxString m_inputFile;
66 wxString m_reportFile;
67
71 std::map<wxString, wxString> m_layerMap;
72
73 std::map<wxString, wxString> m_netNameMap;
74 bool m_probeOnly = false;
76 wxString m_importPcbId;
79
81 wxString m_netlistFile;
82
84 std::map<std::string, UTF8> m_properties;
85
88 std::vector<wxString> m_localLibraries;
89
91 std::map<wxString, wxString> m_footprintIds;
92
94 bool m_projectHasNoBoard = false;
95
97 std::vector<std::pair<wxString, wxString>> m_projectBoards;
98
100 std::vector<IMPORT_PROJECT_DESC> m_projectEntries;
101};
102
103#endif
bool m_projectHasNoBoard
Set by a probe of a project archive that holds no board.
wxString m_importPcbId
EasyEDA Pro PCB document identifier selected by project-level import.
std::map< wxString, wxString > m_layerMap
Explicit overrides from source layer name to KiCad layer name (canonical board-file name,...
std::map< wxString, wxString > m_netNameMap
wxString m_netlistFile
Netlist of the imported schematic, whose net names the board takes where the two agree.
bool m_isPartOfMultiBoardProject
Avoid promoting an individual board's source settings into shared project settings.
wxString m_sourceProjectDir
Directory of the source project and the footprint libraries it names, registered before the import.
std::vector< wxString > m_localLibraries
std::map< wxString, wxString > m_footprintIds
Board reference to footprint LIB_ID, filled in by an import.
std::vector< std::pair< wxString, wxString > > m_projectBoards
PCB document identifier and source name pairs found during a probe.
wxString m_reportFile
IMPORT_REPORT_FORMAT m_reportFormat
std::map< std::string, UTF8 > m_properties
Library coordination properties, as IMPORT_PROJ_HELPER hands them to the editor.
wxString m_inputFile
std::vector< IMPORT_PROJECT_DESC > m_projectEntries
KiCad projects the source project splits into, found during a probe.
JOB(const std::string &aType, bool aOutputIsDirectory)
Definition job.cpp:26
virtual wxString GetDefaultDescription() const
Definition job.cpp:74
virtual wxString GetSettingsDialogTitle() const
Definition job.cpp:80
IMPORT_REPORT_FORMAT
Output format for the report shared by the board and schematic import jobs.
#define KICOMMON_API
Definition kicommon.h:27
Reader for TARGET 3001!