LibrePCB

/*
 * 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_EDITOR_CMDBUSEDIT_H
#define LIBREPCB_EDITOR_CMDBUSEDIT_H

/*******************************************************************************
 *  Includes
 ******************************************************************************/
#include "../../undocommand.h"

#include <librepcb/core/types/busname.h>

#include <QtCore>

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

class Bus;
class Circuit;

namespace editor {

/*******************************************************************************
 *  Class CmdBusSetName
 ******************************************************************************/

/**
 * @brief The CmdBusSetName class
 */
class CmdBusEdit final : public UndoCommand {
public:
  // Constructors / Destructor
  CmdBusEdit() = delete;
  explicit CmdBusEdit(Bus& bus) noexcept;
  ~CmdBusEdit() noexcept override;

  // Setters
  void setName(const BusName& name, bool isAutoName) noexcept;
  void setPrefixNetNames(bool prefix) noexcept;
  void setMaxTraceLengthDifference(
      const std::optional<UnsignedLength>& diff) noexcept;

private:
  // Private Methods

  /// @copydoc ::librepcb::editor::UndoCommand::performExecute()
  bool performExecute() override;

  /// @copydoc ::librepcb::editor::UndoCommand::performUndo()
  void performUndo() override;

  /// @copydoc ::librepcb::editor::UndoCommand::performRedo()
  void performRedo() override;

  // Private Member Variables

  // Attributes from the constructor
  Circuit& mCircuit;
  Bus& mBus;

  // General Attributes
  BusName mOldName;
  BusName mNewName;
  bool mOldIsAutoName;
  bool mNewIsAutoName;
  bool mOldPrefixNetNames;
  bool mNewPrefixNetNames;
  std::optional<UnsignedLength> mOldMaxTraceLengthDifference;
  std::optional<UnsignedLength> mNewMaxTraceLengthDifference;
};

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

}  // namespace editor
}  // namespace librepcb

#endif