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

The SignalRole class provides all supported electrical signal roles. More...

#include <signalrole.h>

+ Collaboration diagram for SignalRole:

Public Member Functions

 SignalRole () noexcept
 
 SignalRole (const SignalRole &other) noexcept
 
 ~SignalRole () noexcept
 
QString toStr () const noexcept
 Serialize this object into a string. More...
 
const QString & getNameTr () const noexcept
 Get the name of the SignalRole (human readable and translated) More...
 
SignalRoleoperator= (const SignalRole &rhs) noexcept
 
bool operator== (const SignalRole &rhs) const noexcept
 
bool operator!= (const SignalRole &rhs) const noexcept
 

Static Public Member Functions

static const QList< SignalRole > & getAllRoles () noexcept
 Get a list of all available signal roles. More...
 
static const SignalRolepassive () noexcept
 Passive Pins (R, C, L) More...
 
static const SignalRolepower () noexcept
 Power Pins (GND, VCC, VSS,... of Devices) More...
 
static const SignalRoleinput () noexcept
 Input Pins. More...
 
static const SignalRoleoutput () noexcept
 Output Pins. More...
 
static const SignalRoleinout () noexcept
 Input/Output Pins. More...
 
static const SignalRoleopendrain () noexcept
 Open Collector / Open Drain Pins. More...
 

Private Member Functions

 SignalRole (const QString &role, const QString &name) noexcept
 

Private Attributes

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

Detailed Description

The SignalRole class provides all supported electrical signal roles.

Author
ubruhin
Date
2016-10-20

Constructor & Destructor Documentation

SignalRole ( )
noexcept
SignalRole ( const SignalRole other)
noexcept
~SignalRole ( )
noexcept
SignalRole ( const QString &  role,
const QString &  name 
)
privatenoexcept

Member Function Documentation

QString toStr ( ) const
inlinenoexcept

Serialize this object into a string.

Returns
This object as a string

+ Here is the caller graph for this function:

const QString& getNameTr ( ) const
inlinenoexcept

Get the name of the SignalRole (human readable and translated)

Returns
The name of the SignalRole

+ Here is the caller graph for this function:

SignalRole & operator= ( const SignalRole rhs)
noexcept
bool operator== ( const SignalRole rhs) const
inlinenoexcept
bool operator!= ( const SignalRole rhs) const
inlinenoexcept
const QList< SignalRole > & getAllRoles ( )
staticnoexcept

Get a list of all available signal roles.

Returns
A list of all roles

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static const SignalRole& passive ( )
inlinestaticnoexcept

Passive Pins (R, C, L)

+ Here is the caller graph for this function:

static const SignalRole& power ( )
inlinestaticnoexcept

Power Pins (GND, VCC, VSS,... of Devices)

+ Here is the caller graph for this function:

static const SignalRole& input ( )
inlinestaticnoexcept

Input Pins.

+ Here is the caller graph for this function:

static const SignalRole& output ( )
inlinestaticnoexcept

Output Pins.

+ Here is the caller graph for this function:

static const SignalRole& inout ( )
inlinestaticnoexcept

Input/Output Pins.

+ Here is the caller graph for this function:

static const SignalRole& opendrain ( )
inlinestaticnoexcept

Open Collector / Open Drain Pins.

+ Here is the caller graph for this function:

Member Data Documentation

QString mRole
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: