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 * $Revision$ *
45 * $LastChangedBy$ *
46 * $Date$ *
47 * *
48 \*===========================================================================*/
49 
50 #ifndef VSI_INOUT_HH
51 #define VSI_INOUT_HH
52 
53 //== INCLUDES =================================================================
54 #include <QString>
55 #include <QVariant>
56 #include <QMap>
57 
58 //== NAMESPACES ===============================================================
59 namespace VSI {
60 
61 //== FORWARDDECLARATIONS ======================================================
62 class Element;
63 
64 //== CLASS DEFINITION =========================================================
65 
68 class InOut {
69 
70  public:
71 
73  InOut (Element *_e);
74 
76  const QString &name () const { return name_; };
77 
79  const QString &shortDescription () const { return shortDesc_; };
80 
82  const QString &longDescription () const { return longDesc_; };
83 
85  const Element * element () const { return element_; };
86 
88  QMap<QString, QString> hints () const { return hints_; };
89 
91  QString typeString () const;
92 
93  friend class Context;
94 
95  private:
96  QString name_;
97  QString shortDesc_;
98  QString longDesc_;
99 
100  QString type_;
101 
102  QMap<QString, QString> hints_;
103 
104  Element *element_;
105 };
106 
107 //=============================================================================
108 }
109 //=============================================================================
110 
111 #endif
QString typeString() const
Type.
Definition: inout.cc:71
QMap< QString, QString > hints() const
Parsed hints for this input/output type.
Definition: inout.hh:88
const QString & longDescription() const
Long description.
Definition: inout.hh:82
const QString & name() const
Name.
Definition: inout.hh:76
const QString & shortDescription() const
Short description.
Definition: inout.hh:79
InOut(Element *_e)
Constructor.
Definition: inout.cc:63
const Element * element() const
Element of this input/output.
Definition: inout.hh:85