LibrePCB Developers Documentation
cmdcomponentinstanceadd.h
Go to the documentation of this file.
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_EDITOR_CMDCOMPONENTINSTANCEADD_H
21 #define LIBREPCB_EDITOR_CMDCOMPONENTINSTANCEADD_H
22 
23 /*******************************************************************************
24  * Includes
25  ******************************************************************************/
26 #include "../../undocommand.h"
27 
30 
31 #include <QtCore>
32 
33 /*******************************************************************************
34  * Namespace / Forward Declarations
35  ******************************************************************************/
36 namespace librepcb {
37 
38 class Circuit;
39 class Component;
40 class ComponentInstance;
41 
42 namespace editor {
43 
44 /*******************************************************************************
45  * Class CmdComponentInstanceAdd
46  ******************************************************************************/
47 
51 class CmdComponentInstanceAdd final : public UndoCommand {
52 public:
53  // Constructors / Destructor
54  CmdComponentInstanceAdd(Circuit& circuit, const Uuid& cmp,
55  const Uuid& symbVar,
56  const ComponentAssemblyOptionList& options) noexcept;
58  ComponentInstance* component) noexcept;
59  ~CmdComponentInstanceAdd() noexcept;
60 
61  // Getters
63  return mComponentInstance;
64  }
65 
66 private:
67  // Private Methods
68 
70  bool performExecute() override;
71 
73  void performUndo() override;
74 
76  void performRedo() override;
77 
78  // Private Member Variables
79 
80  // Attributes from the constructor
85 
88 };
89 
90 /*******************************************************************************
91  * End of File
92  ******************************************************************************/
93 
94 } // namespace editor
95 } // namespace librepcb
96 
97 #endif
CmdComponentInstanceAdd(Circuit &circuit, const Uuid &cmp, const Uuid &symbVar, const ComponentAssemblyOptionList &options) noexcept
Definition: cmdcomponentinstanceadd.cpp:43
~CmdComponentInstanceAdd() noexcept
Definition: cmdcomponentinstanceadd.cpp:64
The CmdComponentInstanceAdd class.
Definition: cmdcomponentinstanceadd.h:51
Definition: occmodel.cpp:77
Circuit & mCircuit
Definition: cmdcomponentinstanceadd.h:81
void performRedo() override
Redo the command.
Definition: cmdcomponentinstanceadd.cpp:100
bool performExecute() override
Execute the command the first time.
Definition: cmdcomponentinstanceadd.cpp:71
The Circuit class represents all electrical connections in a project (drawn in the schematics) ...
Definition: circuit.h:70
The UndoCommand class represents a command which you can undo/redo.
Definition: undocommand.h:46
void performUndo() override
Undo the command.
Definition: cmdcomponentinstanceadd.cpp:96
ComponentInstance * getComponentInstance() const noexcept
Definition: cmdcomponentinstanceadd.h:62
The ComponentInstance class.
Definition: componentinstance.h:54
Uuid mComponentUuid
Definition: cmdcomponentinstanceadd.h:82
Uuid mSymbVarUuid
Definition: cmdcomponentinstanceadd.h:83
ComponentInstance * mComponentInstance
The created component instance.
Definition: cmdcomponentinstanceadd.h:87
ComponentAssemblyOptionList mAssemblyOptions
Definition: cmdcomponentinstanceadd.h:84
The Uuid class is a replacement for QUuid to get UUID strings without {} braces.
Definition: uuid.h:58