LibrePCB Developers Documentation
ComponentSignalInstance Class Referencefinal

The ComponentSignalInstance class. More...

#include <componentsignalinstance.h>

Inherits QObject.

+ Collaboration diagram for ComponentSignalInstance:

Signals

void netSignalChanged (NetSignal *from, NetSignal *to)
 
void padNamesChanged (const QStringList &names)
 

Public Member Functions

 ComponentSignalInstance ()=delete
 
 ComponentSignalInstance (const ComponentSignalInstance &other)=delete
 
 ComponentSignalInstance (Circuit &circuit, ComponentInstance &cmpInstance, const ComponentSignal &cmpSignal, NetSignal *netsignal=nullptr)
 
 ~ComponentSignalInstance () noexcept
 
CircuitgetCircuit () const noexcept
 
const ComponentSignalgetCompSignal () const noexcept
 
NetSignalgetNetSignal () const noexcept
 
ComponentInstancegetComponentInstance () const noexcept
 
bool isNetSignalNameForced () const noexcept
 
QString getForcedNetSignalName () const noexcept
 
const QStringList & getPadNames () const noexcept
 
const QList< SI_SymbolPin * > & getRegisteredSymbolPins () const noexcept
 
const QList< BI_FootprintPad * > & getRegisteredFootprintPads () const noexcept
 
int getRegisteredElementsCount () const noexcept
 
bool isUsed () const noexcept
 
bool arePinsOrPadsUsed () const noexcept
 
void setNetSignal (NetSignal *netsignal)
 (Re-)Connect/Disconnect this component signal to/from a circuit's netsignal More...
 
void addToCircuit ()
 
void removeFromCircuit ()
 
void registerSymbolPin (SI_SymbolPin &pin)
 
void unregisterSymbolPin (SI_SymbolPin &pin)
 
void registerFootprintPad (BI_FootprintPad &pad)
 
void unregisterFootprintPad (BI_FootprintPad &pad)
 
void serialize (SExpression &root) const
 Serialize into librepcb::SExpression node. More...
 
ComponentSignalInstanceoperator= (const ComponentSignalInstance &rhs)=delete
 

Private Member Functions

void updatePadNames () noexcept
 

Private Attributes

CircuitmCircuit
 
ComponentInstancemComponentInstance
 
const ComponentSignalmComponentSignal
 
bool mIsAddedToCircuit
 
NetSignalmNetSignal
 
QStringList mPadNames
 
QList< SI_SymbolPin * > mRegisteredSymbolPins
 
QList< BI_FootprintPad * > mRegisteredFootprintPads
 

Detailed Description

Constructor & Destructor Documentation

◆ ComponentSignalInstance() [1/3]

◆ ComponentSignalInstance() [2/3]

◆ ComponentSignalInstance() [3/3]

ComponentSignalInstance ( Circuit circuit,
ComponentInstance cmpInstance,
const ComponentSignal cmpSignal,
NetSignal netsignal = nullptr 
)
explicit
+ Here is the call graph for this function:

◆ ~ComponentSignalInstance()

~ComponentSignalInstance ( )
noexcept
+ Here is the call graph for this function:

Member Function Documentation

◆ getCircuit()

Circuit & getCircuit ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ getCompSignal()

const ComponentSignal & getCompSignal ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ getNetSignal()

NetSignal * getNetSignal ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ getComponentInstance()

ComponentInstance & getComponentInstance ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ isNetSignalNameForced()

bool isNetSignalNameForced ( ) const
noexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getForcedNetSignalName()

QString getForcedNetSignalName ( ) const
noexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getPadNames()

const QStringList & getPadNames ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ getRegisteredSymbolPins()

const QList< SI_SymbolPin * > & getRegisteredSymbolPins ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ getRegisteredFootprintPads()

const QList< BI_FootprintPad * > & getRegisteredFootprintPads ( ) const
inlinenoexcept
+ 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
inlinenoexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ arePinsOrPadsUsed()

bool arePinsOrPadsUsed ( ) const
noexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setNetSignal()

void setNetSignal ( NetSignal netsignal)

(Re-)Connect/Disconnect this component signal to/from a circuit's netsignal

Warning
This method must always be called from inside an UndoCommand!
Parameters
netsignal- (Re-)Connect: A Pointer to the new netsignal
  • Disconnect: 0
Exceptions
ExceptionThis method throws an exception in case of an error
+ Here is the call graph for this function:
+ 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:

◆ registerSymbolPin()

void registerSymbolPin ( SI_SymbolPin pin)
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ unregisterSymbolPin()

void unregisterSymbolPin ( SI_SymbolPin pin)
+ Here is the caller graph for this function:

◆ registerFootprintPad()

void registerFootprintPad ( BI_FootprintPad pad)
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ unregisterFootprintPad()

void unregisterFootprintPad ( BI_FootprintPad pad)
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ serialize()

void serialize ( SExpression root) const

Serialize into librepcb::SExpression node.

Parameters
rootRoot node to serialize into.
+ Here is the call graph for this function:

◆ operator=()

ComponentSignalInstance & operator= ( const ComponentSignalInstance rhs)
delete

◆ netSignalChanged

void netSignalChanged ( NetSignal from,
NetSignal to 
)
signal
+ Here is the caller graph for this function:

◆ padNamesChanged

void padNamesChanged ( const QStringList &  names)
signal
+ Here is the caller graph for this function:

◆ updatePadNames()

void updatePadNames ( )
privatenoexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Data Documentation

◆ mCircuit

Circuit& mCircuit
private

◆ mComponentInstance

ComponentInstance& mComponentInstance
private

◆ mComponentSignal

const ComponentSignal& mComponentSignal
private

◆ mIsAddedToCircuit

bool mIsAddedToCircuit
private

◆ mNetSignal

NetSignal* mNetSignal
private

◆ mPadNames

QStringList mPadNames
private

◆ mRegisteredSymbolPins

QList<SI_SymbolPin*> mRegisteredSymbolPins
private

◆ mRegisteredFootprintPads

QList<BI_FootprintPad*> mRegisteredFootprintPads
private

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