KiCad PCB EDA Suite
board_exporter_base.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 (C) 2019 CERN
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
24#ifndef __BOARD_EXPORTER_BASE_H
25#define __BOARD_EXPORTER_BASE_H
26
27#include <string_utf8_map.h>
28#include <wx/file.h>
29
30class BOARD;
31class REPORTER;
33
34class wxDialog;
35
37{
38public:
40 {
41 };
42
44 {
45 };
46
47 void SetOutputFilename( const wxFileName& aPath )
48 {
49 m_outputFilePath = aPath;
50 }
51
52 void SetBoard( BOARD* aBoard )
53 {
54 m_board = aBoard;
55 }
56
57 void SetReporter( REPORTER* aReporter )
58 {
59 m_reporter = aReporter;
60 }
61
62 void SetProgressReporter( PROGRESS_REPORTER *aProgressReporter )
63 {
64 m_progressReporter = aProgressReporter;
65 }
66
67 virtual bool Run() = 0;
68
69protected:
71 BOARD* m_board = nullptr;
72 wxFileName m_outputFilePath;
73 REPORTER* m_reporter = nullptr;
75};
76
77#endif
PROGRESS_REPORTER * m_progressReporter
void SetReporter(REPORTER *aReporter)
virtual bool Run()=0
void SetOutputFilename(const wxFileName &aPath)
void SetBoard(BOARD *aBoard)
STRING_UTF8_MAP m_properties
void SetProgressReporter(PROGRESS_REPORTER *aProgressReporter)
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:265
A progress reporter interface for use in multi-threaded environments.
A pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:71
A name/value tuple with unique names and optional values.