CmdAddDeviceToBoard Class Reference

The CmdAddDeviceToBoard class. More...

#include <cmdadddevicetoboard.h>

Inheritance diagram for CmdAddDeviceToBoard:

Collaboration diagram for CmdAddDeviceToBoard:

Public Member Functions
	CmdAddDeviceToBoard (Workspace &workspace, Board &board, ComponentInstance &cmpInstance, const Uuid &deviceUuid, const std::optional< Uuid > &footprintUuid, const std::optional< Uuid > &preferredModelUuid, const Point &position=Point(), const Angle &rotation=Angle(), bool mirror=false) noexcept
	~CmdAddDeviceToBoard () noexcept
BI_Device *	getDeviceInstance () 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.
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)
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.

Private Attributes
Workspace &	mWorkspace
Board &	mBoard
ComponentInstance &	mComponentInstance
Uuid	mDeviceUuid
std::optional< Uuid >	mFootprintUuid
std::optional< Uuid >	mPreferredModelUuid
Point	mPosition
Angle	mRotation
bool	mMirror
BI_Device *	mDeviceInstance

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

Detailed Description

The CmdAddDeviceToBoard class.

Constructor & Destructor Documentation

CmdAddDeviceToBoard()

CmdAddDeviceToBoard ( Workspace &  workspace, Board &  board, ComponentInstance &  cmpInstance, const Uuid &  deviceUuid, const std::optional< Uuid > &  footprintUuid, const std::optional< Uuid > &  preferredModelUuid, const Point &  position = Point(), const Angle &  rotation = Angle(), bool  mirror = false  )

noexcept

~CmdAddDeviceToBoard()

~CmdAddDeviceToBoard ( )

noexcept

Member Function Documentation

getDeviceInstance()

BI_Device * getDeviceInstance ( ) 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)

Reimplemented from UndoCommandGroup.

Here is the call graph for this function:

Member Data Documentation

mWorkspace

Workspace& mWorkspace

private

mBoard

Board& mBoard

private

mComponentInstance

ComponentInstance& mComponentInstance

private

mDeviceUuid

Uuid mDeviceUuid

private

mFootprintUuid

std::optional<Uuid> mFootprintUuid

private

mPreferredModelUuid

std::optional<Uuid> mPreferredModelUuid

private

mPosition

Point mPosition

private

mRotation

Angle mRotation

private

mMirror

bool mMirror

private

mDeviceInstance

BI_Device* mDeviceInstance

private

---

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

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