LibrePCB Developers Documentation
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
boardinteractivehtmlbomgenerator.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_CORE_BOARDINTERACTIVEHTMLBOMGENERATOR_H
21#define LIBREPCB_CORE_BOARDINTERACTIVEHTMLBOMGENERATOR_H
22
23/*******************************************************************************
24 * Includes
25 ******************************************************************************/
26#include "../../types/uuid.h"
27
28#include <QtCore>
29
30#include <memory>
31
32/*******************************************************************************
33 * Namespace / Forward Declarations
34 ******************************************************************************/
35namespace librepcb {
36
37class AssemblyVariant;
38class Board;
39class InteractiveHtmlBom;
40
41/*******************************************************************************
42 * Class BoardInteractiveHtmlBomGenerator
43 ******************************************************************************/
44
49 Q_DECLARE_TR_FUNCTIONS(BoardInteractiveHtmlBomGenerator)
50
51public:
52 // Constructors / Destructor
55 const BoardInteractiveHtmlBomGenerator& other) = delete;
57 const Board& board, const std::shared_ptr<AssemblyVariant>& av) noexcept;
59
60 // General Methods
61 void setCustomAttributes(const QStringList& attributes) noexcept;
62 void setComponentOrder(const QStringList& order) noexcept;
63 std::shared_ptr<InteractiveHtmlBom> generate(const QDateTime& dt);
64
65 // Operator Overloadings
67 const BoardInteractiveHtmlBomGenerator& rhs) = delete;
68
69private:
70 const Board& mBoard;
72 QStringList mCustomAttributes;
73 QStringList mComponentOrder;
74};
75
76/*******************************************************************************
77 * End of File
78 ******************************************************************************/
79
80} // namespace librepcb
81
82#endif
The AssemblyVariant class.
Definition assemblyvariant.h:44
The Board class represents a PCB of a project and is always part of a circuit.
Definition board.h:73
The BoardInteractiveHtmlBomGenerator class.
Definition boardinteractivehtmlbomgenerator.h:48
const Board & mBoard
Definition boardinteractivehtmlbomgenerator.h:70
QStringList mComponentOrder
Definition boardinteractivehtmlbomgenerator.h:73
void setCustomAttributes(const QStringList &attributes) noexcept
Definition boardinteractivehtmlbomgenerator.cpp:73
BoardInteractiveHtmlBomGenerator(const BoardInteractiveHtmlBomGenerator &other)=delete
const std::shared_ptr< AssemblyVariant > mAssemblyVariant
Definition boardinteractivehtmlbomgenerator.h:71
QStringList mCustomAttributes
Definition boardinteractivehtmlbomgenerator.h:72
std::shared_ptr< InteractiveHtmlBom > generate(const QDateTime &dt)
Definition boardinteractivehtmlbomgenerator.cpp:83
void setComponentOrder(const QStringList &order) noexcept
Definition boardinteractivehtmlbomgenerator.cpp:78
~BoardInteractiveHtmlBomGenerator() noexcept
Definition boardinteractivehtmlbomgenerator.cpp:66
Zip file reader.
Definition interactivehtmlbom.h:55
Definition occmodel.cpp:77
Definition uuid.h:186