Circuit Class Reference

The Circuit class represents all electrical connections in a project (drawn in the schematics) More...

#include <circuit.h>

Inheritance diagram for Circuit:

Collaboration diagram for Circuit:

Signals
void	netClassAdded (NetClass &netclass)
void	netClassRemoved (NetClass &netclass)
void	netSignalAdded (NetSignal &netsignal)
void	netSignalRemoved (NetSignal &netsignal)
void	componentAdded (ComponentInstance &cmp)
void	componentRemoved (ComponentInstance &cmp)

Public Member Functions
	Circuit ()=delete
	Circuit (const Circuit &other)=delete
	Circuit (Project &project, const Version &fileFormat, bool create)
	~Circuit () noexcept
Project &	getProject () const noexcept
const QMap< Uuid, NetClass * > &	getNetClasses () const noexcept
NetClass *	getNetClassByUuid (const Uuid &uuid) const noexcept
NetClass *	getNetClassByName (const ElementName &name) const noexcept
void	addNetClass (NetClass &netclass)
void	removeNetClass (NetClass &netclass)
void	setNetClassName (NetClass &netclass, const ElementName &newName)
QString	generateAutoNetSignalName () const noexcept
const QMap< Uuid, NetSignal * > &	getNetSignals () const noexcept
NetSignal *	getNetSignalByUuid (const Uuid &uuid) const noexcept
NetSignal *	getNetSignalByName (const QString &name) const noexcept
NetSignal *	getNetSignalWithMostElements () const noexcept
void	addNetSignal (NetSignal &netsignal)
void	removeNetSignal (NetSignal &netsignal)
void	setNetSignalName (NetSignal &netsignal, const CircuitIdentifier &newName, bool isAutoName)
void	setHighlightedNetSignal (NetSignal *signal) noexcept
QString	generateAutoComponentInstanceName (const library::ComponentPrefix &cmpPrefix) const noexcept
const QMap< Uuid, ComponentInstance * > &	getComponentInstances () const noexcept
ComponentInstance *	getComponentInstanceByUuid (const Uuid &uuid) const noexcept
ComponentInstance *	getComponentInstanceByName (const QString &name) const noexcept
void	addComponentInstance (ComponentInstance &cmp)
void	removeComponentInstance (ComponentInstance &cmp)
void	setComponentInstanceName (ComponentInstance &cmp, const CircuitIdentifier &newName)
void	save ()
Circuit &	operator= (const Circuit &rhs)=delete
bool	operator== (const Circuit &rhs) noexcept
bool	operator!= (const Circuit &rhs) noexcept
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...

Private Member Functions
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...
QScopedPointer< TransactionalDirectory >	mDirectory
QMap< Uuid, NetClass * >	mNetClasses
QMap< Uuid, NetSignal * >	mNetSignals
QMap< Uuid, ComponentInstance * >	mComponentInstances

Additional Inherited Members
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)

Detailed Description

The Circuit class represents all electrical connections in a project (drawn in the schematics)

Each librepcb::project::Project object contains exactly one librepcb::project::Circuit object which contains the whole electrical components and connections. They are created with the schematic editor and used by the board editor. The whole circuit is saved in the file "circuit.lp" in the project's "circuit" directory.

Each Circuit object contains:

• All net classes (librepcb::project::NetClass objects)
• All net signals (librepcb::project::NetSignal objects)
• All component instances (librepcb::project::ComponentInstance objects)

Constructor & Destructor Documentation

Circuit() [1/3]

Circuit ( )

delete

Circuit() [2/3]

Circuit ( const Circuit &  other )

delete

Circuit() [3/3]

Circuit	(	Project &	project,
		const Version &	fileFormat,
		bool	create
	)

Here is the call graph for this function:

~Circuit()

~Circuit ( )

noexcept

Here is the call graph for this function:

Member Function Documentation

getProject()

Project& getProject ( ) const

inlinenoexcept

Here is the caller graph for this function:

getNetClasses()

const QMap<Uuid, NetClass*>& getNetClasses ( ) const

inlinenoexcept

Here is the caller graph for this function:

getNetClassByUuid()

NetClass * getNetClassByUuid ( const Uuid &  uuid ) const

noexcept

Here is the caller graph for this function:

getNetClassByName()

NetClass * getNetClassByName ( const ElementName &  name ) const

noexcept

Here is the call graph for this function:

Here is the caller graph for this function:

addNetClass()

void addNetClass

(

NetClass &

netclass

)

Here is the call graph for this function:

Here is the caller graph for this function:

removeNetClass()

void removeNetClass

(

NetClass &

netclass

)

Here is the call graph for this function:

Here is the caller graph for this function:

setNetClassName()

void setNetClassName	(	NetClass &	netclass,
		const ElementName &	newName
	)

Here is the call graph for this function:

Here is the caller graph for this function:

generateAutoNetSignalName()

QString generateAutoNetSignalName ( ) const

noexcept

Here is the call graph for this function:

Here is the caller graph for this function:

getNetSignals()

const QMap<Uuid, NetSignal*>& getNetSignals ( ) const

inlinenoexcept

Here is the caller graph for this function:

getNetSignalByUuid()

NetSignal * getNetSignalByUuid ( const Uuid &  uuid ) const

noexcept

Here is the caller graph for this function:

getNetSignalByName()

NetSignal * getNetSignalByName ( const QString &  name ) const

noexcept

Here is the call graph for this function:

Here is the caller graph for this function:

getNetSignalWithMostElements()

NetSignal * getNetSignalWithMostElements ( ) const

noexcept

Here is the call graph for this function:

Here is the caller graph for this function:

addNetSignal()

void addNetSignal

(

NetSignal &

netsignal

)

Here is the call graph for this function:

Here is the caller graph for this function:

removeNetSignal()

void removeNetSignal

(

NetSignal &

netsignal

)

Here is the call graph for this function:

Here is the caller graph for this function:

setNetSignalName()

void setNetSignalName	(	NetSignal &	netsignal,
		const CircuitIdentifier &	newName,
		bool	isAutoName
	)

Here is the call graph for this function:

Here is the caller graph for this function:

setHighlightedNetSignal()

void setHighlightedNetSignal ( NetSignal *  signal )

noexcept

Here is the call graph for this function:

Here is the caller graph for this function:

generateAutoComponentInstanceName()

QString generateAutoComponentInstanceName ( const library::ComponentPrefix &  cmpPrefix ) const

noexcept

Here is the call graph for this function:

Here is the caller graph for this function:

getComponentInstances()

const QMap<Uuid, ComponentInstance*>& getComponentInstances ( ) const

inlinenoexcept

Here is the caller graph for this function:

getComponentInstanceByUuid()

ComponentInstance * getComponentInstanceByUuid ( const Uuid &  uuid ) const

noexcept

Here is the caller graph for this function:

getComponentInstanceByName()

ComponentInstance * getComponentInstanceByName ( const QString &  name ) const

noexcept

Here is the call graph for this function:

Here is the caller graph for this function:

addComponentInstance()

void addComponentInstance

(

ComponentInstance &

cmp

)

Here is the call graph for this function:

Here is the caller graph for this function:

removeComponentInstance()

void removeComponentInstance

(

ComponentInstance &

cmp

)

Here is the call graph for this function:

Here is the caller graph for this function:

setComponentInstanceName()

void setComponentInstanceName	(	ComponentInstance &	cmp,
		const CircuitIdentifier &	newName
	)

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:

operator=()

Circuit& operator= ( const Circuit &  rhs )

delete

operator==()

bool operator== ( const Circuit &  rhs )

inlinenoexcept

operator!=()

bool operator!= ( const Circuit &  rhs )

inlinenoexcept

Here is the call graph for this function:

netClassAdded

void netClassAdded ( NetClass &  netclass )

signal

Here is the caller graph for this function:

netClassRemoved

void netClassRemoved ( NetClass &  netclass )

signal

Here is the caller graph for this function:

netSignalAdded

void netSignalAdded ( NetSignal &  netsignal )

signal

Here is the caller graph for this function:

netSignalRemoved

void netSignalRemoved ( NetSignal &  netsignal )

signal

Here is the caller graph for this function:

componentAdded

void componentAdded ( ComponentInstance &  cmp )

signal

Here is the caller graph for this function:

componentRemoved

void componentRemoved ( ComponentInstance &  cmp )

signal

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:

Member Data Documentation

mProject

Project& mProject

private

A reference to the Project object (from the ctor)

mDirectory

QScopedPointer<TransactionalDirectory> mDirectory

private

mNetClasses

QMap<Uuid, NetClass*> mNetClasses

private

mNetSignals

QMap<Uuid, NetSignal*> mNetSignals

private

mComponentInstances

QMap<Uuid, ComponentInstance*> mComponentInstances

private

---

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

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