LibrePCB Developers Documentation
CmdAddComponentToCircuit Class Referencefinal

The CmdAddComponentToCircuit class. More...

#include <cmdaddcomponenttocircuit.h>

+ Inheritance diagram for CmdAddComponentToCircuit:
+ Collaboration diagram for CmdAddComponentToCircuit:

Public Member Functions

 CmdAddComponentToCircuit (Workspace &workspace, Project &project, const Uuid &component, const Uuid &symbolVariant, const tl::optional< ComponentAssemblyOptionList > &options) noexcept
 ~CmdAddComponentToCircuit () noexcept
ComponentInstancegetComponentInstance () const noexcept
- Public Member Functions inherited from UndoCommandGroup
 UndoCommandGroup ()=delete
 UndoCommandGroup (const UndoCommandGroup &other)=delete
 UndoCommandGroup (const QString &text) noexcept
virtual ~UndoCommandGroup () noexcept
int getChildCount () const noexcept
bool appendChild (UndoCommand *cmd)
 Append a new command to the list of child commands. More...
UndoCommandGroupoperator= (const UndoCommandGroup &rhs)=delete
- Public Member Functions inherited from UndoCommand
 UndoCommand ()=delete
 UndoCommand (const UndoCommand &other)=delete
 UndoCommand (const QString &text) noexcept
virtual ~UndoCommand () noexcept
const QString & getText () const noexcept
bool wasEverExecuted () const noexcept
 This method shows whether that command was ever executed (execute() called successfully) More...
bool wasEverReverted () const noexcept
 This method shows whether that command was ever reverted (undo() called at least one time) More...
bool isCurrentlyExecuted () const noexcept
 This method shows whether that command is currently executed (redo() called one time more than undo()) More...
virtual bool execute () final
 Execute the command (must only be called once) More...
virtual void undo () final
 Undo the command. More...
virtual void redo () final
 Redo the command. More...
UndoCommandoperator= (const UndoCommand &rhs)=delete

Private Member Functions

bool performExecute () override
 Execute the command the first time. More...

Private Attributes

Uuid mComponentUuid
Uuid mSymbVarUuid
tl::optional< ComponentAssemblyOptionListmAssemblyOptions

Additional Inherited Members

- Protected Member Functions inherited from UndoCommandGroup
virtual void performUndo () override
 Undo the command. More...
virtual void performRedo () override
 Redo the command. More...
virtual void performPostExecution () noexcept
 Perform custom actions after modifying the undo stack state. More...
void execNewChildCmd (UndoCommand *cmd)
 Helper method for derived classes to execute and add new child commands. More...

Detailed Description

Constructor & Destructor Documentation

◆ CmdAddComponentToCircuit()

CmdAddComponentToCircuit ( Workspace workspace,
Project project,
const Uuid component,
const Uuid symbolVariant,
const tl::optional< ComponentAssemblyOptionList > &  options 

◆ ~CmdAddComponentToCircuit()

~CmdAddComponentToCircuit ( )

Member Function Documentation

◆ getComponentInstance()

ComponentInstance * getComponentInstance ( ) const
+ Here is the call graph for this function:

◆ performExecute()

bool performExecute ( )

Execute the command the first time.

This method must be implemented in all derived classes. If the first time execution is exactly identical to an "redo" action, you can simple call librepcb::editor::UndoCommand::performRedo() in the implementation of this method.
Return values
trueIf the command has done some changes
falseIf the command has done nothing (the command can be deleted)

Reimplemented from UndoCommandGroup.

+ Here is the call graph for this function:

Member Data Documentation

◆ mWorkspace

Workspace& mWorkspace

◆ mProject

Project& mProject

◆ mComponentUuid

Uuid mComponentUuid

◆ mSymbVarUuid

Uuid mSymbVarUuid

◆ mAssemblyOptions

tl::optional<ComponentAssemblyOptionList> mAssemblyOptions

◆ mCmdAddToCircuit

CmdComponentInstanceAdd* mCmdAddToCircuit

The documentation for this class was generated from the following files: