ComponentPinSignalMapItem Class Reference

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

#include <componentpinsignalmap.h>

Collaboration diagram for ComponentPinSignalMapItem:

Public Types
enum class	Event
typedef Slot< ComponentPinSignalMapItem, Event >	OnEditedSlot

Public Member Functions
	ComponentPinSignalMapItem ()=delete
	ComponentPinSignalMapItem (const ComponentPinSignalMapItem &other) noexcept
	ComponentPinSignalMapItem (const Uuid &pin, const std::optional< Uuid > &signal, const CmpSigPinDisplayType &displayType) noexcept
	ComponentPinSignalMapItem (const SExpression &node)
	~ComponentPinSignalMapItem () noexcept
const Uuid &	getUuid () const noexcept
const Uuid &	getPinUuid () const noexcept
const std::optional< Uuid > &	getSignalUuid () const noexcept
const CmpSigPinDisplayType &	getDisplayType () const noexcept
bool	setSignalUuid (const std::optional< Uuid > &uuid) noexcept
bool	setDisplayType (const CmpSigPinDisplayType &type) noexcept
void	serialize (SExpression &root) const
	Serialize into librepcb::SExpression node.
bool	operator== (const ComponentPinSignalMapItem &rhs) const noexcept
bool	operator!= (const ComponentPinSignalMapItem &rhs) const noexcept
ComponentPinSignalMapItem &	operator= (const ComponentPinSignalMapItem &rhs) noexcept

Public Attributes
Signal< ComponentPinSignalMapItem, Event >	onEdited

Private Attributes
Uuid	mPinUuid
	must be valid
std::optional< Uuid >	mSignalUuid
	std::nullopt if not connected to a signal
CmpSigPinDisplayType	mDisplayType

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

Member Typedef Documentation

OnEditedSlot

typedef Slot<ComponentPinSignalMapItem, Event> OnEditedSlot

Member Enumeration Documentation

Event

enum class Event

strong

Enumerator
PinUuidChanged
SignalUuidChanged
DisplayTypeChanged

Constructor & Destructor Documentation

ComponentPinSignalMapItem() [1/4]

ComponentPinSignalMapItem ( )

delete

ComponentPinSignalMapItem() [2/4]

ComponentPinSignalMapItem ( const ComponentPinSignalMapItem &  other )

noexcept

ComponentPinSignalMapItem() [3/4]

ComponentPinSignalMapItem ( const Uuid &  pin, const std::optional< Uuid > &  signal, const CmpSigPinDisplayType &  displayType  )

noexcept

ComponentPinSignalMapItem() [4/4]

ComponentPinSignalMapItem ( const SExpression &  node )

explicit

~ComponentPinSignalMapItem()

~ComponentPinSignalMapItem ( )

noexcept

Member Function Documentation

getUuid()

const Uuid & getUuid ( ) const

inlinenoexcept

getPinUuid()

const Uuid & getPinUuid ( ) const

inlinenoexcept

getSignalUuid()

const std::optional< Uuid > & getSignalUuid ( ) const

inlinenoexcept

Here is the caller graph for this function:

getDisplayType()

const CmpSigPinDisplayType & getDisplayType ( ) const

inlinenoexcept

Here is the caller graph for this function:

setSignalUuid()

bool setSignalUuid ( const std::optional< Uuid > &  uuid )

noexcept

Here is the caller graph for this function:

setDisplayType()

bool setDisplayType ( const CmpSigPinDisplayType &  type )

noexcept

Here is the caller graph for this function:

serialize()

void serialize

(

SExpression &

root

)

const

Serialize into librepcb::SExpression node.

Parameters

root	Root node to serialize into.

Here is the call graph for this function:

operator==()

bool operator== ( const ComponentPinSignalMapItem &  rhs ) const

noexcept

operator!=()

bool operator!= ( const ComponentPinSignalMapItem &  rhs ) const

inlinenoexcept

operator=()

ComponentPinSignalMapItem & operator= ( const ComponentPinSignalMapItem &  rhs )

noexcept

Member Data Documentation

onEdited

Signal<ComponentPinSignalMapItem, Event> onEdited

mPinUuid

Uuid mPinUuid

private

must be valid

mSignalUuid

std::optional<Uuid> mSignalUuid

private

std::nullopt if not connected to a signal

mDisplayType

CmpSigPinDisplayType mDisplayType

private

---

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

• /__w/1/s/libs/librepcb/core/library/cmp/componentpinsignalmap.h
• /__w/1/s/libs/librepcb/core/library/cmp/componentpinsignalmap.cpp