CmdBoardSpecctraImport Class Reference

Undo command to import a Specctra session (SES) More...

#include <cmdboardspecctraimport.h>

Inheritance diagram for CmdBoardSpecctraImport:

Collaboration diagram for CmdBoardSpecctraImport:

Classes
struct	ComponentOut
struct	NetOut
struct	PadStackOut
struct	ViaOut
struct	WireOut

Public Types
enum class	Side

Public Member Functions
	CmdBoardSpecctraImport (Board &board, const SExpression &root, std::shared_ptr< MessageLogger > logger)
	~CmdBoardSpecctraImport () 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.

Static Private Member Functions
static std::optional< PositiveLength >	extractViaDrillDiameter (const QString &padStackId) noexcept
static std::optional< MaskConfig >	extractViaExposureConfig (const QString &padStackId) noexcept

Private Attributes
Project &	mProject
Circuit &	mCircuit
Board &	mBoard
std::shared_ptr< MessageLogger >	mLogger
std::optional< QList< ComponentOut > >	mComponents
QHash< QString, PadStackOut >	mPadStacks
QList< NetOut >	mNets

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

Undo command to import a Specctra session (SES)

Member Enumeration Documentation

Side

enum class Side

strong

Enumerator
Front
Back

Constructor & Destructor Documentation

CmdBoardSpecctraImport()

CmdBoardSpecctraImport ( Board &  board, const SExpression &  root, std::shared_ptr< MessageLogger >  logger  )

explicit

Here is the call graph for this function:

~CmdBoardSpecctraImport()

~CmdBoardSpecctraImport ( )

noexcept

Member Function Documentation

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:

extractViaDrillDiameter()

std::optional< PositiveLength > extractViaDrillDiameter ( const QString &  padStackId )

staticprivatenoexcept

Here is the call graph for this function:

Here is the caller graph for this function:

extractViaExposureConfig()

std::optional< MaskConfig > extractViaExposureConfig ( const QString &  padStackId )

staticprivatenoexcept

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mProject

Project& mProject

private

mCircuit

Circuit& mCircuit

private

mBoard

Board& mBoard

private

mLogger

std::shared_ptr<MessageLogger> mLogger

private

mComponents

std::optional<QList<ComponentOut> > mComponents

private

mPadStacks

QHash<QString, PadStackOut> mPadStacks

private

mNets

QList<NetOut> mNets

private

---

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

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