inout.hh 4.47 KB
Newer Older
Jan Möbius's avatar
Jan Möbius committed
1 2 3
/*===========================================================================*\
*                                                                            *
*                              OpenFlipper                                   *
Jan Möbius's avatar
Jan Möbius committed
4
*      Copyright (C) 2001-2011 by Computer Graphics Group, RWTH Aachen       *
Jan Möbius's avatar
Jan Möbius committed
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41
*                           www.openflipper.org                              *
*                                                                            *
*--------------------------------------------------------------------------- *
*  This file is part of OpenFlipper.                                         *
*                                                                            *
*  OpenFlipper is free software: you can redistribute it and/or modify       *
*  it under the terms of the GNU Lesser General Public License as            *
*  published by the Free Software Foundation, either version 3 of            *
*  the License, or (at your option) any later version with the               *
*  following exceptions:                                                     *
*                                                                            *
*  If other files instantiate templates or use macros                        *
*  or inline functions from this file, or you compile this file and          *
*  link it with other files to produce an executable, this file does         *
*  not by itself cause the resulting executable to be covered by the         *
*  GNU Lesser General Public License. This exception does not however        *
*  invalidate any other reasons why the executable file might be             *
*  covered by the GNU Lesser General Public License.                         *
*                                                                            *
*  OpenFlipper is distributed in the hope that it will be useful,            *
*  but WITHOUT ANY WARRANTY; without even the implied warranty of            *
*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the             *
*  GNU Lesser General Public License for more details.                       *
*                                                                            *
*  You should have received a copy of the GNU LesserGeneral Public           *
*  License along with OpenFlipper. If not,                                   *
*  see <http://www.gnu.org/licenses/>.                                       *
*                                                                            *
\*===========================================================================*/

/*===========================================================================*\
*                                                                            *
*   $Revision$                                                       *
*   $LastChangedBy$                                                *
*   $Date$                     *
*                                                                            *
\*===========================================================================*/
Jan Möbius's avatar
 
Jan Möbius committed
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68

#ifndef VSI_INOUT_HH
#define VSI_INOUT_HH

//== INCLUDES =================================================================
#include <QString>
#include <QVariant>
#include <QMap>

//== NAMESPACES ===============================================================
namespace VSI {

//== FORWARDDECLARATIONS ======================================================
class Element;

//== CLASS DEFINITION =========================================================

/** Base class for element inputs and outputs. It holds all common data.
  */
class InOut {

  public:

    /// Constructor
    InOut (Element *_e);

    /// Name
Jan Möbius's avatar
Jan Möbius committed
69
    const QString &name () const { return name_; };
Jan Möbius's avatar
 
Jan Möbius committed
70 71

    /// Short description
Jan Möbius's avatar
Jan Möbius committed
72
    const QString &shortDescription () const { return shortDesc_; };
Jan Möbius's avatar
 
Jan Möbius committed
73 74

    /// Long description
Jan Möbius's avatar
Jan Möbius committed
75
    const QString &longDescription () const { return longDesc_; };
Jan Möbius's avatar
 
Jan Möbius committed
76 77

    /// Element of this input/output
Jan Möbius's avatar
Jan Möbius committed
78
    const Element * element () const { return element_; };
Jan Möbius's avatar
 
Jan Möbius committed
79 80 81 82 83

    /// Parsed hints for this input/output type
    QMap<QString, QString> hints () const { return hints_; };

    /// Type
Jan Möbius's avatar
Jan Möbius committed
84
    QString typeString () const;
Jan Möbius's avatar
 
Jan Möbius committed
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104

    friend class Context;

  private:
    QString name_;
    QString shortDesc_;
    QString longDesc_;

    QString type_;

    QMap<QString, QString> hints_;

    Element *element_;
};

//=============================================================================
}
//=============================================================================

#endif