LibrePCB Developers Documentation
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
FileFormatMigrationUnstable Class Referencefinal

Migration to upgrade a previous unstable file format. More...

#include <fileformatmigrationunstable.h>

+ Inheritance diagram for FileFormatMigrationUnstable:
+ Collaboration diagram for FileFormatMigrationUnstable:

Public Member Functions

 FileFormatMigrationUnstable (QObject *parent=nullptr) noexcept
 
 FileFormatMigrationUnstable (const FileFormatMigrationUnstable &other)=delete
 
 ~FileFormatMigrationUnstable () noexcept
 
virtual void upgradeComponentCategory (TransactionalDirectory &dir) override
 
virtual void upgradePackageCategory (TransactionalDirectory &dir) override
 
virtual void upgradeSymbol (TransactionalDirectory &dir) override
 
virtual void upgradePackage (TransactionalDirectory &dir) override
 
virtual void upgradeComponent (TransactionalDirectory &dir) override
 
virtual void upgradeDevice (TransactionalDirectory &dir) override
 
virtual void upgradeLibrary (TransactionalDirectory &dir) override
 
virtual void upgradeWorkspaceData (TransactionalDirectory &dir) override
 
FileFormatMigrationUnstable & operator= (const FileFormatMigrationUnstable &rhs)=delete
 
- Public Member Functions inherited from FileFormatMigrationV1
 FileFormatMigrationV1 (QObject *parent=nullptr) noexcept
 
 FileFormatMigrationV1 (const FileFormatMigrationV1 &other)=delete
 
virtual ~FileFormatMigrationV1 () noexcept
 
virtual void upgradeOrganization (TransactionalDirectory &dir) override
 
virtual void upgradeProject (TransactionalDirectory &dir, QList< Message > &messages) override
 
FileFormatMigrationV1 & operator= (const FileFormatMigrationV1 &rhs)=delete
 
- Public Member Functions inherited from FileFormatMigration
 FileFormatMigration ()=delete
 
 FileFormatMigration (const Version &fromVersion, const Version &toVersion, QObject *parent=nullptr) noexcept
 
 FileFormatMigration (const FileFormatMigration &other)=delete
 
virtual ~FileFormatMigration () noexcept
 
const Version & getFromVersion () const noexcept
 
const Version & getToVersion () const noexcept
 
FileFormatMigration & operator= (const FileFormatMigration &rhs)=delete
 

Protected Member Functions

virtual void upgradeOutputJobs (SExpression &root, ProjectContext &context) override
 
virtual void upgradeCircuit (SExpression &root, QList< Message > &messages) override
 
virtual void upgradeBoard (SExpression &root) override
 
- Protected Member Functions inherited from FileFormatMigrationV1
virtual void upgradeMetadata (SExpression &root, QList< Message > &messages)
 
virtual void upgradeSettings (SExpression &root, QList< Message > &messages)
 
virtual void upgradeSchematic (SExpression &root)
 
virtual void upgradeTexts (SExpression &node, bool allowLock)
 
virtual std::optional< QString > upgradeFileProofName (QString name)
 
- Protected Member Functions inherited from FileFormatMigration
Message buildMessage (Message::Severity severity, const QString &message, int affectedItems=-1) const noexcept
 
void upgradeVersionFile (TransactionalDirectory &dir, const QString &fileName)
 

Additional Inherited Members

- Static Public Member Functions inherited from FileFormatMigration
static QList< std::shared_ptr< FileFormatMigration > > getMigrations (const Version &fileFormat)
 
- Protected Attributes inherited from FileFormatMigration
Version mFromVersion
 
Version mToVersion
 

Detailed Description

Migration to upgrade a previous unstable file format.

This class overrides the stable file format migration class to perform only a partial upgrade. This allows to upgrade file from the previous unstable file format (master branch) to the latest unstable file format (feature branch). This upgrade is only performed when the environment variable LIBREPCB_UPGRADE_UNSTABLE=1 is set.

Constructor & Destructor Documentation

◆ FileFormatMigrationUnstable() [1/2]

FileFormatMigrationUnstable ( QObject *  parent = nullptr)
explicitnoexcept

◆ FileFormatMigrationUnstable() [2/2]

FileFormatMigrationUnstable ( const FileFormatMigrationUnstable &  other)
delete

◆ ~FileFormatMigrationUnstable()

~FileFormatMigrationUnstable ( )
noexcept

Member Function Documentation

◆ upgradeComponentCategory()

void upgradeComponentCategory ( TransactionalDirectory &  dir)
overridevirtual

Reimplemented from FileFormatMigrationV1.

◆ upgradePackageCategory()

void upgradePackageCategory ( TransactionalDirectory &  dir)
overridevirtual

Reimplemented from FileFormatMigrationV1.

◆ upgradeSymbol()

void upgradeSymbol ( TransactionalDirectory &  dir)
overridevirtual

Reimplemented from FileFormatMigrationV1.

◆ upgradePackage()

void upgradePackage ( TransactionalDirectory &  dir)
overridevirtual

Reimplemented from FileFormatMigrationV1.

◆ upgradeComponent()

void upgradeComponent ( TransactionalDirectory &  dir)
overridevirtual

Reimplemented from FileFormatMigrationV1.

◆ upgradeDevice()

void upgradeDevice ( TransactionalDirectory &  dir)
overridevirtual

Reimplemented from FileFormatMigrationV1.

+ Here is the call graph for this function:

◆ upgradeLibrary()

void upgradeLibrary ( TransactionalDirectory &  dir)
overridevirtual

Reimplemented from FileFormatMigrationV1.

◆ upgradeWorkspaceData()

void upgradeWorkspaceData ( TransactionalDirectory &  dir)
overridevirtual

Reimplemented from FileFormatMigrationV1.

◆ operator=()

FileFormatMigrationUnstable & operator= ( const FileFormatMigrationUnstable &  rhs)
delete

◆ upgradeOutputJobs()

void upgradeOutputJobs ( SExpression &  root,
ProjectContext &  context 
)
overrideprotectedvirtual

Reimplemented from FileFormatMigrationV1.

◆ upgradeCircuit()

void upgradeCircuit ( SExpression &  root,
QList< Message > &  messages 
)
overrideprotectedvirtual

Reimplemented from FileFormatMigrationV1.

◆ upgradeBoard()

void upgradeBoard ( SExpression &  root)
overrideprotectedvirtual

Reimplemented from FileFormatMigrationV1.

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