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

ComponentInstance *	getComponentInstance () 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...

UndoCommandGroup &	operator= (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...

UndoCommand &	operator= (const UndoCommand &rhs)=delete

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

Private Attributes
Workspace &	mWorkspace

Project &	mProject

Uuid	mComponentUuid

Uuid	mSymbVarUuid

tl::optional< ComponentAssemblyOptionList >	mAssemblyOptions

CmdComponentInstanceAdd *	mCmdAddToCircuit

Additional Inherited Members
Protected Member Functions inherited from UndoCommandGroup
virtual bool	performExecute () override
	Execute the command the first time. More...

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...

virtual bool	performExecute ()=0
	Execute the command the first time. More...

virtual void	performUndo ()=0
	Undo the command. More...

virtual void	performRedo ()=0
	Redo the command. More...

Detailed Description

The CmdAddComponentToCircuit class.

Constructor & Destructor Documentation

◆ CmdAddComponentToCircuit()

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

noexcept

◆ ~CmdAddComponentToCircuit()

~CmdAddComponentToCircuit ( )

noexcept

Member Function Documentation

◆ getComponentInstance()

ComponentInstance * getComponentInstance ( ) const

noexcept

Here is the call 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)

Reimplemented from UndoCommandGroup.

Here is the call graph for this function:

Member Data Documentation

◆ mWorkspace

Workspace& mWorkspace

private

◆ mProject

Project& mProject

private

◆ mComponentUuid

Uuid mComponentUuid

private

◆ mSymbVarUuid

Uuid mSymbVarUuid

private

◆ mAssemblyOptions

tl::optional<ComponentAssemblyOptionList> mAssemblyOptions

private

◆ mCmdAddToCircuit

CmdComponentInstanceAdd* mCmdAddToCircuit

private

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

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

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CmdAddComponentToCircuit()

◆ ~CmdAddComponentToCircuit()

Member Function Documentation

◆ getComponentInstance()

◆ performExecute()

Member Data Documentation

◆ mWorkspace

◆ mProject

◆ mComponentUuid

◆ mSymbVarUuid

◆ mAssemblyOptions

◆ mCmdAddToCircuit