LibrePCB Developers Documentation
attributeunit.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_ATTRIBUTEUNIT_H
21 #define LIBREPCB_CORE_ATTRIBUTEUNIT_H
22 
23 /*******************************************************************************
24  * Includes
25  ******************************************************************************/
26 #include "../serialization/sexpression.h"
27 
28 #include <QtCore>
29 
30 /*******************************************************************************
31  * Namespace / Forward Declarations
32  ******************************************************************************/
33 namespace librepcb {
34 
35 /*******************************************************************************
36  * Class AttributeUnit
37  ******************************************************************************/
38 
42 class AttributeUnit final {
43 public:
44  // Constructors / Destructor
45  AttributeUnit() = delete;
46  AttributeUnit(const AttributeUnit& other) = delete;
47  explicit AttributeUnit(const QString& name, const QString& symbolTr,
48  const QStringList& userInputSuffixes) noexcept;
49  ~AttributeUnit() noexcept;
50 
51  // Getters
52  const QString& getName() const noexcept { return mName; }
53  const QString& getSymbolTr() const noexcept { return mSymbolTr; }
54  const QStringList& getUserInputSuffixes() const noexcept {
55  return mUserInputSuffixes;
56  }
57 
58  // Operator Overloadings
59  AttributeUnit& operator=(const AttributeUnit& rhs) = delete;
60 
61 private:
62  // General Attributes
63  QString mName;
64  QString mSymbolTr;
65  QStringList mUserInputSuffixes;
66 };
67 
68 /*******************************************************************************
69  * Non-Member Functions
70  ******************************************************************************/
71 
72 template <>
73 inline SExpression serialize(const AttributeUnit& obj) {
74  return SExpression::createToken(obj.getName());
75 }
76 
77 /*******************************************************************************
78  * End of File
79  ******************************************************************************/
80 
81 } // namespace librepcb
82 
83 #endif
const QString & getName() const noexcept
Definition: attributeunit.h:52
Definition: airwiresbuilder.cpp:34
~AttributeUnit() noexcept
Definition: attributeunit.cpp:41
const QString & getSymbolTr() const noexcept
Definition: attributeunit.h:53
QString mName
to convert from/to string, e.g. "millivolt"
Definition: attributeunit.h:63
static SExpression createToken(const QString &token)
Definition: sexpression.cpp:290
The AttributeUnit class.
Definition: attributeunit.h:42
QString mSymbolTr
e.g. "mV"
Definition: attributeunit.h:64
const QStringList & getUserInputSuffixes() const noexcept
Definition: attributeunit.h:54
SExpression serialize(const AttributeKey &obj)
Definition: attributekey.h:99
AttributeUnit & operator=(const AttributeUnit &rhs)=delete
The SExpression class.
Definition: sexpression.h:72
QStringList mUserInputSuffixes
user input suffixes, e.g. "k" or "meg"
Definition: attributeunit.h:65