Developer Documentation
elementInOut.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 #ifndef VSI_ELEMENTINOUT_HH
50 #define VSI_ELEMENTINOUT_HH
51 
52 //== INCLUDES =================================================================
53 
54 #include <QList>
55 
56 //== FORWARDDECLARATIONS ======================================================
57 class QGraphicsItem;
58 
59 //== NAMESPACES ===============================================================
60 namespace VSI {
61 
62 //== FORWARDDECLARATIONS ======================================================
63 class Text;
64 class ConnectionPoint;
65 class Connection;
66 class InOut;
67 class GraphicsScene;
68 class SceneElement;
69 
70 //== CLASS DEFINITION =========================================================
71 
75 class ElementInOut {
76 
77  public:
78 
80  enum Type {
81  TypeInput,
82  TypeOutput
83  };
84 
86  ElementInOut (InOut *_io, SceneElement *_parent);
87 
89  virtual ~ElementInOut ();
90 
92  virtual Type type () const = 0;
93 
95  ConnectionPoint *connectionPointItem () const { return conn_; }
96 
98  Text *typeTextItem () const { return typeText_; }
99 
101  Text *descriptionTextItem () const { return descText_; }
102 
104  QList<Connection *> connections () const { return connections_; };
105 
107  virtual void addConnection (Connection *_conn);
108 
110  virtual void removeConnection (Connection *_conn);
111 
113  bool validConnection (ElementInOut *_e);
114 
116  InOut* inOut () const { return io_; };
117 
119  SceneElement* element() { return element_; };
120 
121  private:
122 
124  ElementInOut( const ElementInOut& _orig );
125 
126  InOut *io_;
127  SceneElement *element_;
128 
129  ConnectionPoint *conn_;
130  Text *typeText_;
131  Text *descText_;
132 
133  QList<Connection *> connections_;
134 };
135 
136 //=============================================================================
137 }
138 //=============================================================================
139 
140 #endif
ConnectionPoint * connectionPointItem() const
Connection point widget.
Definition: elementInOut.hh:95
bool validConnection(ElementInOut *_e)
Can this input/output be connected to _e.
virtual ~ElementInOut()
Destructor.
virtual void addConnection(Connection *_conn)
Add the connection.
virtual void removeConnection(Connection *_conn)
Remove the Connection.
SceneElement * element()
Scene element.
Text * descriptionTextItem() const
Short description widget.
Text * typeTextItem() const
Type text widget.
Definition: elementInOut.hh:98
InOut * inOut() const
InOut context object.
virtual Type type() const =0
Type.
QList< Connection * > connections() const
Connections.
ElementInOut(InOut *_io, SceneElement *_parent)
Constructor.
Definition: elementInOut.cc:74