boardinteractivehtmlbomgenerator.h

Go to the documentation of this file.

/*
 * LibrePCB - Professional EDA for everyone!
 * Copyright (C) 2013 LibrePCB Developers, see AUTHORS.md for contributors.
 * https://librepcb.org/
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef LIBREPCB_CORE_BOARDINTERACTIVEHTMLBOMGENERATOR_H
#define LIBREPCB_CORE_BOARDINTERACTIVEHTMLBOMGENERATOR_H
 
/*******************************************************************************
 *  Includes
 ******************************************************************************/
#include "../../types/uuid.h"
 
#include <QtCore>
 
#include <memory>
 
/*******************************************************************************
 *  Namespace / Forward Declarations
 ******************************************************************************/
namespace librepcb {
 
class AssemblyVariant;
class Board;
class InteractiveHtmlBom;
 
/*******************************************************************************
 *  Class BoardInteractiveHtmlBomGenerator
 ******************************************************************************/
 
class BoardInteractiveHtmlBomGenerator final {
  Q_DECLARE_TR_FUNCTIONS(BoardInteractiveHtmlBomGenerator)
 
public:
  // Constructors / Destructor
  BoardInteractiveHtmlBomGenerator() = delete;
  BoardInteractiveHtmlBomGenerator(
      const BoardInteractiveHtmlBomGenerator& other) = delete;
  explicit BoardInteractiveHtmlBomGenerator(
      const Board& board, const std::shared_ptr<AssemblyVariant>& av) noexcept;
  ~BoardInteractiveHtmlBomGenerator() noexcept;
 
  // General Methods
  void setCustomAttributes(const QStringList& attributes) noexcept;
  void setComponentOrder(const QStringList& order) noexcept;
  std::shared_ptr<InteractiveHtmlBom> generate(const QDateTime& dt);
 
  // Operator Overloadings
  BoardInteractiveHtmlBomGenerator& operator=(
      const BoardInteractiveHtmlBomGenerator& rhs) = delete;
 
private:
  const Board& mBoard;
  const std::shared_ptr<AssemblyVariant> mAssemblyVariant;
  QStringList mCustomAttributes;
  QStringList mComponentOrder;
};
class BoardInteractiveHtmlBomGenerator final {…};
 
/*******************************************************************************
 *  End of File
 ******************************************************************************/
 
}  // namespace librepcb
 
#endif