gerberaperturelist.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_GERBERAPERTURELIST_H
#define LIBREPCB_CORE_GERBERAPERTURELIST_H

/*******************************************************************************
 *  Includes
 ******************************************************************************/
#include "../fileio/filepath.h"
#include "../geometry/path.h"
#include "../types/length.h"
#include "../types/uuid.h"
#include "gerberattribute.h"

#include <QtCore>

#include <optional.hpp>

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

class Angle;

/*******************************************************************************
 *  Class GerberApertureList
 ******************************************************************************/

class GerberApertureList final {
  Q_DECLARE_TR_FUNCTIONS(GerberApertureList)

public:
  // Types
  using Function = tl::optional<GerberAttribute::ApertureFunction>;

  // Constructors / Destructor
  GerberApertureList() noexcept;
  GerberApertureList(const GerberApertureList& other) = delete;
  ~GerberApertureList() noexcept;

  // Getters

  QString generateString() const noexcept;

  // General Methods

  int addCircle(const UnsignedLength& dia, Function function);

  int addObround(const PositiveLength& w, const PositiveLength& h,
                 const Angle& rot, Function function) noexcept;

  int addRect(const PositiveLength& w, const PositiveLength& h,
              const UnsignedLength& r, const Angle& rot,
              Function function) noexcept;

  int addOctagon(const PositiveLength& w, const PositiveLength& h,
                 const UnsignedLength& r, const Angle& rot,
                 Function function) noexcept;

  int addOutline(const StraightAreaPath& path, const Angle& rot,
                 Function function) noexcept;

  int addComponentMain() noexcept;

  int addComponentPin(bool isPin1) noexcept;

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

private:  // Methods
  int addOutline(const QString& name, const Path& path, const Angle& rot,
                 Function function) noexcept;

  QString buildOutlineMacro(Path path, const Angle& rot) const noexcept;

  int addAperture(QString aperture, Function function) noexcept;

private:  // Data
  QMap<int, std::pair<Function, QString>> mApertures;
};

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

}  // namespace librepcb

#endif