LibrePCB Developers Documentation
ErcMsg Class Reference

The ErcMsg class represents a message in the ERC (Electrical Rule Check) list. More...

#include <ercmsg.h>

+ Collaboration diagram for ErcMsg:

Public Types

enum  ErcMsgType_t
 ERC message types. More...
 

Public Member Functions

 ErcMsg (Project &project, const IF_ErcMsgProvider &owner, const QString &ownerKey, const QString &msgKey, ErcMsg::ErcMsgType_t msgType, const QString &msg=QString())
 
virtual ~ErcMsg () noexcept
 
const IF_ErcMsgProvidergetOwner () const noexcept
 
const QString & getOwnerKey () const noexcept
 
const QString & getMsgKey () const noexcept
 
ErcMsgType_t getMsgType () const noexcept
 
const QString & getMsg () const noexcept
 
bool isVisible () const noexcept
 
bool isIgnored () const noexcept
 
void setMsg (const QString &msg) noexcept
 
void setVisible (bool visible) noexcept
 
void setIgnored (bool ignored) noexcept
 

Private Member Functions

 ErcMsg ()
 
 ErcMsg (const ErcMsg &other)
 
ErcMsgoperator= (const ErcMsg &rhs)
 

Private Attributes

ProjectmProject
 
ErcMsgListmErcMsgList
 
const IF_ErcMsgProvidermOwner
 
QString mOwnerKey
 
QString mMsgKey
 
ErcMsgType_t mMsgType
 
QString mMsg
 
bool mIsVisible
 
bool mIsIgnored
 

Detailed Description

The ErcMsg class represents a message in the ERC (Electrical Rule Check) list.

Member Enumeration Documentation

◆ ErcMsgType_t

enum ErcMsgType_t
strong

ERC message types.

Enumerator
CircuitError 

example: two output pins in the same net

CircuitWarning 

example: nets with only one pin

SchematicError 

example: unplaced required symbols

SchematicWarning 

example: unplaced optional symbols

BoardError 

example: unplaced footprints

BoardWarning 

example: ???

_Count 

count of message types

Constructor & Destructor Documentation

◆ ErcMsg() [1/3]

ErcMsg ( Project project,
const IF_ErcMsgProvider owner,
const QString &  ownerKey,
const QString &  msgKey,
ErcMsg::ErcMsgType_t  msgType,
const QString &  msg = QString() 
)
explicit

◆ ~ErcMsg()

~ErcMsg ( )
virtualnoexcept
+ Here is the call graph for this function:

◆ ErcMsg() [2/3]

ErcMsg ( )
private
+ Here is the caller graph for this function:

◆ ErcMsg() [3/3]

ErcMsg ( const ErcMsg other)
private

Member Function Documentation

◆ getOwner()

const IF_ErcMsgProvider& getOwner ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ getOwnerKey()

const QString& getOwnerKey ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ getMsgKey()

const QString& getMsgKey ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ getMsgType()

ErcMsgType_t getMsgType ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ getMsg()

const QString& getMsg ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ isVisible()

bool isVisible ( ) const
inlinenoexcept
+ Here is the caller graph for this function:

◆ isIgnored()

bool isIgnored ( ) const
inlinenoexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setMsg()

void setMsg ( const QString &  msg)
noexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setVisible()

void setVisible ( bool  visible)
noexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setIgnored()

void setIgnored ( bool  ignored)
noexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ operator=()

ErcMsg& operator= ( const ErcMsg rhs)
private
+ Here is the caller graph for this function:

Member Data Documentation

◆ mProject

Project& mProject
private

◆ mErcMsgList

ErcMsgList& mErcMsgList
private

◆ mOwner

const IF_ErcMsgProvider& mOwner
private

◆ mOwnerKey

QString mOwnerKey
private

◆ mMsgKey

QString mMsgKey
private

◆ mMsgType

ErcMsgType_t mMsgType
private

◆ mMsg

QString mMsg
private

◆ mIsVisible

bool mIsVisible
private

◆ mIsIgnored

bool mIsIgnored
private

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