LibrePCB Developers Documentation
bomgenerator.h
Go to the documentation of this file.
1 /*
2  * LibrePCB - Professional EDA for everyone!
3  * Copyright (C) 2013 LibrePCB Developers, see AUTHORS.md for contributors.
4  * https://librepcb.org/
5  *
6  * This program is free software: you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation, either version 3 of the License, or
9  * (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, see <http://www.gnu.org/licenses/>.
18  */
19 
20 #ifndef LIBREPCB_PROJECT_BOMGENERATOR_H
21 #define LIBREPCB_PROJECT_BOMGENERATOR_H
22 
23 /*******************************************************************************
24  * Includes
25  ******************************************************************************/
26 #include <QtCore>
27 
28 #include <memory>
29 
30 /*******************************************************************************
31  * Namespace / Forward Declarations
32  ******************************************************************************/
33 namespace librepcb {
34 
35 class Bom;
36 
37 namespace project {
38 
39 class Board;
40 class Project;
41 
42 /*******************************************************************************
43  * Class BomGenerator
44  ******************************************************************************/
45 
49 class BomGenerator final {
50  Q_DECLARE_TR_FUNCTIONS(BoardBomGenerator)
51 
52 public:
53  // Constructors / Destructor
54  BomGenerator() = delete;
55  BomGenerator(const BomGenerator& other) = delete;
56  explicit BomGenerator(const Project& project) noexcept;
57  ~BomGenerator() noexcept;
58 
59  // Setters
60  void setAdditionalAttributes(const QStringList& attributes) noexcept {
61  mAdditionalAttributes = attributes;
62  }
63 
64  // General Methods
65  std::shared_ptr<Bom> generate(const Board* board = nullptr) noexcept;
66 
67  // Operator Overloadings
68  BomGenerator& operator=(const BomGenerator& rhs) = delete;
69 
70 private:
71  const Project& mProject;
72  QStringList mAdditionalAttributes;
73 };
74 
75 /*******************************************************************************
76  * End of File
77  ******************************************************************************/
78 
79 } // namespace project
80 } // namespace librepcb
81 
82 #endif // LIBREPCB_PROJECT_BOMGENERATOR_H
Definition: airwiresbuilder.cpp:32
The Project class represents a whole (opened) project with all its content.
Definition: project.h:80
const Project & mProject
Definition: bomgenerator.h:71
QStringList mAdditionalAttributes
Definition: bomgenerator.h:72
~BomGenerator() noexcept
Definition: bomgenerator.cpp:52
BomGenerator & operator=(const BomGenerator &rhs)=delete
The BomGenerator class.
Definition: bomgenerator.h:49
The Board class represents a PCB of a project and is always part of a circuit.
Definition: board.h:83
std::shared_ptr< Bom > generate(const Board *board=nullptr) noexcept
Definition: bomgenerator.cpp:59
void setAdditionalAttributes(const QStringList &attributes) noexcept
Definition: bomgenerator.h:60