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

The ComponentPinSignalMapItem class maps a symbol pin to a component signal. More...

#include <componentpinsignalmap.h>

+ Inheritance diagram for ComponentPinSignalMapItem:
+ Collaboration diagram for ComponentPinSignalMapItem:

Public Member Functions

 ComponentPinSignalMapItem ()=delete
 
 ComponentPinSignalMapItem (const ComponentPinSignalMapItem &other) noexcept
 
 ComponentPinSignalMapItem (const Uuid &pin, const tl::optional< Uuid > &signal, const CmpSigPinDisplayType &displayType) noexcept
 
 ComponentPinSignalMapItem (const SExpression &node)
 
 ~ComponentPinSignalMapItem () noexcept
 
const UuidgetUuid () const noexcept
 
const UuidgetPinUuid () const noexcept
 
const tl::optional< Uuid > & getSignalUuid () const noexcept
 
const CmpSigPinDisplayTypegetDisplayType () const noexcept
 
void setSignalUuid (const tl::optional< Uuid > &uuid) noexcept
 
void setDisplayType (const CmpSigPinDisplayType &type) noexcept
 
void serialize (SExpression &root) const override
 Serialize the object into an existing S-Expression node. More...
 
bool operator== (const ComponentPinSignalMapItem &rhs) const noexcept
 
bool operator!= (const ComponentPinSignalMapItem &rhs) const noexcept
 
ComponentPinSignalMapItemoperator= (const ComponentPinSignalMapItem &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 mPinUuid
 must be valid More...
 
tl::optional< UuidmSignalUuid
 tl::nullopt if not connected to a signal More...
 
CmpSigPinDisplayType mDisplayType
 

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 ComponentPinSignalMapItem class maps a symbol pin to a component signal.

Following information is considered as the "interface" of a pin-signal-mapping and must therefore never be changed:

  • Pin UUID
  • Signal UUID

Constructor & Destructor Documentation

ComponentPinSignalMapItem ( const Uuid pin,
const tl::optional< Uuid > &  signal,
const CmpSigPinDisplayType displayType 
)
noexcept
ComponentPinSignalMapItem ( const SExpression node)
explicit

+ Here is the call graph for this function:

Member Function Documentation

const Uuid& getUuid ( ) const
inlinenoexcept
const Uuid& getPinUuid ( ) const
inlinenoexcept
const tl::optional<Uuid>& getSignalUuid ( ) const
inlinenoexcept

+ Here is the caller graph for this function:

const CmpSigPinDisplayType& getDisplayType ( ) const
inlinenoexcept

+ Here is the caller graph for this function:

void setSignalUuid ( const tl::optional< Uuid > &  uuid)
inlinenoexcept

+ Here is the caller graph for this function:

void setDisplayType ( const CmpSigPinDisplayType type)
inlinenoexcept

+ 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 ComponentPinSignalMapItem rhs) const
noexcept
bool operator!= ( const ComponentPinSignalMapItem rhs) const
inlinenoexcept
ComponentPinSignalMapItem & operator= ( const ComponentPinSignalMapItem rhs)
noexcept

Member Data Documentation

Uuid mPinUuid
private

must be valid

tl::optional<Uuid> mSignalUuid
private

tl::nullopt if not connected to a signal

CmpSigPinDisplayType mDisplayType
private

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