Project Class Reference

The Project class represents a whole (opened) project with all its content. More...

#include <project.h>

Inheritance diagram for Project:

Collaboration diagram for Project:

Signals
void	attributesChanged () override
	This signal is emitted when the value of attributes has changed. More...
void	schematicAdded (int newIndex)
	This signal is emitted after a schematic was added to the project. More...
void	schematicRemoved (int oldIndex)
	This signal is emitted after a schematic was removed from the project. More...
void	boardAdded (int newIndex)
	This signal is emitted after a board was added to the project. More...
void	boardRemoved (int oldIndex)
	This signal is emitted after a board was removed from the project. More...
Signals inherited from AttributeProvider
virtual void	attributesChanged ()=0
	This signal is emitted when the value of attributes has changed. More...

Public Member Functions
	Project ()=delete
	Project (const Project &other)=delete
	Project (std::unique_ptr< TransactionalDirectory > directory, const QString &filename)
	The constructor to open an existing project with all its content. More...
	~Project () noexcept
	The destructor will close the whole project (without saving!) More...
FilePath	getFilepath () const noexcept
	Get the filepath of the project file (*.lpp) More...
FilePath	getPath () const noexcept
	Get the path to the project directory. More...
const TransactionalDirectory &	getDirectory () const noexcept
TransactionalDirectory &	getDirectory () noexcept
StrokeFontPool &	getStrokeFonts () const noexcept
	Get the StrokeFontPool which contains all stroke fonts of the project. More...
ProjectMetadata &	getMetadata () const noexcept
	Get the ProjectMetadata object which contains all project metadata. More...
ProjectSettings &	getSettings () const noexcept
	Get the ProjectSettings object which contains all project settings. More...
ProjectLibrary &	getLibrary () const noexcept
	Get the ProjectLibrary object which contains all library elements used in this project. More...
ErcMsgList &	getErcMsgList () const noexcept
	Get the ERC messages list. More...
Circuit &	getCircuit () const noexcept
	Get the Circuit object. More...
SchematicLayerProvider &	getLayers () noexcept
const SchematicLayerProvider &	getLayers () const noexcept
int	getSchematicIndex (const Schematic &schematic) const noexcept
	Get the page index of a specific schematic. More...
const QList< Schematic * > &	getSchematics () const noexcept
	Get all schematics. More...
Schematic *	getSchematicByIndex (int index) const noexcept
	Get the schematic page at a specific index. More...
Schematic *	getSchematicByUuid (const Uuid &uuid) const noexcept
	Get the schematic page with a specific UUID. More...
Schematic *	getSchematicByName (const QString &name) const noexcept
	Get the schematic page with a specific name. More...
Schematic *	createSchematic (const ElementName &name)
	Create a new schematic (page) More...
void	addSchematic (Schematic &schematic, int newIndex=-1)
	Add an existing schematic to this project. More...
void	removeSchematic (Schematic &schematic, bool deleteSchematic=false)
	Remove a schematic from this project. More...
void	exportSchematicsAsPdf (const FilePath &filepath)
	Export the schematic pages as a PDF. More...
void	printSchematicPages (QPrinter &printer, QList< int > &pages)
	Print some schematics to a QPrinter (printer or file) More...
int	getBoardIndex (const Board &board) const noexcept
	Get the index of a specific board. More...
const QList< Board * > &	getBoards () const noexcept
	Get all boards. More...
Board *	getBoardByIndex (int index) const noexcept
	Get the board at a specific index. More...
Board *	getBoardByUuid (const Uuid &uuid) const noexcept
	Get the board with a specific UUID. More...
Board *	getBoardByName (const QString &name) const noexcept
	Get the board with a specific name. More...
Board *	createBoard (const ElementName &name)
	Create a new board. More...
Board *	createBoard (const Board &other, const ElementName &name)
	Create a new board as a copy of an existing board. More...
void	addBoard (Board &board, int newIndex=-1)
	Add an existing board to this project. More...
void	removeBoard (Board &board, bool deleteBoard=false)
	Remove a board from this project. More...
void	save ()
	Save the project to the transactional file system. More...
QString	getUserDefinedAttributeValue (const QString &key) const noexcept override
	Get the value of a user defined attribute (if available) More...
QString	getBuiltInAttributeValue (const QString &key) const noexcept override
	Get the value of a built-in attribute (if available) More...
bool	operator== (const Project &rhs) noexcept
bool	operator!= (const Project &rhs) noexcept
Public Member Functions inherited from AttributeProvider
	AttributeProvider () noexcept
	AttributeProvider (const AttributeProvider &other)=delete
AttributeProvider &	operator= (const AttributeProvider &rhs)=delete
virtual	~AttributeProvider () noexcept
QString	getAttributeValue (const QString &key) const noexcept
	Get the value of an attribute which can be used in texts (like "{{NAME}}") More...
virtual QVector< const AttributeProvider * >	getAttributeProviderParents () const noexcept
	Get all parent attribute providers (fallback if attribute not found) More...

Static Public Member Functions
static Project *	create (std::unique_ptr< TransactionalDirectory > directory, const QString &filename)
static bool	isFilePathInsideProjectDirectory (const FilePath &fp) noexcept
static bool	isProjectFile (const FilePath &file) noexcept
static bool	isProjectDirectory (const FilePath &dir) noexcept
static Version	getProjectFileFormatVersion (const FilePath &dir)

Private Member Functions
	Project (std::unique_ptr< TransactionalDirectory > directory, const QString &filename, bool create)
	The constructor to create or open a project with all its content. More...

Private Attributes
std::unique_ptr< TransactionalDirectory >	mDirectory
QString	mFilename
	the name of the *.lpp project file More...
QScopedPointer< StrokeFontPool >	mStrokeFontPool
	all fonts from ./resources/fontobene/ More...
QScopedPointer< ProjectMetadata >	mProjectMetadata
	e.g. project name, author, ... More...
QScopedPointer< ProjectSettings >	mProjectSettings
	all project specific settings More...
QScopedPointer< ProjectLibrary >	mProjectLibrary
QScopedPointer< ErcMsgList >	mErcMsgList
QScopedPointer< Circuit >	mCircuit
QList< Schematic * >	mSchematics
	All schematics of this project. More...
QList< Schematic * >	mRemovedSchematics
	All removed schematics of this project. More...
QScopedPointer< SchematicLayerProvider >	mSchematicLayerProvider
	All schematic layers of this project. More...
QList< Board * >	mBoards
	All boards of this project. More...
QList< Board * >	mRemovedBoards
	All removed boards of this project. More...
QScopedPointer< AttributeList >	mAttributes
	all attributes in a specific order More...

Detailed Description

The Project class represents a whole (opened) project with all its content.

This class represents a whole project with all the content of its directory:

• circuit, schematics and boards
• the project's library
• project settings
• and much more...

The constructor of the librepcb::project::Project class needs the filepath to a project file. Then the project will be opened. A new project can be created with the static method create(). The destructor will close the project (without saving). Use the method save() to write the whole project to the harddisc.

Note

!! A detailed description about projects is available here: Project Specification !!

Constructor & Destructor Documentation

Project() [1/4]

Project ( )

delete

Here is the caller graph for this function:

Project() [2/4]

Project ( const Project &  other )

delete

Project() [3/4]

Project ( std::unique_ptr< TransactionalDirectory >  directory, const QString &  filename  )

inline

The constructor to open an existing project with all its content.

Parameters

directory	The directory which contains the project.
filename	The filename of the *.lpp project file.

Exceptions

Exception

If the project could not be opened successfully

Here is the call graph for this function:

~Project()

~Project ( )

noexcept

The destructor will close the whole project (without saving!)

Here is the call graph for this function:

Here is the caller graph for this function:

Project() [4/4]

Project ( std::unique_ptr< TransactionalDirectory >  directory, const QString &  filename, bool  create  )

explicitprivate

The constructor to create or open a project with all its content.

Parameters

directory	The directory which contains the project.
filename	The filename of the *.lpp project file.
create	True if the specified project does not exist already and must be created.

Exceptions

Exception

If the project could not be created/opened successfully

Todo:

Remove interactive message boxes, should be done at a higher layer!

Here is the call graph for this function:

Member Function Documentation

getFilepath()

FilePath getFilepath ( ) const

inlinenoexcept

Get the filepath of the project file (*.lpp)

Returns

The absolute filepath

Here is the caller graph for this function:

getPath()

FilePath getPath ( ) const

inlinenoexcept

Get the path to the project directory.

Returns

The filepath to the project directory

Here is the caller graph for this function:

getDirectory() [1/2]

const TransactionalDirectory& getDirectory ( ) const

inlinenoexcept

Here is the caller graph for this function:

getDirectory() [2/2]

TransactionalDirectory& getDirectory ( )

inlinenoexcept

getStrokeFonts()

StrokeFontPool& getStrokeFonts ( ) const

inlinenoexcept

Get the StrokeFontPool which contains all stroke fonts of the project.

Returns

A reference to the librepcb::StrokeFontPool object

getMetadata()

ProjectMetadata& getMetadata ( ) const

inlinenoexcept

Get the ProjectMetadata object which contains all project metadata.

Returns

A reference to the ProjectMetadata object

Here is the caller graph for this function:

getSettings()

ProjectSettings& getSettings ( ) const

inlinenoexcept

Get the ProjectSettings object which contains all project settings.

Returns

A reference to the ProjectSettings object

Here is the caller graph for this function:

getLibrary()

ProjectLibrary& getLibrary ( ) const

inlinenoexcept

Get the ProjectLibrary object which contains all library elements used in this project.

Returns

A reference to the ProjectLibrary object

Here is the caller graph for this function:

getErcMsgList()

ErcMsgList& getErcMsgList ( ) const

inlinenoexcept

Get the ERC messages list.

Returns

A reference to the ErcMsgList object

Here is the caller graph for this function:

getCircuit()

Circuit& getCircuit ( ) const

inlinenoexcept

Get the Circuit object.

Returns

A reference to the Circuit object

Here is the caller graph for this function:

getLayers() [1/2]

SchematicLayerProvider& getLayers ( )

inlinenoexcept

Here is the caller graph for this function:

getLayers() [2/2]

const SchematicLayerProvider& getLayers ( ) const

inlinenoexcept

Here is the call graph for this function:

getSchematicIndex()

int getSchematicIndex ( const Schematic &  schematic ) const

noexcept

Get the page index of a specific schematic.

Returns

the schematic index (-1 if the schematic does not exist)

Here is the caller graph for this function:

getSchematics()

const QList<Schematic*>& getSchematics ( ) const

inlinenoexcept

Get all schematics.

Returns

A QList with all schematics

Here is the caller graph for this function:

getSchematicByIndex()

Schematic* getSchematicByIndex ( int  index ) const

inlinenoexcept

Get the schematic page at a specific index.

Parameters

index

The page index (zero is the first)

Returns

A pointer to the specified schematic, or nullptr if index is invalid

Here is the call graph for this function:

Here is the caller graph for this function:

getSchematicByUuid()

Schematic * getSchematicByUuid ( const Uuid &  uuid ) const

noexcept

Get the schematic page with a specific UUID.

Parameters

uuid	The schematic UUID

Returns

A pointer to the specified schematic, or nullptr if uuid is invalid

Here is the call graph for this function:

Here is the caller graph for this function:

getSchematicByName()

Schematic * getSchematicByName ( const QString &  name ) const

noexcept

Get the schematic page with a specific name.

Parameters

name	The schematic name

Returns

A pointer to the specified schematic, or nullptr if name is invalid

Here is the call graph for this function:

Here is the caller graph for this function:

createSchematic()

Schematic * createSchematic

(

const ElementName &

name

)

Create a new schematic (page)

Parameters

name	The schematic page name

Returns

A pointer to the new schematic

Exceptions

Exception

This method throws an exception on error.

Here is the call graph for this function:

Here is the caller graph for this function:

addSchematic()

void addSchematic	(	Schematic &	schematic,
		int	newIndex = -1
	)

Add an existing schematic to this project.

Parameters

schematic	The schematic to add
newIndex	The desired index in the list (after inserting it)

Exceptions

Exception

On error

Note

This method must be called only from inside an librepcb::UndoCommand! Undo Commands for this method: librepcb::project::CmdSchematicAdd

Here is the call graph for this function:

Here is the caller graph for this function:

removeSchematic()

void removeSchematic	(	Schematic &	schematic,
		bool	deleteSchematic = false
	)

Remove a schematic from this project.

Parameters

schematic	The schematic to remove
deleteSchematic	If true, the schematic object will be deleted (Set this to true only when called from ctor or dtor!!)

Exceptions

Exception

On error

Note

This method must be called only from inside an librepcb::UndoCommand! Undo Commands for this method: librepcb::project::CmdSchematicRemove

Here is the call graph for this function:

Here is the caller graph for this function:

exportSchematicsAsPdf()

void exportSchematicsAsPdf

(

const FilePath &

filepath

)

Export the schematic pages as a PDF.

Parameters

filepath

The filepath where the PDF should be saved. If the file exists already, it will be overwritten.

Exceptions

Exception

On error

Here is the call graph for this function:

Here is the caller graph for this function:

printSchematicPages()

void printSchematicPages	(	QPrinter &	printer,
		QList< int > &	pages
	)

Print some schematics to a QPrinter (printer or file)

Parameters

printer	The QPrinter where to print the schematic pages
pages	A list with all schematic page indexes which should be printed

Exceptions

Exception

On error

Here is the call graph for this function:

Here is the caller graph for this function:

getBoardIndex()

int getBoardIndex ( const Board &  board ) const

noexcept

Get the index of a specific board.

Returns

the board index (-1 if the board does not exist)

Here is the caller graph for this function:

getBoards()

const QList<Board*>& getBoards ( ) const

inlinenoexcept

Get all boards.

Returns

A QList with all boards

Here is the caller graph for this function:

getBoardByIndex()

Board* getBoardByIndex ( int  index ) const

inlinenoexcept

Get the board at a specific index.

Parameters

index

The board index (zero is the first)

Returns

A pointer to the specified board, or nullptr if index is invalid

Here is the call graph for this function:

Here is the caller graph for this function:

getBoardByUuid()

Board * getBoardByUuid ( const Uuid &  uuid ) const

noexcept

Get the board with a specific UUID.

Parameters

uuid	The board UUID

Returns

A pointer to the specified board, or nullptr if uuid is invalid

Here is the call graph for this function:

Here is the caller graph for this function:

getBoardByName()

Board * getBoardByName ( const QString &  name ) const

noexcept

Get the board with a specific name.

Parameters

name	The board name

Returns

A pointer to the specified board, or nullptr if name is invalid

Here is the call graph for this function:

Here is the caller graph for this function:

createBoard() [1/2]

Board * createBoard

(

const ElementName &

name

)

Create a new board.

Parameters

name	The board name

Returns

A pointer to the new board

Exceptions

Exception

This method throws an exception on error.

Here is the call graph for this function:

Here is the caller graph for this function:

createBoard() [2/2]

Board * createBoard	(	const Board &	other,
		const ElementName &	name
	)

Create a new board as a copy of an existing board.

Parameters

other	The board to copy
name	The board name

Returns

A pointer to the new board

Exceptions

Exception

This method throws an exception on error.

Here is the call graph for this function:

addBoard()

void addBoard	(	Board &	board,
		int	newIndex = -1
	)

Add an existing board to this project.

Parameters

board	The board to add
newIndex	The desired index in the list (after inserting it)

Exceptions

Exception

On error

Note

This method must be called only from inside an librepcb::UndoCommand! Undo Commands for this method: librepcb::project::CmdBoardAdd

Here is the call graph for this function:

Here is the caller graph for this function:

removeBoard()

void removeBoard	(	Board &	board,
		bool	deleteBoard = false
	)

Remove a board from this project.

Parameters

board	The board to remove
deleteBoard	If true, the board object will be deleted (Set this to true only when called from ctor or dtor!!)

Exceptions

Exception

On error

Note

This method must be called only from inside an librepcb::UndoCommand! Undo Commands for this method: librepcb::project::CmdBoardRemove

Here is the call graph for this function:

Here is the caller graph for this function:

save()

void save

(

)

Save the project to the transactional file system.

Exceptions

Exception

If an error occurred.

Here is the call graph for this function:

Here is the caller graph for this function:

getUserDefinedAttributeValue()

QString getUserDefinedAttributeValue ( const QString &  key ) const

overridevirtualnoexcept

Get the value of a user defined attribute (if available)

Parameters

key	The attribute name (e.g. "NAME" for "{{NAME}}")

Returns

The value of the attribute (empty string if not found)

Reimplemented from AttributeProvider.

Here is the caller graph for this function:

getBuiltInAttributeValue()

QString getBuiltInAttributeValue ( const QString &  key ) const

overridevirtualnoexcept

Get the value of a built-in attribute (if available)

Parameters

key	The attribute name (e.g. "NAME" for "{{NAME}}")

Returns

The value of the attribute (empty string if not found)

Reimplemented from AttributeProvider.

Here is the call graph for this function:

Here is the caller graph for this function:

operator==()

bool operator== ( const Project &  rhs )

inlinenoexcept

operator!=()

bool operator!= ( const Project &  rhs )

inlinenoexcept

create()

static Project* create ( std::unique_ptr< TransactionalDirectory >  directory, const QString &  filename  )

inlinestatic

Here is the call graph for this function:

Here is the caller graph for this function:

isFilePathInsideProjectDirectory()

bool isFilePathInsideProjectDirectory ( const FilePath &  fp )

staticnoexcept

Here is the call graph for this function:

Here is the caller graph for this function:

isProjectFile()

bool isProjectFile ( const FilePath &  file )

staticnoexcept

Here is the call graph for this function:

Here is the caller graph for this function:

isProjectDirectory()

bool isProjectDirectory ( const FilePath &  dir )

staticnoexcept

Here is the caller graph for this function:

getProjectFileFormatVersion()

Version getProjectFileFormatVersion ( const FilePath &  dir )

static

Here is the call graph for this function:

Here is the caller graph for this function:

attributesChanged

void attributesChanged ( )

overridesignal

This signal is emitted when the value of attributes has changed.

All derived classes must emit this signal when some attributes have changed their values (only attributes which can be fetched with getAttributeValue(), inclusive all attributes from all "parent" classes).

Here is the caller graph for this function:

schematicAdded

void schematicAdded ( int  newIndex )

signal

This signal is emitted after a schematic was added to the project.

Parameters

newIndex

The index of the added schematic

Here is the caller graph for this function:

schematicRemoved

void schematicRemoved ( int  oldIndex )

signal

This signal is emitted after a schematic was removed from the project.

Parameters

oldIndex

The index of the removed schematic

Here is the caller graph for this function:

boardAdded

void boardAdded ( int  newIndex )

signal

This signal is emitted after a board was added to the project.

Parameters

newIndex

The index of the added board

Here is the caller graph for this function:

boardRemoved

void boardRemoved ( int  oldIndex )

signal

This signal is emitted after a board was removed from the project.

Parameters

oldIndex

The index of the removed board

Here is the caller graph for this function:

Member Data Documentation

mDirectory

std::unique_ptr<TransactionalDirectory> mDirectory

private

mFilename

QString mFilename

private

the name of the *.lpp project file

mStrokeFontPool

QScopedPointer<StrokeFontPool> mStrokeFontPool

private

all fonts from ./resources/fontobene/

mProjectMetadata

QScopedPointer<ProjectMetadata> mProjectMetadata

private

e.g. project name, author, ...

mProjectSettings

QScopedPointer<ProjectSettings> mProjectSettings

private

all project specific settings

mProjectLibrary

QScopedPointer<ProjectLibrary> mProjectLibrary

private

the library which contains all elements needed in this project

mErcMsgList

QScopedPointer<ErcMsgList> mErcMsgList

private

A list which contains all electrical rule check (ERC) messages

mCircuit

QScopedPointer<Circuit> mCircuit

private

The whole circuit of this project (contains all netclasses, netsignals, component instances, ...)

mSchematics

QList<Schematic*> mSchematics

private

All schematics of this project.

mRemovedSchematics

QList<Schematic*> mRemovedSchematics

private

All removed schematics of this project.

mSchematicLayerProvider

QScopedPointer<SchematicLayerProvider> mSchematicLayerProvider

private

All schematic layers of this project.

mBoards

QList<Board*> mBoards

private

All boards of this project.

mRemovedBoards

QList<Board*> mRemovedBoards

private

All removed boards of this project.

mAttributes

QScopedPointer<AttributeList> mAttributes

private

all attributes in a specific order

---

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

• /__w/1/s/libs/librepcb/project/project.h
• /__w/1/s/libs/librepcb/project/project.cpp