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