bom.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_BOM_H
#define LIBREPCB_CORE_BOM_H

/*******************************************************************************
 *  Includes
 ******************************************************************************/
#include <QtCore>

/*******************************************************************************
 *  Namespace / Forward Declarations
 ******************************************************************************/
namespace librepcb {

/*******************************************************************************
 *  Class BomItem
 ******************************************************************************/

class BomItem final {
  Q_DECLARE_TR_FUNCTIONS(BomItem)

public:
  // Constructors / Destructor
  BomItem() = delete;
  BomItem(const QString& designator, const QStringList& attributes,
          bool mount) noexcept
    : mDesignators({designator}), mAttributes(attributes), mMount(mount) {}
  BomItem(const BomItem& other) noexcept
    : mDesignators(other.mDesignators),
      mAttributes(other.mAttributes),
      mMount(other.mMount) {}
  ~BomItem() noexcept {}

  // Getters
  const QStringList& getDesignators() const noexcept { return mDesignators; }
  const QStringList& getAttributes() const noexcept { return mAttributes; }
  bool isMount() const noexcept { return mMount; }

  // General Methods
  void addDesignator(const QString& designator) noexcept;

  // Operator Overloadings
  BomItem& operator=(const BomItem& rhs) noexcept {
    mDesignators = rhs.mDesignators;
    mAttributes = rhs.mAttributes;
    mMount = rhs.mMount;
    return *this;
  }

private:
  QStringList mDesignators;
  QStringList mAttributes;
  bool mMount;  
};

/*******************************************************************************
 *  Class Bom
 ******************************************************************************/

class Bom final {
  Q_DECLARE_TR_FUNCTIONS(Bom)

public:
  // Types
  typedef std::pair<int, int> IndexPair;

  // Constructors / Destructor
  Bom() = delete;
  Bom(const Bom& other) noexcept = delete;
  Bom(const QStringList& columns,
      const QVector<IndexPair>& mpnManufacturerColumns) noexcept;
  ~Bom() noexcept;

  // Getters
  const QStringList& getColumns() const noexcept { return mColumns; }
  const QVector<IndexPair>& getMpnManufacturerColumns() const noexcept {
    return mMpnManufacturerColumns;
  }
  const QList<BomItem>& getItems() const noexcept { return mItems; }
  int getAssembledRowsCount() const noexcept;
  int getTotalAssembledPartsCount() const noexcept;

  // General Methods
  void addItem(const QString& designator, const QStringList& attributes,
               bool mount) noexcept;

  // Operator Overloadings
  Bom& operator=(const Bom& rhs) noexcept = delete;

private:
  QStringList mColumns;
  QVector<IndexPair> mMpnManufacturerColumns;
  QList<BomItem> mItems;
};

/*******************************************************************************
 *  End of File
 ******************************************************************************/

}  // namespace librepcb

#endif