summaryrefslogtreecommitdiffstats
path: root/src/uml/qstate.h
blob: ca003f28e35fafe343ab3bc3f873e7e13ffda535 (plain)
1
2
3
4
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
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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
/****************************************************************************
**
** Copyright (C) 2012 Sandro S. Andrade <sandroandrade@kde.org>
** Contact: http://www.qt-project.org/
**
** This file is part of the QtUml module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** GNU Lesser General Public License Usage
** This file may be used under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation and
** appearing in the file LICENSE.LGPL included in the packaging of this
** file. Please review the following information to ensure the GNU Lesser
** General Public License version 2.1 requirements will be met:
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia  LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU General
** Public License version 3.0 as published by the Free Software Foundation
** and appearing in the file LICENSE.GPL included in the packaging of this
** file. Please review the following information to ensure the GNU General
** Public License version 3.0 requirements will be met:
** http://www.gnu.org/copyleft/gpl.html.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef QTUML_QSTATE_H
#define QTUML_QSTATE_H

#include <QtUml/QtUmlGlobal>

// Base class includes
#include <QtWrappedObjects/QWrappedObject>
#include <QtUml/QNamespace>
#include <QtUml/QRedefinableElement>
#include <QtUml/QVertex>

// Qt includes
#include <QtCore/QSet>

QT_BEGIN_HEADER

QT_BEGIN_NAMESPACE

namespace QtUml
{

QT_MODULE(QtUml)

// Forward decls for function parameters
class QStateMachine;
class QClassifier;
class QConstraint;
class QRegion;
class QBehavior;
class QConnectionPointReference;
class QTrigger;
class QPseudostate;

class QStatePrivate;

class Q_UML_EXPORT QState : public QWrappedObject
{
    Q_OBJECT

    Q_PROPERTY(QSet<QtUml::QElement *> ownedElements READ ownedElements)
    Q_PROPERTY(QtUml::QElement * owner READ owner)
    Q_PROPERTY(QSet<QtUml::QComment *> ownedComments READ ownedComments)

    Q_PROPERTY(QString name READ name WRITE setName)
    Q_PROPERTY(QtUmlNS::VisibilityKind visibility READ visibility WRITE setVisibility)
    Q_PROPERTY(QString qualifiedName READ qualifiedName STORED false)
    Q_PROPERTY(QtUml::QStringExpression * nameExpression READ nameExpression WRITE setNameExpression)
    Q_PROPERTY(QtUml::QNamespace * namespace_ READ namespace_)
    Q_PROPERTY(QSet<QtUml::QDependency *> clientDependencies READ clientDependencies)

    Q_PROPERTY(QSet<QtUml::QPackageImport *> packageImports READ packageImports)
    Q_PROPERTY(QSet<QtUml::QNamedElement *> members READ members)
    Q_PROPERTY(QSet<QtUml::QPackageableElement *> importedMembers READ importedMembers STORED false)
    Q_PROPERTY(QSet<QtUml::QElementImport *> elementImports READ elementImports)
    Q_PROPERTY(QSet<QtUml::QConstraint *> ownedRules READ ownedRules)
    Q_PROPERTY(QSet<QtUml::QNamedElement *> ownedMembers READ ownedMembers)

    Q_PROPERTY(bool isLeaf READ isLeaf WRITE setLeaf RESET unsetLeaf)
    Q_PROPERTY(QSet<QtUml::QRedefinableElement *> redefinedElements READ redefinedElements)

    Q_PROPERTY(QSet<QtUml::QTransition *> incomings READ incomings STORED false)
    Q_PROPERTY(QtUml::QRegion * container READ container WRITE setContainer)
    Q_PROPERTY(QSet<QtUml::QTransition *> outgoings READ outgoings STORED false)

    Q_PROPERTY(bool isSimple READ isSimple STORED false)
    Q_PROPERTY(bool isComposite READ isComposite STORED false)
    Q_PROPERTY(bool isOrthogonal READ isOrthogonal STORED false)
    Q_PROPERTY(bool isSubmachineState READ isSubmachineState STORED false)
    Q_PROPERTY(QSet<QtUml::QRegion *> regions READ regions)
    Q_PROPERTY(QtUml::QBehavior * exit READ exit WRITE setExit)
    Q_PROPERTY(QSet<QtUml::QConnectionPointReference *> connections READ connections)
    Q_PROPERTY(QtUml::QClassifier * redefinitionContext READ redefinitionContext STORED false)
    Q_PROPERTY(QtUml::QState * redefinedState READ redefinedState WRITE setRedefinedState)
    Q_PROPERTY(QSet<QtUml::QTrigger *> deferrableTriggers READ deferrableTriggers)
    Q_PROPERTY(QSet<QtUml::QPseudostate *> connectionPoints READ connectionPoints)
    Q_PROPERTY(QtUml::QBehavior * entry READ entry WRITE setEntry)
    Q_PROPERTY(QtUml::QBehavior * doActivity READ doActivity WRITE setDoActivity)
    Q_PROPERTY(QtUml::QStateMachine * submachine READ submachine WRITE setSubmachine)
    Q_PROPERTY(QtUml::QConstraint * stateInvariant READ stateInvariant WRITE setStateInvariant)

    Q_DISABLE_COPY(QState)
    Q_DECLARE_PRIVATE(QState)

public:
    Q_INVOKABLE explicit QState(QWrappedObject *wrapper = 0, QWrappedObject *parent = 0);
    virtual ~QState();

    // Association ends from aggregated QElement
    Q_INVOKABLE QSet<QElement *> ownedElements() const;
    Q_INVOKABLE QElement *owner() const;
    Q_INVOKABLE QSet<QComment *> ownedComments() const;
    Q_INVOKABLE void addOwnedComment(QComment *ownedComment);
    Q_INVOKABLE void removeOwnedComment(QComment *ownedComment);

    // Attributes from aggregated QNamedElement
    Q_INVOKABLE QString name() const;
    Q_INVOKABLE void setName(QString name);
    Q_INVOKABLE QtUmlNS::VisibilityKind visibility() const;
    Q_INVOKABLE void setVisibility(QtUmlNS::VisibilityKind visibility);
    Q_INVOKABLE QString qualifiedName() const;

    // Association ends from aggregated QNamedElement
    Q_INVOKABLE QStringExpression *nameExpression() const;
    Q_INVOKABLE void setNameExpression(QStringExpression *nameExpression);
    Q_INVOKABLE QNamespace *namespace_() const;
    Q_INVOKABLE QSet<QDependency *> clientDependencies() const;
    Q_INVOKABLE void addClientDependency(QDependency *clientDependency);
    Q_INVOKABLE void removeClientDependency(QDependency *clientDependency);

    // Association ends from aggregated QNamespace
    Q_INVOKABLE QSet<QPackageImport *> packageImports() const;
    Q_INVOKABLE void addPackageImport(QPackageImport *packageImport);
    Q_INVOKABLE void removePackageImport(QPackageImport *packageImport);
    Q_INVOKABLE QSet<QNamedElement *> members() const;
    Q_INVOKABLE QSet<QPackageableElement *> importedMembers() const;
    Q_INVOKABLE QSet<QElementImport *> elementImports() const;
    Q_INVOKABLE void addElementImport(QElementImport *elementImport);
    Q_INVOKABLE void removeElementImport(QElementImport *elementImport);
    Q_INVOKABLE QSet<QConstraint *> ownedRules() const;
    Q_INVOKABLE void addOwnedRule(QConstraint *ownedRule);
    Q_INVOKABLE void removeOwnedRule(QConstraint *ownedRule);
    Q_INVOKABLE QSet<QNamedElement *> ownedMembers() const;

    // Attributes from aggregated QRedefinableElement
    Q_INVOKABLE bool isLeaf() const;
    Q_INVOKABLE void setLeaf(bool isLeaf);
    Q_INVOKABLE void unsetLeaf();

    // Association ends from aggregated QRedefinableElement
    Q_INVOKABLE QSet<QRedefinableElement *> redefinedElements() const;

    // Association ends from aggregated QVertex
    Q_INVOKABLE QSet<QTransition *> incomings() const;
    Q_INVOKABLE QRegion *container() const;
    Q_INVOKABLE void setContainer(QRegion *container);
    Q_INVOKABLE QSet<QTransition *> outgoings() const;

    // Attributes from QState
    Q_INVOKABLE bool isSimple() const;
    Q_INVOKABLE bool isComposite() const;
    Q_INVOKABLE bool isOrthogonal() const;
    Q_INVOKABLE bool isSubmachineState() const;

    // Association ends from QState
    Q_INVOKABLE QSet<QRegion *> regions() const;
    Q_INVOKABLE void addRegion(QRegion *region);
    Q_INVOKABLE void removeRegion(QRegion *region);
    Q_INVOKABLE QBehavior *exit() const;
    Q_INVOKABLE void setExit(QBehavior *exit);
    Q_INVOKABLE QSet<QConnectionPointReference *> connections() const;
    Q_INVOKABLE void addConnection(QConnectionPointReference *connection);
    Q_INVOKABLE void removeConnection(QConnectionPointReference *connection);
    Q_INVOKABLE QClassifier *redefinitionContext() const;
    Q_INVOKABLE QState *redefinedState() const;
    Q_INVOKABLE void setRedefinedState(QState *redefinedState);
    Q_INVOKABLE QSet<QTrigger *> deferrableTriggers() const;
    Q_INVOKABLE void addDeferrableTrigger(QTrigger *deferrableTrigger);
    Q_INVOKABLE void removeDeferrableTrigger(QTrigger *deferrableTrigger);
    Q_INVOKABLE QSet<QPseudostate *> connectionPoints() const;
    Q_INVOKABLE void addConnectionPoint(QPseudostate *connectionPoint);
    Q_INVOKABLE void removeConnectionPoint(QPseudostate *connectionPoint);
    Q_INVOKABLE QBehavior *entry() const;
    Q_INVOKABLE void setEntry(QBehavior *entry);
    Q_INVOKABLE QBehavior *doActivity() const;
    Q_INVOKABLE void setDoActivity(QBehavior *doActivity);
    Q_INVOKABLE QStateMachine *submachine() const;
    Q_INVOKABLE void setSubmachine(QStateMachine *submachine);
    Q_INVOKABLE QConstraint *stateInvariant() const;
    Q_INVOKABLE void setStateInvariant(QConstraint *stateInvariant);

    // Operations
    Q_INVOKABLE QStateMachine *containingStateMachine() const;
    Q_INVOKABLE bool isConsistentWith(const QRedefinableElement *redefinee) const;
    Q_INVOKABLE bool isRedefinitionContextValid(const QState *redefined) const;

    virtual void setPropertyData();

protected:
    explicit QState(QStatePrivate &dd, QWrappedObject *wrapper = 0, QWrappedObject *parent = 0);

private:
    QNamespace *_wrappedNamespace;
    QRedefinableElement *_wrappedRedefinableElement;
    QVertex *_wrappedVertex;
};

}

QT_END_NAMESPACE

QT_END_HEADER

#endif // QTUML_QSTATE_H