Developer Documentation
function.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_FUNCTION_HH_
51 #define VSI_FUNCTION_HH_
52 
53 //== INCLUDES =================================================================
54 #include <QString>
55 #include <QVector>
56 
57 //== NAMESPACES ===============================================================
58 namespace VSI {
59 
60 //== FORWARDDECLARATIONS ======================================================
61 class Input;
62 class Output;
63 class InOut;
64 class Context;
65 class Element;
66 
67 //== CLASS DEFINITION =========================================================
68 
73 class Function {
74 
75  public:
76 
78  Function (Element *_element, QString _name);
79 
81  ~Function ();
82 
84  Element *element () const { return element_; };
85 
87  QString name () const { return name_; };
88 
90  const QString &shortDescription () const { return shortDesc_; };
91 
93  const QString &longDescription () const { return longDesc_; };
94 
96  Element *start () const { return start_; };
97 
99  Element *end () const { return end_; };
100 
101  friend class Context;
102 
103  private:
104  Element *element_;
105 
106  QString name_;
107  QString shortDesc_;
108  QString longDesc_;
109 
110  Element *start_;
111  Element *end_;
112 };
113 
114 //=============================================================================
115 }
116 //=============================================================================
117 
118 #endif
QString name() const
Name.
Definition: function.hh:87
Element * element() const
Element that this function belongs to.
Definition: function.hh:84
const QString & shortDescription() const
Short description.
Definition: function.hh:90
Element * end() const
End element of this function (can be NULL)
Definition: function.hh:99
Function(Element *_element, QString _name)
Constructor.
Definition: function.cc:65
Element * start() const
Start element of this function.
Definition: function.hh:96
const QString & longDescription() const
Long description.
Definition: function.hh:93
~Function()
Destructor.
Definition: function.cc:76