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

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
 
CmpSigPinDisplayTypeoperator= (const CmpSigPinDisplayType &rhs) noexcept
 

Static Public Member Functions

static const CmpSigPinDisplayTypefromString (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 CmpSigPinDisplayTypenone () noexcept
 None (no text) More...
 
static const CmpSigPinDisplayTypepinName () noexcept
 display the name of the symbol pin More...
 
static const CmpSigPinDisplayTypecomponentSignal () noexcept
 display the name of the component signal More...
 
static const CmpSigPinDisplayTypenetSignal () 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.

Author
ubruhin
Date
2016-10-23

Constructor & Destructor Documentation

CmpSigPinDisplayType ( )
noexcept
CmpSigPinDisplayType ( const CmpSigPinDisplayType other)
noexcept
~CmpSigPinDisplayType ( )
noexcept
CmpSigPinDisplayType ( const QString &  type,
const QString &  name 
)
privatenoexcept

Member Function Documentation

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:

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:

bool operator== ( const CmpSigPinDisplayType rhs) const
noexcept
bool operator!= ( const CmpSigPinDisplayType rhs) const
inlinenoexcept
CmpSigPinDisplayType & operator= ( const CmpSigPinDisplayType rhs)
noexcept
const CmpSigPinDisplayType & fromString ( const QString &  str)
static

Deserialize a display type from a string.

Parameters
strThe string (e.g. from a file)
Returns
The CmpSigPinDisplayType object of the given string
Exceptions
Exceptionif the given string is not a valid CmpSigPinDisplayType

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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:

static const CmpSigPinDisplayType& none ( )
inlinestaticnoexcept

None (no text)

+ Here is the caller graph for this function:

static const CmpSigPinDisplayType& pinName ( )
inlinestaticnoexcept

display the name of the symbol pin

+ Here is the caller graph for this function:

static const CmpSigPinDisplayType& componentSignal ( )
inlinestaticnoexcept

display the name of the component signal

+ Here is the caller graph for this function:

static const CmpSigPinDisplayType& netSignal ( )
inlinestaticnoexcept

display the name of the connected net signal

+ Here is the caller graph for this function:

Member Data Documentation

QString mDisplayType
private

used for serialization (DO NOT MODIFY VALUES!)

QString mName
private

human readable (translated)


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