Schematic Class Reference

The Schematic class represents one schematic page of a project and is always part of a circuit. More...

#include <schematic.h>

Inheritance diagram for Schematic:

Collaboration diagram for Schematic:

Public Types
enum	ItemZValue
	Z Values of all items in a schematic scene (to define the stacking order) More...

Signals
void	attributesChanged () override
	This signal is emited when the value of attributes has changed. More...
Signals inherited from AttributeProvider
virtual void	attributesChanged ()=0
	This signal is emited when the value of attributes has changed. More...

Public Member Functions
	Schematic ()=delete
	Schematic (const Schematic &other)=delete
	Schematic (Project &project, std::unique_ptr< TransactionalDirectory > directory)
	~Schematic () noexcept
Project &	getProject () const noexcept
FilePath	getFilePath () const noexcept
const GridProperties &	getGridProperties () const noexcept
GraphicsScene &	getGraphicsScene () const noexcept
bool	isEmpty () const noexcept
QList< SI_Base * >	getItemsAtScenePos (const Point &pos) const noexcept
QList< SI_NetPoint * >	getNetPointsAtScenePos (const Point &pos) const noexcept
QList< SI_NetLine * >	getNetLinesAtScenePos (const Point &pos) const noexcept
QList< SI_NetLabel * >	getNetLabelsAtScenePos (const Point &pos) const noexcept
QList< SI_SymbolPin * >	getPinsAtScenePos (const Point &pos) const noexcept
void	setGridProperties (const GridProperties &grid) noexcept
const Uuid &	getUuid () const noexcept
const ElementName &	getName () const noexcept
const QIcon &	getIcon () const noexcept
void	setName (const ElementName &name) noexcept
QList< SI_Symbol * >	getSymbols () const noexcept
SI_Symbol *	getSymbolByUuid (const Uuid &uuid) const noexcept
void	addSymbol (SI_Symbol &symbol)
void	removeSymbol (SI_Symbol &symbol)
SI_NetSegment *	getNetSegmentByUuid (const Uuid &uuid) const noexcept
void	addNetSegment (SI_NetSegment &netsegment)
void	removeNetSegment (SI_NetSegment &netsegment)
void	addToProject ()
void	removeFromProject ()
void	save ()
void	showInView (GraphicsView &view) noexcept
void	saveViewSceneRect (const QRectF &rect) noexcept
const QRectF &	restoreViewSceneRect () const noexcept
void	setSelectionRect (const Point &p1, const Point &p2, bool updateItems) noexcept
void	clearSelection () const noexcept
void	updateAllNetLabelAnchors () noexcept
void	renderToQPainter (QPainter &painter) const noexcept
std::unique_ptr< SchematicSelectionQuery >	createSelectionQuery () const noexcept
QString	getBuiltInAttributeValue (const QString &key) const noexcept override
	Get the value of a built-in attribute (if available) More...
QVector< const AttributeProvider * >	getAttributeProviderParents () const noexcept override
	Get all parent attribute providers (fallback if attribute not found) More...
Schematic &	operator= (const Schematic &rhs)=delete
bool	operator== (const Schematic &rhs) noexcept
bool	operator!= (const Schematic &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 QString	getUserDefinedAttributeValue (const QString &key) const noexcept
	Get the value of a user defined attribute (if available) More...
Public Member Functions inherited from SerializableObject
	SerializableObject () noexcept
virtual	~SerializableObject () noexcept
SExpression	serializeToDomElement (const QString &name) const
	Serialize the object to a new S-Expression node. More...

Static Public Member Functions
static Schematic *	create (Project &project, std::unique_ptr< TransactionalDirectory > directory, const ElementName &name)
Static Public Member Functions inherited from SerializableObject
template<typename T >
static void	serializeObjectContainer (SExpression &root, const T &container, const QString &itemName)
template<typename T >
static void	serializePointerContainer (SExpression &root, const T &container, const QString &itemName)
template<typename T >
static void	serializePointerContainerUuidSorted (SExpression &root, const T &container, const QString &itemName)

Private Member Functions
	Schematic (Project &project, std::unique_ptr< TransactionalDirectory > directory, bool create, const QString &newName)
void	updateIcon () noexcept
void	serialize (SExpression &root) const override
	Serialize the object into an existing S-Expression node. More...

Private Attributes
Project &	mProject
	A reference to the Project object (from the ctor) More...
std::unique_ptr< TransactionalDirectory >	mDirectory
bool	mIsAddedToProject
QScopedPointer< GraphicsScene >	mGraphicsScene
QScopedPointer< GridProperties >	mGridProperties
QRectF	mViewRect
Uuid	mUuid
ElementName	mName
QIcon	mIcon
QList< SI_Symbol * >	mSymbols
QList< SI_NetSegment * >	mNetSegments

Detailed Description

The Schematic class represents one schematic page of a project and is always part of a circuit.

A schematic can contain following items (see librepcb::project::SI_Base and librepcb::project::SGI_Base):

• netsegment: librepcb::project::SI_NetSegment
  • netpoint: librepcb::project::SI_NetPoint
  • netline: librepcb::project::SI_NetLine
  • netlabel: librepcb::project::SI_NetLabel
• symbol: librepcb::project::SI_Symbol
  • symbol pin: librepcb::project::SI_SymbolPin
• polygon: TODO
• circle: TODO
• text: TODO

Member Enumeration Documentation

ItemZValue

enum ItemZValue

Z Values of all items in a schematic scene (to define the stacking order)

These values are used for QGraphicsItem::setZValue() to define the stacking order of all items in a schematic QGraphicsScene. We use integer values, even if the z-value of QGraphicsItem is a qreal attribute...

Low number = background, high number = foreground

Enumerator
ZValue_Default	this is the default value (behind all other items)
ZValue_Symbols	Z value for librepcb::project::SI_Symbol items.
ZValue_NetLabels	Z value for librepcb::project::SI_NetLabel items.
ZValue_NetLines	Z value for librepcb::project::SI_NetLine items.
ZValue_HiddenNetPoints	Z value for hidden librepcb::project::SI_NetPoint items
ZValue_VisibleNetPoints	Z value for visible librepcb::project::SI_NetPoint items

Constructor & Destructor Documentation

Schematic() [1/4]

Schematic ( )

delete

Here is the caller graph for this function:

Schematic() [2/4]

Schematic ( const Schematic &  other )

delete

Schematic() [3/4]

Schematic ( Project &  project, std::unique_ptr< TransactionalDirectory >  directory  )

inline

Here is the call graph for this function:

~Schematic()

~Schematic ( )

noexcept

Here is the caller graph for this function:

Schematic() [4/4]

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

private

Here is the call graph for this function:

Member Function Documentation

getProject()

Project& getProject ( ) const

inlinenoexcept

Here is the call graph for this function:

Here is the caller graph for this function:

getFilePath()

FilePath getFilePath ( ) const

noexcept

Here is the caller graph for this function:

getGridProperties()

const GridProperties& getGridProperties ( ) const

inlinenoexcept

Here is the caller graph for this function:

getGraphicsScene()

GraphicsScene& getGraphicsScene ( ) const

inlinenoexcept

Here is the call graph for this function:

Here is the caller graph for this function:

isEmpty()

bool isEmpty ( ) const

noexcept

Here is the caller graph for this function:

getItemsAtScenePos()

QList< SI_Base * > getItemsAtScenePos ( const Point &  pos ) const

noexcept

Here is the call graph for this function:

Here is the caller graph for this function:

getNetPointsAtScenePos()

QList< SI_NetPoint * > getNetPointsAtScenePos ( const Point &  pos ) const

noexcept

Here is the call graph for this function:

Here is the caller graph for this function:

getNetLinesAtScenePos()

QList< SI_NetLine * > getNetLinesAtScenePos ( const Point &  pos ) const

noexcept

Here is the call graph for this function:

Here is the caller graph for this function:

getNetLabelsAtScenePos()

QList< SI_NetLabel * > getNetLabelsAtScenePos ( const Point &  pos ) const

noexcept

Here is the call graph for this function:

Here is the caller graph for this function:

getPinsAtScenePos()

QList< SI_SymbolPin * > getPinsAtScenePos ( const Point &  pos ) const

noexcept

Here is the call graph for this function:

Here is the caller graph for this function:

setGridProperties()

void setGridProperties ( const GridProperties &  grid )

noexcept

Here is the caller graph for this function:

getUuid()

const Uuid& getUuid ( ) const

inlinenoexcept

Here is the caller graph for this function:

getName()

const ElementName& getName ( ) const

inlinenoexcept

Here is the caller graph for this function:

getIcon()

const QIcon& getIcon ( ) const

inlinenoexcept

Here is the call graph for this function:

Here is the caller graph for this function:

setName()

void setName ( const ElementName &  name )

noexcept

Here is the caller graph for this function:

getSymbols()

QList<SI_Symbol*> getSymbols ( ) const

inlinenoexcept

Here is the call graph for this function:

Here is the caller graph for this function:

getSymbolByUuid()

SI_Symbol * getSymbolByUuid ( const Uuid &  uuid ) const

noexcept

Here is the call graph for this function:

Here is the caller graph for this function:

addSymbol()

void addSymbol

(

SI_Symbol &

symbol

)

Here is the call graph for this function:

Here is the caller graph for this function:

removeSymbol()

void removeSymbol

(

SI_Symbol &

symbol

)

Here is the call graph for this function:

Here is the caller graph for this function:

getNetSegmentByUuid()

SI_NetSegment * getNetSegmentByUuid ( const Uuid &  uuid ) const

noexcept

Here is the call graph for this function:

Here is the caller graph for this function:

addNetSegment()

void addNetSegment

(

SI_NetSegment &

netsegment

)

Here is the call graph for this function:

Here is the caller graph for this function:

removeNetSegment()

void removeNetSegment

(

SI_NetSegment &

netsegment

)

Here is the call graph for this function:

Here is the caller graph for this function:

addToProject()

void addToProject

(

)

Here is the call graph for this function:

Here is the caller graph for this function:

removeFromProject()

void removeFromProject

(

)

Here is the call graph for this function:

Here is the caller graph for this function:

save()

void save

(

)

Here is the call graph for this function:

Here is the caller graph for this function:

showInView()

void showInView ( GraphicsView &  view )

noexcept

Here is the caller graph for this function:

saveViewSceneRect()

void saveViewSceneRect ( const QRectF &  rect )

inlinenoexcept

Here is the caller graph for this function:

restoreViewSceneRect()

const QRectF& restoreViewSceneRect ( ) const

inlinenoexcept

Here is the call graph for this function:

Here is the caller graph for this function:

setSelectionRect()

void setSelectionRect ( const Point &  p1, const Point &  p2, bool  updateItems  )

noexcept

Here is the call graph for this function:

Here is the caller graph for this function:

clearSelection()

void clearSelection ( ) const

noexcept

Here is the call graph for this function:

Here is the caller graph for this function:

updateAllNetLabelAnchors()

void updateAllNetLabelAnchors ( )

noexcept

Here is the call graph for this function:

Here is the caller graph for this function:

renderToQPainter()

void renderToQPainter ( QPainter &  painter ) const

noexcept

Here is the caller graph for this function:

createSelectionQuery()

std::unique_ptr< SchematicSelectionQuery > createSelectionQuery ( ) const

noexcept

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:

getAttributeProviderParents()

QVector< const AttributeProvider * > getAttributeProviderParents ( ) const

overridevirtualnoexcept

Get all parent attribute providers (fallback if attribute not found)

Returns

All parent attribute provider objects (empty and nullptr are allowed)

Reimplemented from AttributeProvider.

Here is the caller graph for this function:

operator=()

Schematic& operator= ( const Schematic &  rhs )

delete

Here is the caller graph for this function:

operator==()

bool operator== ( const Schematic &  rhs )

inlinenoexcept

operator!=()

bool operator!= ( const Schematic &  rhs )

inlinenoexcept

Here is the call graph for this function:

create()

Schematic * create ( Project &  project, std::unique_ptr< TransactionalDirectory >  directory, const ElementName &  name  )

static

Here is the call graph for this function:

Here is the caller graph for this function:

attributesChanged

void attributesChanged ( )

overridesignal

This signal is emited 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:

updateIcon()

void updateIcon ( )

privatenoexcept

Here is the caller graph for this function:

serialize()

void serialize ( SExpression &  root ) const

overrideprivatevirtual

Serialize the object into an existing S-Expression node.

This method inserts/appends all attributes and childs of the object to an existing S-Expression node. The content which already exists in the given S-Expression node will not be removed.

Note

The generated S-Expression node has always the format of the application's major version (it's not possible to generate DOMs of older versions).

Parameters

root	The target DOM root node

Exceptions

Exception

This method throws an exception if an error occurs.

Implements SerializableObject.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mProject

Project& mProject

private

A reference to the Project object (from the ctor)

mDirectory

std::unique_ptr<TransactionalDirectory> mDirectory

private

mIsAddedToProject

bool mIsAddedToProject

private

mGraphicsScene

QScopedPointer<GraphicsScene> mGraphicsScene

private

mGridProperties

QScopedPointer<GridProperties> mGridProperties

private

mViewRect

QRectF mViewRect

private

mUuid

Uuid mUuid

private

mName

ElementName mName

private

mIcon

QIcon mIcon

private

mSymbols

QList<SI_Symbol*> mSymbols

private

mNetSegments

QList<SI_NetSegment*> mNetSegments

private

---

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

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