LibrePCB Developers Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
ComponentSignal Class Referencefinal

The ComponentSignal class represents one signal of a component. More...

#include <componentsignal.h>

+ Inheritance diagram for ComponentSignal:
+ Collaboration diagram for ComponentSignal:

Signals

void edited ()
 
void nameChanged (const CircuitIdentifier &name)
 
void roleChanged (const SignalRole &role)
 
void forcedNetNameChanged (const QString &name)
 
void isRequiredChanged (bool required)
 
void isNegatedChanged (bool negated)
 
void isClockChanged (bool clock)
 

Public Member Functions

 ComponentSignal ()=delete
 
 ComponentSignal (const ComponentSignal &other) noexcept
 
 ComponentSignal (const Uuid &uuid, const CircuitIdentifier &name, const SignalRole &role, const QString &forcedNetName, bool isRequired, bool isNegated, bool isClock) noexcept
 
 ComponentSignal (const SExpression &node)
 
 ~ComponentSignal () noexcept
 
const UuidgetUuid () const noexcept
 
const CircuitIdentifiergetName () const noexcept
 
const SignalRolegetRole () const noexcept
 
const QString & getForcedNetName () const noexcept
 
bool isRequired () const noexcept
 
bool isNegated () const noexcept
 
bool isClock () const noexcept
 
bool isNetSignalNameForced () const noexcept
 
void setName (const CircuitIdentifier &name) noexcept
 
void setRole (const SignalRole &role) noexcept
 
void setForcedNetName (const QString &name) noexcept
 
void setIsRequired (bool required) noexcept
 
void setIsNegated (bool negated) noexcept
 
void setIsClock (bool clock) noexcept
 
void serialize (SExpression &root) const override
 Serialize the object into an existing S-Expression node. More...
 
bool operator== (const ComponentSignal &rhs) const noexcept
 
bool operator!= (const ComponentSignal &rhs) const noexcept
 
ComponentSignaloperator= (const ComponentSignal &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 Attributes

Uuid mUuid
 
CircuitIdentifier mName
 
SignalRole mRole
 
QString mForcedNetName
 
bool mIsRequired
 
bool mIsNegated
 
bool mIsClock
 

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 ComponentSignal class represents one signal of a component.

Constructor & Destructor Documentation

ComponentSignal ( )
delete
ComponentSignal ( const ComponentSignal other)
noexcept
ComponentSignal ( const Uuid uuid,
const CircuitIdentifier name,
const SignalRole role,
const QString &  forcedNetName,
bool  isRequired,
bool  isNegated,
bool  isClock 
)
noexcept
ComponentSignal ( const SExpression node)
explicit
~ComponentSignal ( )
noexcept

Member Function Documentation

const Uuid& getUuid ( ) const
inlinenoexcept

+ Here is the caller graph for this function:

const CircuitIdentifier& getName ( ) const
inlinenoexcept

+ Here is the caller graph for this function:

const SignalRole& getRole ( ) const
inlinenoexcept
const QString& getForcedNetName ( ) const
inlinenoexcept

+ Here is the caller graph for this function:

bool isRequired ( ) const
inlinenoexcept

+ Here is the caller graph for this function:

bool isNegated ( ) const
inlinenoexcept
bool isClock ( ) const
inlinenoexcept
bool isNetSignalNameForced ( ) const
inlinenoexcept

+ Here is the caller graph for this function:

void setName ( const CircuitIdentifier name)
noexcept

+ Here is the caller graph for this function:

void setRole ( const SignalRole role)
noexcept

+ Here is the caller graph for this function:

void setForcedNetName ( const QString &  name)
noexcept

+ Here is the caller graph for this function:

void setIsRequired ( bool  required)
noexcept

+ Here is the caller graph for this function:

void setIsNegated ( bool  negated)
noexcept

+ Here is the caller graph for this function:

void setIsClock ( bool  clock)
noexcept

+ Here is the caller graph for this function:

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
rootThe target DOM root node
Exceptions
ExceptionThis method throws an exception if an error occurs.

Implements SerializableObject.

+ Here is the call graph for this function:

bool operator== ( const ComponentSignal rhs) const
noexcept
bool operator!= ( const ComponentSignal rhs) const
inlinenoexcept
ComponentSignal & operator= ( const ComponentSignal rhs)
noexcept
void edited ( )
signal

+ Here is the caller graph for this function:

void nameChanged ( const CircuitIdentifier name)
signal
void roleChanged ( const SignalRole role)
signal
void forcedNetNameChanged ( const QString &  name)
signal
void isRequiredChanged ( bool  required)
signal
void isNegatedChanged ( bool  negated)
signal
void isClockChanged ( bool  clock)
signal

Member Data Documentation

Uuid mUuid
private
CircuitIdentifier mName
private
SignalRole mRole
private
QString mForcedNetName
private
bool mIsRequired
private
bool mIsNegated
private
bool mIsClock
private

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