NetSignal Class Reference

The NetSignal class. More...

#include <netsignal.h>

Inheritance diagram for NetSignal:

Collaboration diagram for NetSignal:

Signals
void	nameChanged (const CircuitIdentifier &newName)
void	highlightedChanged (bool isHighlighted)

Public Member Functions
	NetSignal ()=delete
	NetSignal (const NetSignal &other)=delete
	NetSignal (Circuit &circuit, const SExpression &node)
	NetSignal (Circuit &circuit, NetClass &netclass, const CircuitIdentifier &name, bool autoName)
	~NetSignal () noexcept
const Uuid &	getUuid () const noexcept
const CircuitIdentifier &	getName () const noexcept
bool	hasAutoName () const noexcept
NetClass &	getNetClass () const noexcept
bool	isHighlighted () const noexcept
Circuit &	getCircuit () const noexcept
const QList< ComponentSignalInstance * > &	getComponentSignals () const noexcept
const QList< SI_NetSegment * > &	getSchematicNetSegments () const noexcept
const QList< BI_NetSegment * > &	getBoardNetSegments () const noexcept
const QList< BI_Plane * > &	getBoardPlanes () const noexcept
int	getRegisteredElementsCount () const noexcept
bool	isUsed () const noexcept
bool	isNameForced () const noexcept
bool	isAddedToCircuit () const noexcept
void	setName (const CircuitIdentifier &name, bool isAutoName) noexcept
void	setHighlighted (bool hl) noexcept
void	addToCircuit ()
void	removeFromCircuit ()
void	registerComponentSignal (ComponentSignalInstance &signal)
void	unregisterComponentSignal (ComponentSignalInstance &signal)
void	registerSchematicNetSegment (SI_NetSegment &netsegment)
void	unregisterSchematicNetSegment (SI_NetSegment &netsegment)
void	registerBoardNetSegment (BI_NetSegment &netsegment)
void	unregisterBoardNetSegment (BI_NetSegment &netsegment)
void	registerBoardPlane (BI_Plane &plane)
void	unregisterBoardPlane (BI_Plane &plane)
void	serialize (SExpression &root) const override
	Serialize the object into an existing S-Expression node. More...
NetSignal &	operator= (const NetSignal &rhs)=delete
bool	operator== (const NetSignal &rhs) noexcept
bool	operator!= (const NetSignal &rhs) noexcept
Public Member Functions inherited from IF_ErcMsgProvider
	IF_ErcMsgProvider ()
virtual	~IF_ErcMsgProvider ()
virtual const char *	getErcMsgOwnerClassName () const noexcept=0
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
bool	checkAttributesValidity () const noexcept
void	updateErcMessages () noexcept

Private Attributes
Circuit &	mCircuit
bool	mIsAddedToCircuit
bool	mIsHighlighted
Uuid	mUuid
CircuitIdentifier	mName
bool	mHasAutoName
NetClass *	mNetClass
QList< ComponentSignalInstance * >	mRegisteredComponentSignals
QList< SI_NetSegment * >	mRegisteredSchematicNetSegments
QList< BI_NetSegment * >	mRegisteredBoardNetSegments
QList< BI_Plane * >	mRegisteredBoardPlanes
QScopedPointer< ErcMsg >	mErcMsgUnusedNetSignal
	the ERC message for unused netsignals More...
QScopedPointer< ErcMsg >	mErcMsgConnectedToLessThanTwoPins
	the ERC messages for netsignals with less than two component signals More...

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 NetSignal class.

Constructor & Destructor Documentation

NetSignal() [1/4]

NetSignal ( )

delete

NetSignal() [2/4]

NetSignal ( const NetSignal &  other )

delete

NetSignal() [3/4]

NetSignal ( Circuit &  circuit, const SExpression &  node  )

explicit

Here is the call graph for this function:

NetSignal() [4/4]

NetSignal ( Circuit &  circuit, NetClass &  netclass, const CircuitIdentifier &  name, bool  autoName  )

explicit

Here is the call graph for this function:

~NetSignal()

~NetSignal ( )

noexcept

Here is the call graph for this function:

Member Function Documentation

getUuid()

const Uuid& getUuid ( ) const

inlinenoexcept

Here is the caller graph for this function:

getName()

const CircuitIdentifier& getName ( ) const

inlinenoexcept

Here is the caller graph for this function:

hasAutoName()

bool hasAutoName ( ) const

inlinenoexcept

Here is the caller graph for this function:

getNetClass()

NetClass& getNetClass ( ) const

inlinenoexcept

Here is the caller graph for this function:

isHighlighted()

bool isHighlighted ( ) const

inlinenoexcept

Here is the caller graph for this function:

getCircuit()

Circuit& getCircuit ( ) const

inlinenoexcept

Here is the caller graph for this function:

getComponentSignals()

const QList<ComponentSignalInstance*>& getComponentSignals ( ) const

inlinenoexcept

Here is the caller graph for this function:

getSchematicNetSegments()

const QList<SI_NetSegment*>& getSchematicNetSegments ( ) const

inlinenoexcept

Here is the caller graph for this function:

getBoardNetSegments()

const QList<BI_NetSegment*>& getBoardNetSegments ( ) const

inlinenoexcept

Here is the caller graph for this function:

getBoardPlanes()

const QList<BI_Plane*>& getBoardPlanes ( ) const

inlinenoexcept

Here is the call graph for this function:

Here is the caller graph for this function:

getRegisteredElementsCount()

int getRegisteredElementsCount ( ) const

noexcept

Here is the caller graph for this function:

isUsed()

bool isUsed ( ) const

noexcept

Here is the call graph for this function:

Here is the caller graph for this function:

isNameForced()

bool isNameForced ( ) const

noexcept

Here is the call graph for this function:

Here is the caller graph for this function:

isAddedToCircuit()

bool isAddedToCircuit ( ) const

inlinenoexcept

Here is the call graph for this function:

Here is the caller graph for this function:

setName()

void setName ( const CircuitIdentifier &  name, bool  isAutoName  )

noexcept

Here is the call graph for this function:

Here is the caller graph for this function:

setHighlighted()

void setHighlighted ( bool  hl )

noexcept

Here is the caller graph for this function:

addToCircuit()

void addToCircuit

(

)

Here is the call graph for this function:

Here is the caller graph for this function:

removeFromCircuit()

void removeFromCircuit

(

)

Here is the call graph for this function:

Here is the caller graph for this function:

registerComponentSignal()

void registerComponentSignal

(

ComponentSignalInstance &

signal

)

Here is the call graph for this function:

Here is the caller graph for this function:

unregisterComponentSignal()

void unregisterComponentSignal

(

ComponentSignalInstance &

signal

)

Here is the call graph for this function:

Here is the caller graph for this function:

registerSchematicNetSegment()

void registerSchematicNetSegment

(

SI_NetSegment &

netsegment

)

Here is the call graph for this function:

Here is the caller graph for this function:

unregisterSchematicNetSegment()

void unregisterSchematicNetSegment

(

SI_NetSegment &

netsegment

)

Here is the call graph for this function:

Here is the caller graph for this function:

registerBoardNetSegment()

void registerBoardNetSegment

(

BI_NetSegment &

netsegment

)

Here is the call graph for this function:

Here is the caller graph for this function:

unregisterBoardNetSegment()

void unregisterBoardNetSegment

(

BI_NetSegment &

netsegment

)

Here is the call graph for this function:

Here is the caller graph for this function:

registerBoardPlane()

void registerBoardPlane

(

BI_Plane &

plane

)

Here is the call graph for this function:

Here is the caller graph for this function:

unregisterBoardPlane()

void unregisterBoardPlane

(

BI_Plane &

plane

)

Here is the call graph for this function:

Here is the caller graph for this function:

serialize()

void serialize ( SExpression &  root ) const

overridevirtual

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:

operator=()

NetSignal& operator= ( const NetSignal &  rhs )

delete

Here is the caller graph for this function:

operator==()

bool operator== ( const NetSignal &  rhs )

inlinenoexcept

operator!=()

bool operator!= ( const NetSignal &  rhs )

inlinenoexcept

Here is the call graph for this function:

nameChanged

void nameChanged ( const CircuitIdentifier &  newName )

signal

Here is the caller graph for this function:

highlightedChanged

void highlightedChanged ( bool  isHighlighted )

signal

Here is the caller graph for this function:

checkAttributesValidity()

bool checkAttributesValidity ( ) const

privatenoexcept

Here is the caller graph for this function:

updateErcMessages()

void updateErcMessages ( )

privatenoexcept

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mCircuit

Circuit& mCircuit

private

mIsAddedToCircuit

bool mIsAddedToCircuit

private

mIsHighlighted

bool mIsHighlighted

private

mUuid

Uuid mUuid

private

mName

CircuitIdentifier mName

private

mHasAutoName

bool mHasAutoName

private

mNetClass

NetClass* mNetClass

private

mRegisteredComponentSignals

QList<ComponentSignalInstance*> mRegisteredComponentSignals

private

mRegisteredSchematicNetSegments

QList<SI_NetSegment*> mRegisteredSchematicNetSegments

private

mRegisteredBoardNetSegments

QList<BI_NetSegment*> mRegisteredBoardNetSegments

private

mRegisteredBoardPlanes

QList<BI_Plane*> mRegisteredBoardPlanes

private

mErcMsgUnusedNetSignal

QScopedPointer<ErcMsg> mErcMsgUnusedNetSignal

private

the ERC message for unused netsignals

mErcMsgConnectedToLessThanTwoPins

QScopedPointer<ErcMsg> mErcMsgConnectedToLessThanTwoPins

private

the ERC messages for netsignals with less than two component signals

---

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

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