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_PROJECT_CMDCOMPONENTINSTANCEADD_H
21 #define LIBREPCB_PROJECT_CMDCOMPONENTINSTANCEADD_H
22 
23 /*******************************************************************************
24  *  Includes
25  ******************************************************************************/
26 #include <librepcb/common/undocommand.h>
27 #include <librepcb/common/uuid.h>
28 
29 #include <QtCore>
30 
31 /*******************************************************************************
32  *  Namespace / Forward Declarations
33  ******************************************************************************/
34 namespace librepcb {
35 
36 namespace library {
37 class Component;
38 }
39 
40 namespace project {
41 
42 class Circuit;
43 class ComponentInstance;
44 
45 /*******************************************************************************
46  *  Class CmdComponentInstanceAdd
47  ******************************************************************************/
48 
49 /**
50  * @brief The CmdComponentInstanceAdd class
51  */
52 class CmdComponentInstanceAdd final : public UndoCommand {
53 public:
54   // Constructors / Destructor
55   CmdComponentInstanceAdd(
56       Circuit& circuit, const Uuid& cmp, const Uuid& symbVar,
57       const tl::optional<Uuid>& defaultDevice = tl::nullopt) noexcept;
58   CmdComponentInstanceAdd(Circuit& circuit,
59                           ComponentInstance* component) noexcept;
60   ~CmdComponentInstanceAdd() noexcept;
61 
62   // Getters
getComponentInstance()63   ComponentInstance* getComponentInstance() const noexcept {
64     return mComponentInstance;
65   }
66 
67 private:
68   // Private Methods
69 
70   /// @copydoc UndoCommand::performExecute()
71   bool performExecute() override;
72 
73   /// @copydoc UndoCommand::performUndo()
74   void performUndo() override;
75 
76   /// @copydoc UndoCommand::performRedo()
77   void performRedo() override;
78 
79   // Private Member Variables
80 
81   // Attributes from the constructor
82   Circuit& mCircuit;
83   Uuid mComponentUuid;
84   Uuid mSymbVarUuid;
85   tl::optional<Uuid> mDefaultDeviceUuid;
86 
87   /// @brief The created component instance
88   ComponentInstance* mComponentInstance;
89 };
90 
91 /*******************************************************************************
92  *  End of File
93  ******************************************************************************/
94 
95 }  // namespace project
96 }  // namespace librepcb
97 
98 #endif  // LIBREPCB_PROJECT_CMDCOMPONENTINSTANCEADD_H
99