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

The ErcMsgList class contains a list of ERC messages which are visible for the user. More...

#include <ercmsglist.h>

+ Inheritance diagram for ErcMsgList:
+ Collaboration diagram for ErcMsgList:

Signals

void ercMsgAdded (ErcMsg *ercMsg)
 
void ercMsgRemoved (ErcMsg *ercMsg)
 
void ercMsgChanged (ErcMsg *ercMsg)
 

Public Member Functions

 ErcMsgList ()=delete
 
 ErcMsgList (const ErcMsgList &other)=delete
 
 ErcMsgList (Project &project, bool restore, bool readOnly, bool create)
 
 ~ErcMsgList () noexcept
 
const QList< ErcMsg * > & getItems () const noexcept
 
void add (ErcMsg *ercMsg) noexcept
 
void remove (ErcMsg *ercMsg) noexcept
 
void update (ErcMsg *ercMsg) noexcept
 
void restoreIgnoreState ()
 
bool save (bool toOriginal, QStringList &errors) noexcept
 
ErcMsgListoperator= (const ErcMsgList &rhs)=delete
 
- Public Member Functions inherited from SerializableObject
 SerializableObject () noexcept
 
virtual ~SerializableObject () noexcept
 
SExpression serializeToDomElement (const QString &name) const
 Serialize the object to a new S-Expression node. More...
 

Private Member Functions

void serialize (SExpression &root) const override
 Serialize the object into an existing S-Expression node. More...
 

Private Attributes

ProjectmProject
 
FilePath mFilepath
 
QScopedPointer< SmartSExprFilemFile
 
QList< ErcMsg * > mItems
 contains all visible ERC messages More...
 

Additional Inherited Members

- Static Public Member Functions inherited from SerializableObject
template<typename T >
static void serializeObjectContainer (SExpression &root, const T &container, const QString &itemName)
 
template<typename T >
static void serializePointerContainer (SExpression &root, const T &container, const QString &itemName)
 
template<typename T >
static void serializePointerContainerUuidSorted (SExpression &root, const T &container, const QString &itemName)
 

Detailed Description

The ErcMsgList class contains a list of ERC messages which are visible for the user.

Constructor & Destructor Documentation

ErcMsgList ( )
delete
ErcMsgList ( const ErcMsgList other)
delete
ErcMsgList ( Project project,
bool  restore,
bool  readOnly,
bool  create 
)
explicit

+ Here is the call graph for this function:

~ErcMsgList ( )
noexcept

Member Function Documentation

const QList<ErcMsg*>& getItems ( ) const
inlinenoexcept

+ Here is the caller graph for this function:

void add ( ErcMsg ercMsg)
noexcept
void remove ( ErcMsg ercMsg)
noexcept
void update ( ErcMsg ercMsg)
noexcept
void restoreIgnoreState ( )

+ Here is the call graph for this function:

bool save ( bool  toOriginal,
QStringList &  errors 
)
noexcept

+ Here is the call graph for this function:

ErcMsgList& operator= ( const ErcMsgList rhs)
delete
void ercMsgAdded ( ErcMsg ercMsg)
signal

+ Here is the caller graph for this function:

void ercMsgRemoved ( ErcMsg ercMsg)
signal

+ Here is the caller graph for this function:

void ercMsgChanged ( ErcMsg ercMsg)
signal

+ Here is the caller graph for this function:

void serialize ( SExpression root) const
overrideprivatevirtual

Serialize the object into an existing S-Expression node.

This method inserts/appends all attributes and childs of the object to an existing S-Expression node. The content which already exists in the given S-Expression node will not be removed.

Note
The generated S-Expression node has always the format of the application's major version (it's not possible to generate DOMs of older versions).
Parameters
rootThe target DOM root node
Exceptions
ExceptionThis method throws an exception if an error occurs.

Implements SerializableObject.

+ Here is the call graph for this function:

Member Data Documentation

Project& mProject
private
FilePath mFilepath
private
QScopedPointer<SmartSExprFile> mFile
private
QList<ErcMsg*> mItems
private

contains all visible ERC messages


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