20 #ifndef LIBREPCB_PROJECT_COMPONENTINSTANCE_H
21 #define LIBREPCB_PROJECT_COMPONENTINSTANCE_H
26 #include "../erc/if_ercmsgprovider.h"
46 class ComponentSymbolVariant;
52 class ComponentSignalInstance;
79 const tl::optional<Uuid>& defaultDevice = tl::nullopt);
85 QString
getValue(
bool replaceAttributes =
false) const noexcept;
110 bool isUsed() const noexcept;
135 void setValue(const QString& value) noexcept;
251 #endif // LIBREPCB_PROJECT_COMPONENTINSTANCE_H
The Circuit class represents all electrical connections in a project (drawed in the schematics) ...
Definition: circuit.h:72
QScopedPointer< ErcMsg > mErcMsgUnplacedRequiredSymbols
The ERC message for unplaced required symbols of this component.
Definition: componentinstance.h:238
int getUnplacedSymbolsCount() const noexcept
Definition: componentinstance.cpp:173
QVector< const AttributeProvider * > getAttributeProviderParents() const noexceptoverride
Get all parent attribute providers (fallback if attribute not found)
Definition: componentinstance.cpp:395
bool checkAttributesValidity() const noexcept
Definition: componentinstance.cpp:406
The SI_Symbol class.
Definition: si_symbol.h:57
#define DECLARE_ERC_MSG_CLASS_NAME(msgOwnerClassName)
Definition: if_ercmsgprovider.h:44
The ErcMsg class represents a message in the ERC (Electrical Rule Check) list.
Definition: ercmsg.h:46
void unregisterDevice(BI_Device &device)
Definition: componentinstance.cpp:346
QString getUserDefinedAttributeValue(const QString &key) const noexceptoverride
Get the value of a user defined attribute (if available)
Definition: componentinstance.cpp:372
int getUnplacedRequiredSymbolsCount() const noexcept
Definition: componentinstance.cpp:177
int getPlacedSymbolsCount() const noexcept
Definition: componentinstance.h:103
Circuit & mCircuit
Definition: componentinstance.h:184
QString getBuiltInAttributeValue(const QString &key) const noexceptoverride
Get the value of a built-in attribute (if available)
Definition: componentinstance.cpp:381
QList< BI_Device * > mRegisteredDevices
All registered devices (of all boards)
Definition: componentinstance.h:233
int getUnplacedOptionalSymbolsCount() const noexcept
Definition: componentinstance.cpp:188
CircuitIdentifier mName
The unique name of this component instance in the circuit (e.g. "R42")
Definition: componentinstance.h:194
void unregisterSymbol(SI_Symbol &symbol)
Definition: componentinstance.cpp:325
const library::Component * mLibComponent
Pointer to the component in the project's library.
Definition: componentinstance.h:204
const QStringList & getLocaleOrder() const noexcept
Definition: componentinstance.cpp:429
The IF_ErcMsgProvider class.
Definition: if_ercmsgprovider.h:59
QScopedPointer< AttributeList > mAttributes
All attributes of this component.
Definition: componentinstance.h:210
const library::ComponentSymbolVariant * mCompSymbVar
Pointer to the used symbol variant of mLibComponent.
Definition: componentinstance.h:207
void registerSymbol(SI_Symbol &symbol)
Definition: componentinstance.cpp:292
QString getValue(bool replaceAttributes=false) const noexcept
Definition: componentinstance.cpp:165
bool mIsAddedToCircuit
Definition: componentinstance.h:185
const tl::optional< Uuid > & getDefaultDeviceUuid() const noexcept
Definition: componentinstance.h:86
const library::Component & getLibComponent() const noexcept
Definition: componentinstance.h:89
The SerializableObject class is the base class for all classes which need to be serializable/deserial...
Definition: serializableobject.h:43
Uuid mUuid
The unique UUID of this component instance in the circuit.
Definition: componentinstance.h:190
~ComponentInstance() noexcept
Definition: componentinstance.cpp:153
QString mValue
The value of this component instance in the circuit (e.g. the resistance of a resistor) ...
Definition: componentinstance.h:198
ComponentSignalInstance * getSignalInstance(const Uuid &signalUuid) const noexcept
Definition: componentinstance.h:95
void setAttributes(const AttributeList &attributes) noexcept
Definition: componentinstance.cpp:238
type_safe::constrained_type< QString, CircuitIdentifierConstraint, CircuitIdentifierVerifier > CircuitIdentifier
Definition: circuitidentifier.h:89
void registerDevice(BI_Device &device)
Definition: componentinstance.cpp:335
void addToCircuit()
Definition: componentinstance.cpp:258
const library::ComponentSymbolVariant & getSymbolVariant() const noexcept
Definition: componentinstance.h:92
Circuit & getCircuit() const noexcept
Definition: componentinstance.h:102
QHash< Uuid, SI_Symbol * > mRegisteredSymbols
All registered symbols.
Definition: componentinstance.h:226
void attributesChanged() override
This signal is emited when the value of attributes has changed.
void removeFromCircuit()
Definition: componentinstance.cpp:272
QMap< Uuid, ComponentSignalInstance * > mSignals
All signal instances (Key: component signal UUID)
Definition: componentinstance.h:213
The BI_Device class.
Definition: bi_device.h:62
void setValue(const QString &value) noexcept
Set the value of this component instance in the circuit.
Definition: componentinstance.cpp:231
The ComponentSymbolVariant class represents a symbol variant of a component.
Definition: componentsymbolvariant.h:58
const CircuitIdentifier & getName() const noexcept
Definition: componentinstance.h:84
QScopedPointer< ErcMsg > mErcMsgUnplacedOptionalSymbols
The ERC message for unplaced optional symbols of this component.
Definition: componentinstance.h:241
void init()
Definition: componentinstance.cpp:136
The ComponentSignalInstance class.
Definition: componentsignalinstance.h:61
The Uuid class is a replacement for QUuid to get UUID strings without {} braces.
Definition: uuid.h:58
tl::optional< Uuid > mDefaultDeviceUuid
THe default device when adding the component to a board.
Definition: componentinstance.h:201
void updateErcMessages() noexcept
Definition: componentinstance.cpp:412
void setName(const CircuitIdentifier &name) noexcept
Set the name of this component instance in the circuit.
Definition: componentinstance.cpp:223
The Component class represents a "generic" device in the library.
Definition: component.h:73
The ComponentInstance class.
Definition: componentinstance.h:64
ComponentInstance()=delete
The SExpression class.
Definition: sexpression.h:57
const Uuid & getUuid() const noexcept
Definition: componentinstance.h:83
void setDefaultDeviceUuid(const tl::optional< Uuid > &device) noexcept
Set the default device of the component.
Definition: componentinstance.cpp:246
bool isUsed() const noexcept
Definition: componentinstance.cpp:207
int getRegisteredElementsCount() const noexcept
Definition: componentinstance.cpp:200
The AttributeProvider class defines an interface for classes which provides some attributes which can...
Definition: attributeprovider.h:59
const AttributeList & getAttributes() const noexcept
Definition: componentinstance.h:99
void serialize(SExpression &root) const override
Serialize the object into an existing S-Expression node.
Definition: componentinstance.cpp:355