Developer Documentation
inout.hh
1 /*===========================================================================*\
2 * *
3 * OpenFlipper *
4  * Copyright (c) 2001-2015, RWTH-Aachen University *
5  * Department of Computer Graphics and Multimedia *
6  * All rights reserved. *
7  * www.openflipper.org *
8  * *
9  *---------------------------------------------------------------------------*
10  * This file is part of OpenFlipper. *
11  *---------------------------------------------------------------------------*
12  * *
13  * Redistribution and use in source and binary forms, with or without *
14  * modification, are permitted provided that the following conditions *
15  * are met: *
16  * *
17  * 1. Redistributions of source code must retain the above copyright notice, *
18  * this list of conditions and the following disclaimer. *
19  * *
20  * 2. Redistributions in binary form must reproduce the above copyright *
21  * notice, this list of conditions and the following disclaimer in the *
22  * documentation and/or other materials provided with the distribution. *
23  * *
24  * 3. Neither the name of the copyright holder nor the names of its *
25  * contributors may be used to endorse or promote products derived from *
26  * this software without specific prior written permission. *
27  * *
28  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS *
29  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
30  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A *
31  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
32  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, *
33  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, *
34  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR *
35  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF *
36  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING *
37  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS *
38  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
39 * *
40 \*===========================================================================*/
41 
42 
43 
44 #ifndef VSI_INOUT_HH
45 #define VSI_INOUT_HH
46 
47 //== INCLUDES =================================================================
48 #include <QString>
49 #include <QVariant>
50 #include <QMap>
51 
52 //== NAMESPACES ===============================================================
53 namespace VSI {
54 
55 //== FORWARDDECLARATIONS ======================================================
56 class Element;
57 
58 //== CLASS DEFINITION =========================================================
59 
62 class InOut {
63 
64  public:
65 
67  explicit InOut (Element *_e);
68 
70  const QString &name () const { return name_; };
71 
73  const QString &shortDescription () const { return shortDesc_; };
74 
76  const QString &longDescription () const { return longDesc_; };
77 
79  const Element * element () const { return element_; };
80 
82  QMap<QString, QString> hints () const { return hints_; };
83 
85  QString typeString () const;
86 
87  friend class Context;
88 
89  private:
90  QString name_;
91  QString shortDesc_;
92  QString longDesc_;
93 
94  QString type_;
95 
96  QMap<QString, QString> hints_;
97 
98  Element *element_;
99 };
100 
101 //=============================================================================
102 }
103 //=============================================================================
104 
105 #endif
const QString & name() const
Name.
Definition: inout.hh:70
const QString & longDescription() const
Long description.
Definition: inout.hh:76
QString typeString() const
Type.
Definition: inout.cc:65
const QString & shortDescription() const
Short description.
Definition: inout.hh:73
const Element * element() const
Element of this input/output.
Definition: inout.hh:79
InOut(Element *_e)
Constructor.
Definition: inout.cc:57
QMap< QString, QString > hints() const
Parsed hints for this input/output type.
Definition: inout.hh:82