CmdBusEdit Class Reference

The CmdBusSetName class. More...

#include <cmdbusedit.h>

Inheritance diagram for CmdBusEdit:

Collaboration diagram for CmdBusEdit:

Public Member Functions
	CmdBusEdit ()=delete
	CmdBusEdit (Bus &bus) noexcept
	~CmdBusEdit () noexcept
void	setName (const BusName &name, bool isAutoName) noexcept
void	setPrefixNetNames (bool prefix) noexcept
void	setMaxTraceLengthDifference (const std::optional< UnsignedLength > &diff) 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
Bus &	mBus
BusName	mOldName
BusName	mNewName
bool	mOldIsAutoName
bool	mNewIsAutoName
bool	mOldPrefixNetNames
bool	mNewPrefixNetNames
std::optional< UnsignedLength >	mOldMaxTraceLengthDifference
std::optional< UnsignedLength >	mNewMaxTraceLengthDifference

Additional Inherited Members
Protected Attributes inherited from UndoCommand
QString	mText

Detailed Description

The CmdBusSetName class.

Constructor & Destructor Documentation

CmdBusEdit() [1/2]

CmdBusEdit ( )

delete

CmdBusEdit() [2/2]

CmdBusEdit ( Bus &  bus )

explicitnoexcept

~CmdBusEdit()

~CmdBusEdit ( )

noexcept

Member Function Documentation

setName()

void setName ( const BusName &  name, bool  isAutoName  )

noexcept

setPrefixNetNames()

void setPrefixNetNames ( bool  prefix )

noexcept

Here is the caller graph for this function:

setMaxTraceLengthDifference()

void setMaxTraceLengthDifference ( const std::optional< UnsignedLength > &  diff )

noexcept

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

mBus

Bus& mBus

private

mOldName

BusName mOldName

private

mNewName

BusName mNewName

private

mOldIsAutoName

bool mOldIsAutoName

private

mNewIsAutoName

bool mNewIsAutoName

private

mOldPrefixNetNames

bool mOldPrefixNetNames

private

mNewPrefixNetNames

bool mNewPrefixNetNames

private

mOldMaxTraceLengthDifference

std::optional<UnsignedLength> mOldMaxTraceLengthDifference

private

mNewMaxTraceLengthDifference

std::optional<UnsignedLength> mNewMaxTraceLengthDifference

private

---

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

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