CmdComponentInstanceAdd Class Reference

The CmdComponentInstanceAdd class. More...

#include <cmdcomponentinstanceadd.h>

Inheritance diagram for CmdComponentInstanceAdd:

Collaboration diagram for CmdComponentInstanceAdd:

Public Member Functions
	CmdComponentInstanceAdd (Circuit &circuit, const Uuid &cmp, const Uuid &symbVar, const ComponentAssemblyOptionList &options) noexcept
	CmdComponentInstanceAdd (Circuit &circuit, ComponentInstance *component) noexcept
	~CmdComponentInstanceAdd () noexcept
ComponentInstance *	getComponentInstance () const noexcept
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)
bool	wasEverReverted () const noexcept
	This method shows whether that command was ever reverted (undo() called at least one time)
bool	isCurrentlyExecuted () const noexcept
	This method shows whether that command is currently executed (redo() called one time more than undo())
virtual bool	execute () final
	Execute the command (must only be called once)
virtual void	undo () final
	Undo the command.
virtual void	redo () final
	Redo the command.
UndoCommand &	operator= (const UndoCommand &rhs)=delete

Private Member Functions
bool	performExecute () override
	Execute the command the first time.
void	performUndo () override
	Undo the command.
void	performRedo () override
	Redo the command.

Private Attributes
Circuit &	mCircuit
Uuid	mComponentUuid
Uuid	mSymbVarUuid
ComponentAssemblyOptionList	mAssemblyOptions
ComponentInstance *	mComponentInstance
	The created component instance.

Additional Inherited Members

Detailed Description

The CmdComponentInstanceAdd class.

Constructor & Destructor Documentation

CmdComponentInstanceAdd() [1/2]

CmdComponentInstanceAdd ( Circuit &  circuit, const Uuid &  cmp, const Uuid &  symbVar, const ComponentAssemblyOptionList &  options  )

noexcept

CmdComponentInstanceAdd() [2/2]

CmdComponentInstanceAdd ( Circuit &  circuit, ComponentInstance *  component  )

noexcept

~CmdComponentInstanceAdd()

~CmdComponentInstanceAdd ( )

noexcept

Member Function Documentation

getComponentInstance()

ComponentInstance * getComponentInstance ( ) const

inlinenoexcept

Here is the caller graph for this function:

performExecute()

bool performExecute ( )

overrideprivatevirtual

Execute the command the first time.

Note

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

true	If the command has done some changes
false	If the command has done nothing (the command can be deleted)

Implements UndoCommand.

Here is the call graph for this function:

performUndo()

void performUndo ( )

overrideprivatevirtual

Undo the command.

Note

This method must be implemented in all derived classes.

Implements UndoCommand.

Here is the call graph for this function:

performRedo()

void performRedo ( )

overrideprivatevirtual

Redo the command.

Note

This method must be implemented in all derived classes.

Implements UndoCommand.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mCircuit

Circuit& mCircuit

private

mComponentUuid

Uuid mComponentUuid

private

mSymbVarUuid

Uuid mSymbVarUuid

private

mAssemblyOptions

ComponentAssemblyOptionList mAssemblyOptions

private

mComponentInstance

ComponentInstance* mComponentInstance

private

The created component instance.

---

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

• /__w/1/s/libs/librepcb/editor/project/cmd/cmdcomponentinstanceadd.h
• /__w/1/s/libs/librepcb/editor/project/cmd/cmdcomponentinstanceadd.cpp