LibrePCB Developers Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
CmdComponentSignalEdit Class Referencefinal

The CmdComponentSignalEdit class. More...

#include <cmdcomponentsignaledit.h>

+ Inheritance diagram for CmdComponentSignalEdit:
+ Collaboration diagram for CmdComponentSignalEdit:

Public Member Functions

 CmdComponentSignalEdit ()=delete
 
 CmdComponentSignalEdit (const CmdComponentSignalEdit &other)=delete
 
 CmdComponentSignalEdit (ComponentSignal &signal) noexcept
 
 ~CmdComponentSignalEdit () noexcept
 
void setName (const CircuitIdentifier &name) noexcept
 
void setRole (const SignalRole &role) noexcept
 
void setForcedNetName (const QString &name) noexcept
 
void setIsRequired (bool required) noexcept
 
void setIsNegated (bool negated) noexcept
 
void setIsClock (bool clock) noexcept
 
CmdComponentSignalEditoperator= (const CmdComponentSignalEdit &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...
 
void performUndo () override
 Undo the command. More...
 
void performRedo () override
 Redo the command. More...
 

Private Attributes

ComponentSignalmSignal
 
CircuitIdentifier mOldName
 
CircuitIdentifier mNewName
 
SignalRole mOldRole
 
SignalRole mNewRole
 
QString mOldForcedNetName
 
QString mNewForcedNetName
 
bool mOldIsRequired
 
bool mNewIsRequired
 
bool mOldIsNegated
 
bool mNewIsNegated
 
bool mOldIsClock
 
bool mNewIsClock
 

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

CmdComponentSignalEdit ( ComponentSignal signal)
explicitnoexcept
~CmdComponentSignalEdit ( )
noexcept

Member Function Documentation

void setName ( const CircuitIdentifier name)
noexcept
void setRole ( const SignalRole role)
noexcept
void setForcedNetName ( const QString &  name)
noexcept
void setIsRequired ( bool  required)
noexcept
void setIsNegated ( bool  negated)
noexcept
void setIsClock ( bool  clock)
noexcept
CmdComponentSignalEdit& operator= ( const CmdComponentSignalEdit rhs)
delete
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 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)

Implements UndoCommand.

+ Here is the call graph for this function:

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:

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

ComponentSignal& mSignal
private
CircuitIdentifier mOldName
private
CircuitIdentifier mNewName
private
SignalRole mOldRole
private
SignalRole mNewRole
private
QString mOldForcedNetName
private
QString mNewForcedNetName
private
bool mOldIsRequired
private
bool mNewIsRequired
private
bool mOldIsNegated
private
bool mNewIsNegated
private
bool mOldIsClock
private
bool mNewIsClock
private

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