CmpSigPinDisplayType Class Reference

The CmpSigPinDisplayType clas. More...

#include <cmpsigpindisplaytype.h>

Collaboration diagram for CmpSigPinDisplayType:

Public Member Functions
	CmpSigPinDisplayType () noexcept
	CmpSigPinDisplayType (const CmpSigPinDisplayType &other) noexcept
	~CmpSigPinDisplayType () noexcept
const QString &	toString () const noexcept
	Serialize the display type to a string (e.g. to write it into a file) More...
const QString &	getNameTr () const noexcept
	Get the name of the display type (human readable and translated) More...
bool	operator== (const CmpSigPinDisplayType &rhs) const noexcept
bool	operator!= (const CmpSigPinDisplayType &rhs) const noexcept
CmpSigPinDisplayType &	operator= (const CmpSigPinDisplayType &rhs) noexcept

Static Public Member Functions
static const CmpSigPinDisplayType &	fromString (const QString &str)
	Deserialize a display type from a string. More...
static const QList< CmpSigPinDisplayType > &	getAllTypes () noexcept
	Get a list of all available display types. More...
static const CmpSigPinDisplayType &	none () noexcept
	None (no text) More...
static const CmpSigPinDisplayType &	pinName () noexcept
	display the name of the symbol pin More...
static const CmpSigPinDisplayType &	componentSignal () noexcept
	display the name of the component signal More...
static const CmpSigPinDisplayType &	netSignal () noexcept
	display the name of the connected net signal More...

Private Member Functions
	CmpSigPinDisplayType (const QString &type, const QString &name) noexcept

Private Attributes
QString	mDisplayType
	used for serialization (DO NOT MODIFY VALUES!) More...
QString	mName
	human readable (translated) More...

Detailed Description

The CmpSigPinDisplayType clas.

Constructor & Destructor Documentation

CmpSigPinDisplayType() [1/3]

CmpSigPinDisplayType ( )

noexcept

CmpSigPinDisplayType() [2/3]

CmpSigPinDisplayType ( const CmpSigPinDisplayType &  other )

noexcept

~CmpSigPinDisplayType()

~CmpSigPinDisplayType ( )

noexcept

CmpSigPinDisplayType() [3/3]

CmpSigPinDisplayType ( const QString &  type, const QString &  name  )

privatenoexcept

Member Function Documentation

toString()

const QString & toString ( ) const

inlinenoexcept

Serialize the display type to a string (e.g. to write it into a file)

Returns

The generated string

Here is the caller graph for this function:

getNameTr()

const QString & getNameTr ( ) const

inlinenoexcept

Get the name of the display type (human readable and translated)

Returns

The name of the display type

Here is the caller graph for this function:

operator==()

bool operator== ( const CmpSigPinDisplayType &  rhs ) const

noexcept

operator!=()

bool operator!= ( const CmpSigPinDisplayType &  rhs ) const

inlinenoexcept

operator=()

CmpSigPinDisplayType & operator= ( const CmpSigPinDisplayType &  rhs )

noexcept

fromString()

const CmpSigPinDisplayType & fromString ( const QString &  str )

static

Deserialize a display type from a string.

Parameters

str	The string (e.g. from a file)

Returns

The CmpSigPinDisplayType object of the given string

Exceptions

Exception

if the given string is not a valid CmpSigPinDisplayType

Here is the call graph for this function:

Here is the caller graph for this function:

getAllTypes()

const QList< CmpSigPinDisplayType > & getAllTypes ( )

staticnoexcept

Get a list of all available display types.

Returns

A list of all display types

Here is the call graph for this function:

Here is the caller graph for this function:

none()

static const CmpSigPinDisplayType & none ( )

inlinestaticnoexcept

None (no text)

Here is the caller graph for this function:

pinName()

static const CmpSigPinDisplayType & pinName ( )

inlinestaticnoexcept

display the name of the symbol pin

Here is the caller graph for this function:

componentSignal()

static const CmpSigPinDisplayType & componentSignal ( )

inlinestaticnoexcept

display the name of the component signal

Here is the caller graph for this function:

netSignal()

static const CmpSigPinDisplayType & netSignal ( )

inlinestaticnoexcept

display the name of the connected net signal

Here is the caller graph for this function:

Member Data Documentation

mDisplayType

QString mDisplayType

private

used for serialization (DO NOT MODIFY VALUES!)

mName

QString mName

private

human readable (translated)

---

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

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