LibrePCB Developers Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
componentcheck.h
Go to the documentation of this file.
1 /*
2  * LibrePCB - Professional EDA for everyone!
3  * Copyright (C) 2013 LibrePCB Developers, see AUTHORS.md for contributors.
4  * https://librepcb.org/
5  *
6  * This program is free software: you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation, either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program. If not, see <http://www.gnu.org/licenses/>.
18  */
19 
20 #ifndef LIBREPCB_LIBRARY_COMPONENTCHECK_H
21 #define LIBREPCB_LIBRARY_COMPONENTCHECK_H
22 
23 /*******************************************************************************
24  * Includes
25  ******************************************************************************/
26 #include "libraryelementcheck.h"
27 
28 #include <QtCore>
29 
30 /*******************************************************************************
31  * Namespace / Forward Declarations
32  ******************************************************************************/
33 namespace librepcb {
34 namespace library {
35 
36 class Component;
37 
38 /*******************************************************************************
39  * Class ComponentCheck
40  ******************************************************************************/
41 
46 public:
47  // Constructors / Destructor
48  ComponentCheck() = delete;
49  ComponentCheck(const ComponentCheck& other) = delete;
50  explicit ComponentCheck(const Component& component) noexcept;
51  virtual ~ComponentCheck() noexcept;
52 
53  // General Methods
54  virtual LibraryElementCheckMessageList runChecks() const override;
55 
56  // Operator Overloadings
57  ComponentCheck& operator=(const ComponentCheck& rhs) = delete;
58 
59 protected: // Methods
60  void checkMissingPrefix(MsgList& msgs) const;
61  void checkMissingDefaultValue(MsgList& msgs) const;
62  void checkDuplicateSignalNames(MsgList& msgs) const;
63  void checkMissingSymbolVariants(MsgList& msgs) const;
64  void checkMissingSymbolVariantItems(MsgList& msgs) const;
65 
66 private: // Data
68 };
69 
70 /*******************************************************************************
71  * End of File
72  ******************************************************************************/
73 
74 } // namespace library
75 } // namespace librepcb
76 
77 #endif // LIBREPCB_LIBRARY_COMPONENTCHECK_H
void checkMissingSymbolVariantItems(MsgList &msgs) const
Definition: componentcheck.cpp:98
ComponentCheck & operator=(const ComponentCheck &rhs)=delete
QVector< std::shared_ptr< const LibraryElementCheckMessage > > LibraryElementCheckMessageList
Definition: libraryelementcheckmessage.h:96
void checkMissingDefaultValue(MsgList &msgs) const
Definition: componentcheck.cpp:75
The ComponentCheck class.
Definition: componentcheck.h:45
LibraryElementCheckMessageList MsgList
Definition: librarybaseelementcheck.h:61
const Component & mComponent
Definition: componentcheck.h:67
void checkMissingSymbolVariants(MsgList &msgs) const
Definition: componentcheck.cpp:92
void checkDuplicateSignalNames(MsgList &msgs) const
Definition: componentcheck.cpp:81
void checkMissingPrefix(MsgList &msgs) const
Definition: componentcheck.cpp:69
virtual LibraryElementCheckMessageList runChecks() const override
Definition: componentcheck.cpp:55
The LibraryElementCheck class.
Definition: libraryelementcheck.h:45
virtual ~ComponentCheck() noexcept
Definition: componentcheck.cpp:48
The Component class represents a "generic" device in the library.
Definition: component.h:73