path: root/src/uml/qobjects/qumlportobject_p.h

/****************************************************************************
**
** Copyright (C) 2013 Sandro S. Andrade <sandroandrade@kde.org>
** Contact: http://www.qt-project.org/legal
**
** This file is part of the QtUml module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, 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, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt 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.
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef QUMLPORTOBJECT_H
#define QUMLPORTOBJECT_H

#include <QtUml/QtUmlGlobal>

#include <QtModeling/QModelingObject>

#include <QtUml/QtUmlNamespace>

QT_BEGIN_HEADER

QT_BEGIN_NAMESPACE

QT_MODULE(QtUml)

class QUmlPort;
class QModelingObjectPrivate;
class Q_UML_EXPORT QUmlPortObject : public QModelingObject
{
    Q_OBJECT
    Q_DISABLE_COPY(QUmlPortObject)
    Q_DECLARE_PRIVATE(QModelingObject)

    // Properties [Element]
    Q_PROPERTY(QSet<QObject *> ownedComments READ ownedComments NOTIFY ownedCommentsChanged)
    Q_PROPERTY(QSet<QObject *> ownedElements READ ownedElements NOTIFY ownedElementsChanged)
    Q_PROPERTY(QObject * owner READ owner NOTIFY ownerChanged)

    // Properties [NamedElement]
    Q_PROPERTY(QSet<QObject *> clientDependencies READ clientDependencies NOTIFY clientDependenciesChanged)
    Q_PROPERTY(QString name READ name WRITE setName NOTIFY nameChanged)
    Q_PROPERTY(QObject * nameExpression READ nameExpression WRITE setNameExpression NOTIFY nameExpressionChanged)
    Q_PROPERTY(QObject * namespace_ READ namespace_ NOTIFY namespaceChanged)
    Q_PROPERTY(QString qualifiedName READ qualifiedName NOTIFY qualifiedNameChanged STORED false)
    Q_PROPERTY(QtUml::VisibilityKind visibility READ visibility WRITE setVisibility NOTIFY visibilityChanged)

    // Properties [TypedElement]
    Q_PROPERTY(QObject * type READ type WRITE setType NOTIFY typeChanged)

    // Properties [MultiplicityElement]
    Q_PROPERTY(bool isOrdered READ isOrdered WRITE setOrdered NOTIFY isOrderedChanged RESET unsetOrdered)
    Q_PROPERTY(bool isUnique READ isUnique WRITE setUnique NOTIFY isUniqueChanged RESET unsetUnique)
    Q_PROPERTY(int lower READ lower WRITE setLower NOTIFY lowerChanged RESET unsetLower STORED false)
    Q_PROPERTY(QObject * lowerValue READ lowerValue WRITE setLowerValue NOTIFY lowerValueChanged)
    Q_PROPERTY(QString upper READ upper WRITE setUpper NOTIFY upperChanged RESET unsetUpper STORED false)
    Q_PROPERTY(QObject * upperValue READ upperValue WRITE setUpperValue NOTIFY upperValueChanged)

    // Properties [RedefinableElement]
    Q_PROPERTY(bool isLeaf READ isLeaf WRITE setLeaf NOTIFY isLeafChanged RESET unsetLeaf)
    Q_PROPERTY(QSet<QObject *> redefinedElements READ redefinedElements NOTIFY redefinedElementsChanged)
    Q_PROPERTY(QSet<QObject *> redefinitionContexts READ redefinitionContexts NOTIFY redefinitionContextsChanged)

    // Properties [Feature]
    Q_PROPERTY(QSet<QObject *> featuringClassifiers READ featuringClassifiers NOTIFY featuringClassifiersChanged)
    Q_PROPERTY(bool isStatic READ isStatic WRITE setStatic NOTIFY isStaticChanged RESET unsetStatic)

    // Properties [StructuralFeature]

    // Properties [ParameterableElement]
    Q_PROPERTY(QObject * owningTemplateParameter READ owningTemplateParameter WRITE setOwningTemplateParameter NOTIFY owningTemplateParameterChanged)

    // Properties [ConnectableElement]
    Q_PROPERTY(QList<QObject *> ends READ ends NOTIFY endsChanged STORED false)
    Q_PROPERTY(QObject * templateParameter READ templateParameter WRITE setTemplateParameter NOTIFY templateParameterChanged)

    // Properties [DeploymentTarget]
    Q_PROPERTY(QSet<QObject *> deployedElements READ deployedElements NOTIFY deployedElementsChanged STORED false)
    Q_PROPERTY(QSet<QObject *> deployments READ deployments NOTIFY deploymentsChanged)

    // Properties [Property]
    Q_PROPERTY(QtUml::AggregationKind aggregation READ aggregation WRITE setAggregation NOTIFY aggregationChanged RESET unsetAggregation)
    Q_PROPERTY(QObject * association READ association WRITE setAssociation NOTIFY associationChanged)
    Q_PROPERTY(QObject * associationEnd READ associationEnd WRITE setAssociationEnd NOTIFY associationEndChanged)
    Q_PROPERTY(QObject * class_ READ class_ WRITE setClass NOTIFY classChanged)
    Q_PROPERTY(QObject * datatype READ datatype WRITE setDatatype NOTIFY datatypeChanged)
    Q_PROPERTY(QString default_ READ default_ WRITE setDefault NOTIFY defaultChanged STORED false)
    Q_PROPERTY(QObject * defaultValue READ defaultValue WRITE setDefaultValue NOTIFY defaultValueChanged)
    Q_PROPERTY(QObject * interface_ READ interface_ WRITE setInterface NOTIFY interfaceChanged)
    Q_PROPERTY(bool isComposite READ isComposite WRITE setComposite NOTIFY isCompositeChanged RESET unsetComposite STORED false)
    Q_PROPERTY(bool isDerived READ isDerived WRITE setDerived NOTIFY isDerivedChanged RESET unsetDerived)
    Q_PROPERTY(bool isDerivedUnion READ isDerivedUnion WRITE setDerivedUnion NOTIFY isDerivedUnionChanged RESET unsetDerivedUnion)
    Q_PROPERTY(bool isID READ isID WRITE setID NOTIFY isIDChanged RESET unsetID)
    Q_PROPERTY(bool isReadOnly READ isReadOnly WRITE setReadOnly NOTIFY isReadOnlyChanged RESET unsetReadOnly)
    Q_PROPERTY(QObject * opposite READ opposite WRITE setOpposite NOTIFY oppositeChanged STORED false)
    Q_PROPERTY(QObject * owningAssociation READ owningAssociation WRITE setOwningAssociation NOTIFY owningAssociationChanged)
    Q_PROPERTY(QList<QObject *> qualifiers READ qualifiers NOTIFY qualifiersChanged)
    Q_PROPERTY(QSet<QObject *> redefinedProperties READ redefinedProperties NOTIFY redefinedPropertiesChanged)
    Q_PROPERTY(QSet<QObject *> subsettedProperties READ subsettedProperties NOTIFY subsettedPropertiesChanged)

    // Properties [Port]
    Q_PROPERTY(bool isBehavior READ isBehavior WRITE setBehavior NOTIFY isBehaviorChanged RESET unsetBehavior)
    Q_PROPERTY(bool isConjugated READ isConjugated WRITE setConjugated NOTIFY isConjugatedChanged RESET unsetConjugated)
    Q_PROPERTY(bool isService READ isService WRITE setService NOTIFY isServiceChanged RESET unsetService)
    Q_PROPERTY(QObject * protocol READ protocol WRITE setProtocol NOTIFY protocolChanged)
    Q_PROPERTY(QSet<QObject *> provided READ provided NOTIFY providedChanged STORED false)
    Q_PROPERTY(QSet<QObject *> redefinedPorts READ redefinedPorts NOTIFY redefinedPortsChanged)
    Q_PROPERTY(QSet<QObject *> required READ required NOTIFY requiredChanged STORED false)

public:
    Q_INVOKABLE explicit QUmlPortObject(QUmlPort *modelingElement);

    // Owned attributes [Element]
    Q_INVOKABLE const QSet<QObject *> ownedComments() const;
    Q_INVOKABLE const QSet<QObject *> ownedElements() const;
    Q_INVOKABLE QObject *owner() const;

    // Owned attributes [NamedElement]
    Q_INVOKABLE const QSet<QObject *> clientDependencies() const;
    Q_INVOKABLE QString name() const;
    Q_INVOKABLE QObject *nameExpression() const;
    Q_INVOKABLE QObject *namespace_() const;
    Q_INVOKABLE QString qualifiedName() const;
    Q_INVOKABLE QtUml::VisibilityKind visibility() const;

    // Owned attributes [TypedElement]
    Q_INVOKABLE QObject *type() const;

    // Owned attributes [MultiplicityElement]
    Q_INVOKABLE bool isOrdered() const;
    Q_INVOKABLE bool isUnique() const;
    Q_INVOKABLE int lower() const;
    Q_INVOKABLE QObject *lowerValue() const;
    Q_INVOKABLE QString upper() const;
    Q_INVOKABLE QObject *upperValue() const;

    // Owned attributes [RedefinableElement]
    Q_INVOKABLE bool isLeaf() const;
    Q_INVOKABLE const QSet<QObject *> redefinedElements() const;
    Q_INVOKABLE const QSet<QObject *> redefinitionContexts() const;

    // Owned attributes [Feature]
    Q_INVOKABLE const QSet<QObject *> featuringClassifiers() const;
    Q_INVOKABLE bool isStatic() const;

    // Owned attributes [StructuralFeature]

    // Owned attributes [ParameterableElement]
    Q_INVOKABLE QObject *owningTemplateParameter() const;

    // Owned attributes [ConnectableElement]
    Q_INVOKABLE const QList<QObject *> ends() const;
    Q_INVOKABLE QObject *templateParameter() const;

    // Owned attributes [DeploymentTarget]
    Q_INVOKABLE const QSet<QObject *> deployedElements() const;
    Q_INVOKABLE const QSet<QObject *> deployments() const;

    // Owned attributes [Property]
    Q_INVOKABLE QtUml::AggregationKind aggregation() const;
    Q_INVOKABLE QObject *association() const;
    Q_INVOKABLE QObject *associationEnd() const;
    Q_INVOKABLE QObject *class_() const;
    Q_INVOKABLE QObject *datatype() const;
    Q_INVOKABLE QString default_() const;
    Q_INVOKABLE QObject *defaultValue() const;
    Q_INVOKABLE QObject *interface_() const;
    Q_INVOKABLE bool isComposite() const;
    Q_INVOKABLE bool isDerived() const;
    Q_INVOKABLE bool isDerivedUnion() const;
    Q_INVOKABLE bool isID() const;
    Q_INVOKABLE bool isReadOnly() const;
    Q_INVOKABLE QObject *opposite() const;
    Q_INVOKABLE QObject *owningAssociation() const;
    Q_INVOKABLE const QList<QObject *> qualifiers() const;
    Q_INVOKABLE const QSet<QObject *> redefinedProperties() const;
    Q_INVOKABLE const QSet<QObject *> subsettedProperties() const;

    // Owned attributes [Port]
    Q_INVOKABLE bool isBehavior() const;
    Q_INVOKABLE bool isConjugated() const;
    Q_INVOKABLE bool isService() const;
    Q_INVOKABLE QObject *protocol() const;
    Q_INVOKABLE const QSet<QObject *> provided() const;
    Q_INVOKABLE const QSet<QObject *> redefinedPorts() const;
    Q_INVOKABLE const QSet<QObject *> required() const;

    // Operations [Element]
    Q_INVOKABLE QSet<QObject *> allOwnedElements() const;
    Q_INVOKABLE bool mustBeOwned() const;

    // Operations [NamedElement]
    Q_INVOKABLE QList<QObject *> allNamespaces() const;
    Q_INVOKABLE QSet<QObject *> allOwningPackages() const;
    Q_INVOKABLE bool isDistinguishableFrom(QObject *n, QObject *ns) const;
    Q_INVOKABLE QString separator() const;

    // Operations [MultiplicityElement]
    Q_INVOKABLE bool compatibleWith(QObject *other) const;
    Q_INVOKABLE bool includesCardinality(int C) const;
    Q_INVOKABLE bool includesMultiplicity(QObject *M) const;
    Q_INVOKABLE bool is(int lowerbound, int upperbound) const;
    Q_INVOKABLE bool isMultivalued() const;
    Q_INVOKABLE int lowerBound() const;
    Q_INVOKABLE QString upperBoundOperation() const;

    // Operations [RedefinableElement]
    Q_INVOKABLE bool isRedefinitionContextValid(QObject *redefined) const;

    // Operations [ParameterableElement]
    Q_INVOKABLE bool isTemplateParameter() const;

    // Operations [Property]
    Q_INVOKABLE bool isAttribute(QObject *p) const;
    Q_INVOKABLE bool isCompatibleWith(QObject *p) const;
    Q_INVOKABLE bool isConsistentWith(QObject *redefinee) const;
    Q_INVOKABLE bool isNavigable() const;
    Q_INVOKABLE QSet<QObject *> subsettingContext() const;

public Q_SLOTS:

    // Slots for owned attributes [Element]
    void addOwnedComment(QObject *ownedComment);
    void removeOwnedComment(QObject *ownedComment);
    void Q_DECL_HIDDEN addOwnedElement(QObject *ownedElement);
    void Q_DECL_HIDDEN removeOwnedElement(QObject *ownedElement);
    void Q_DECL_HIDDEN setOwner(QObject *owner = 0);

    // Slots for owned attributes [NamedElement]
    void addClientDependency(QObject *clientDependency);
    void removeClientDependency(QObject *clientDependency);
    void setName(QString name);
    void setNameExpression(QObject *nameExpression = 0);
    void Q_DECL_HIDDEN setNamespace(QObject *namespace_ = 0);
    void Q_DECL_HIDDEN setQualifiedName(QString qualifiedName);
    void setVisibility(QtUml::VisibilityKind visibility);

    // Slots for owned attributes [TypedElement]
    void setType(QObject *type = 0);

    // Slots for owned attributes [MultiplicityElement]
    void setOrdered(bool isOrdered);
    void unsetOrdered();
    void setUnique(bool isUnique);
    void unsetUnique();
    void setLower(int lower);
    void unsetLower();
    void setLowerValue(QObject *lowerValue = 0);
    void setUpper(QString upper);
    void unsetUpper();
    void setUpperValue(QObject *upperValue = 0);

    // Slots for owned attributes [RedefinableElement]
    void setLeaf(bool isLeaf);
    void unsetLeaf();
    void Q_DECL_HIDDEN addRedefinedElement(QObject *redefinedElement);
    void Q_DECL_HIDDEN removeRedefinedElement(QObject *redefinedElement);
    void Q_DECL_HIDDEN addRedefinitionContext(QObject *redefinitionContext);
    void Q_DECL_HIDDEN removeRedefinitionContext(QObject *redefinitionContext);

    // Slots for owned attributes [Feature]
    void Q_DECL_HIDDEN addFeaturingClassifier(QObject *featuringClassifier);
    void Q_DECL_HIDDEN removeFeaturingClassifier(QObject *featuringClassifier);
    void setStatic(bool isStatic);
    void unsetStatic();

    // Slots for owned attributes [StructuralFeature]

    // Slots for owned attributes [ParameterableElement]
    void setOwningTemplateParameter(QObject *owningTemplateParameter = 0);

    // Slots for owned attributes [ConnectableElement]
    void Q_DECL_HIDDEN addEnd(QObject *end);
    void Q_DECL_HIDDEN removeEnd(QObject *end);
    void setTemplateParameter(QObject *templateParameter = 0);

    // Slots for owned attributes [DeploymentTarget]
    void Q_DECL_HIDDEN addDeployedElement(QObject *deployedElement);
    void Q_DECL_HIDDEN removeDeployedElement(QObject *deployedElement);
    void addDeployment(QObject *deployment);
    void removeDeployment(QObject *deployment);

    // Slots for owned attributes [Property]
    void setAggregation(QtUml::AggregationKind aggregation);
    void unsetAggregation();
    void setAssociation(QObject *association = 0);
    void setAssociationEnd(QObject *associationEnd = 0);
    void setClass(QObject *class_ = 0);
    void setDatatype(QObject *datatype = 0);
    void setDefault(QString default_);
    void setDefaultValue(QObject *defaultValue = 0);
    void setInterface(QObject *interface_ = 0);
    void setComposite(bool isComposite);
    void unsetComposite();
    void setDerived(bool isDerived);
    void unsetDerived();
    void setDerivedUnion(bool isDerivedUnion);
    void unsetDerivedUnion();
    void setID(bool isID);
    void unsetID();
    void setReadOnly(bool isReadOnly);
    void unsetReadOnly();
    void setOpposite(QObject *opposite = 0);
    void setOwningAssociation(QObject *owningAssociation = 0);
    void addQualifier(QObject *qualifier);
    void removeQualifier(QObject *qualifier);
    void addRedefinedProperty(QObject *redefinedProperty);
    void removeRedefinedProperty(QObject *redefinedProperty);
    void addSubsettedProperty(QObject *subsettedProperty);
    void removeSubsettedProperty(QObject *subsettedProperty);

    // Slots for owned attributes [Port]
    void setBehavior(bool isBehavior);
    void unsetBehavior();
    void setConjugated(bool isConjugated);
    void unsetConjugated();
    void setService(bool isService);
    void unsetService();
    void setProtocol(QObject *protocol = 0);
    void Q_DECL_HIDDEN addProvided(QObject *provided);
    void Q_DECL_HIDDEN removeProvided(QObject *provided);
    void addRedefinedPort(QObject *redefinedPort);
    void removeRedefinedPort(QObject *redefinedPort);
    void Q_DECL_HIDDEN addRequired(QObject *required);
    void Q_DECL_HIDDEN removeRequired(QObject *required);

Q_SIGNALS:

    // Signals for owned attributes [Element]
    void ownedCommentsChanged(QSet<QObject *> ownedComments);
    void ownedElementsChanged(QSet<QObject *> ownedElements);
    void ownerChanged(QObject *owner);

    // Signals for owned attributes [NamedElement]
    void clientDependenciesChanged(QSet<QObject *> clientDependencies);
    void nameChanged(QString name);
    void nameExpressionChanged(QObject *nameExpression);
    void namespaceChanged(QObject *namespace_);
    void qualifiedNameChanged(QString qualifiedName);
    void visibilityChanged(QtUml::VisibilityKind visibility);

    // Signals for owned attributes [TypedElement]
    void typeChanged(QObject *type);

    // Signals for owned attributes [MultiplicityElement]
    void isOrderedChanged(bool isOrdered);
    void isUniqueChanged(bool isUnique);
    void lowerChanged(int lower);
    void lowerValueChanged(QObject *lowerValue);
    void upperChanged(QString upper);
    void upperValueChanged(QObject *upperValue);

    // Signals for owned attributes [RedefinableElement]
    void isLeafChanged(bool isLeaf);
    void redefinedElementsChanged(QSet<QObject *> redefinedElements);
    void redefinitionContextsChanged(QSet<QObject *> redefinitionContexts);

    // Signals for owned attributes [Feature]
    void featuringClassifiersChanged(QSet<QObject *> featuringClassifiers);
    void isStaticChanged(bool isStatic);

    // Signals for owned attributes [StructuralFeature]

    // Signals for owned attributes [ParameterableElement]
    void owningTemplateParameterChanged(QObject *owningTemplateParameter);

    // Signals for owned attributes [ConnectableElement]
    void endsChanged(QList<QObject *> ends);
    void templateParameterChanged(QObject *templateParameter);

    // Signals for owned attributes [DeploymentTarget]
    void deployedElementsChanged(QSet<QObject *> deployedElements);
    void deploymentsChanged(QSet<QObject *> deployments);

    // Signals for owned attributes [Property]
    void aggregationChanged(QtUml::AggregationKind aggregation);
    void associationChanged(QObject *association);
    void associationEndChanged(QObject *associationEnd);
    void classChanged(QObject *class_);
    void datatypeChanged(QObject *datatype);
    void defaultChanged(QString default_);
    void defaultValueChanged(QObject *defaultValue);
    void interfaceChanged(QObject *interface_);
    void isCompositeChanged(bool isComposite);
    void isDerivedChanged(bool isDerived);
    void isDerivedUnionChanged(bool isDerivedUnion);
    void isIDChanged(bool isID);
    void isReadOnlyChanged(bool isReadOnly);
    void oppositeChanged(QObject *opposite);
    void owningAssociationChanged(QObject *owningAssociation);
    void qualifiersChanged(QList<QObject *> qualifiers);
    void redefinedPropertiesChanged(QSet<QObject *> redefinedProperties);
    void subsettedPropertiesChanged(QSet<QObject *> subsettedProperties);

    // Signals for owned attributes [Port]
    void isBehaviorChanged(bool isBehavior);
    void isConjugatedChanged(bool isConjugated);
    void isServiceChanged(bool isService);
    void protocolChanged(QObject *protocol);
    void providedChanged(QSet<QObject *> provided);
    void redefinedPortsChanged(QSet<QObject *> redefinedPorts);
    void requiredChanged(QSet<QObject *> required);

protected:
    virtual void setGroupProperties();
    virtual void setPropertyData();
};

QT_END_NAMESPACE

QT_END_HEADER

#endif // QUMLPORTOBJECT_H