LibrePCB Developers Documentation
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_CORE_COMPONENTCHECK_H
21#define LIBREPCB_CORE_COMPONENTCHECK_H
22
23/*******************************************************************************
24 * Includes
25 ******************************************************************************/
26#include "../libraryelementcheck.h"
27
28#include <QtCore>
29
30/*******************************************************************************
31 * Namespace / Forward Declarations
32 ******************************************************************************/
33namespace librepcb {
34
35class Component;
36
37/*******************************************************************************
38 * Class ComponentCheck
39 ******************************************************************************/
40
45public:
46 // Constructors / Destructor
47 ComponentCheck() = delete;
48 ComponentCheck(const ComponentCheck& other) = delete;
49 explicit ComponentCheck(const Component& component) noexcept;
50 virtual ~ComponentCheck() noexcept;
51
52 // General Methods
53 virtual RuleCheckMessageList runChecks() const override;
54
55 // Operator Overloadings
56 ComponentCheck& operator=(const ComponentCheck& rhs) = delete;
57
58protected: // Methods
59 void checkMissingPrefix(MsgList& msgs) const;
60 void checkMissingDefaultValue(MsgList& msgs) const;
61 void checkDuplicateSignalNames(MsgList& msgs) const;
62 void checkSignalNamesInversionSign(MsgList& msgs) const;
63 void checkMissingSymbolVariants(MsgList& msgs) const;
65
66private: // Data
68};
69
70/*******************************************************************************
71 * End of File
72 ******************************************************************************/
73
74} // namespace librepcb
75
76#endif
The ComponentCheck class.
Definition: componentcheck.h:44
virtual RuleCheckMessageList runChecks() const override
Definition: componentcheck.cpp:50
const Component & mComponent
Definition: componentcheck.h:67
ComponentCheck(const ComponentCheck &other)=delete
void checkSignalNamesInversionSign(MsgList &msgs) const
Definition: componentcheck.cpp:88
void checkMissingSymbolVariants(MsgList &msgs) const
Definition: componentcheck.cpp:101
void checkDuplicateSignalNames(MsgList &msgs) const
Definition: componentcheck.cpp:77
void checkMissingDefaultValue(MsgList &msgs) const
Definition: componentcheck.cpp:71
void checkMissingPrefix(MsgList &msgs) const
Definition: componentcheck.cpp:65
void checkMissingSymbolVariantItems(MsgList &msgs) const
Definition: componentcheck.cpp:107
virtual ~ComponentCheck() noexcept
Definition: componentcheck.cpp:43
The Component class represents a "generic" device in the library.
Definition: component.h:73
RuleCheckMessageList MsgList
Definition: librarybaseelementcheck.h:60
The LibraryElementCheck class.
Definition: libraryelementcheck.h:44
Definition: occmodel.cpp:77
QVector< std::shared_ptr< const RuleCheckMessage > > RuleCheckMessageList
Definition: rulecheckmessage.h:104