/****************************************************************************
**
** 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 QUMLINFORMATIONFLOWOBJECT_H
#define QUMLINFORMATIONFLOWOBJECT_H

#include <QtUml/QtUmlGlobal>

#include <QtModeling/QModelingObject>

#include <QtUml/QtUmlNamespace>

QT_BEGIN_NAMESPACE

QT_MODULE(QtUml)

class QUmlInformationFlow;
class QModelingObjectPrivate;
class Q_UML_EXPORT QUmlInformationFlowObject : public QModelingObject
{
    Q_OBJECT
    Q_DISABLE_COPY(QUmlInformationFlowObject)
    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 [Relationship]
    Q_PROPERTY(QSet<QObject *> relatedElements READ relatedElements NOTIFY relatedElementsChanged)

    // Properties [DirectedRelationship]
    Q_PROPERTY(QSet<QObject *> sources READ sources NOTIFY sourcesChanged)
    Q_PROPERTY(QSet<QObject *> targets READ targets NOTIFY targetsChanged)

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

    // 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)

    // Properties [PackageableElement]
    Q_PROPERTY(QtUml::VisibilityKind visibility READ visibility WRITE setVisibility NOTIFY visibilityChanged RESET unsetVisibility)

    // Properties [InformationFlow]
    Q_PROPERTY(QSet<QObject *> conveyed READ conveyed NOTIFY conveyedChanged)
    Q_PROPERTY(QSet<QObject *> informationSources READ informationSources NOTIFY informationSourcesChanged)
    Q_PROPERTY(QSet<QObject *> informationTargets READ informationTargets NOTIFY informationTargetsChanged)
    Q_PROPERTY(QSet<QObject *> realizations READ realizations NOTIFY realizationsChanged)
    Q_PROPERTY(QSet<QObject *> realizingActivityEdges READ realizingActivityEdges NOTIFY realizingActivityEdgesChanged)
    Q_PROPERTY(QSet<QObject *> realizingConnectors READ realizingConnectors NOTIFY realizingConnectorsChanged)
    Q_PROPERTY(QSet<QObject *> realizingMessages READ realizingMessages NOTIFY realizingMessagesChanged)

public:
    Q_INVOKABLE explicit QUmlInformationFlowObject(QUmlInformationFlow *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 [Relationship]
    Q_INVOKABLE const QSet<QObject *> relatedElements() const;

    // Owned attributes [DirectedRelationship]
    Q_INVOKABLE const QSet<QObject *> sources() const;
    Q_INVOKABLE const QSet<QObject *> targets() const;

    // Owned attributes [ParameterableElement]
    Q_INVOKABLE QObject *owningTemplateParameter() const;
    Q_INVOKABLE QObject *templateParameter() 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;

    // Owned attributes [PackageableElement]
    Q_INVOKABLE QtUml::VisibilityKind visibility() const;

    // Owned attributes [InformationFlow]
    Q_INVOKABLE const QSet<QObject *> conveyed() const;
    Q_INVOKABLE const QSet<QObject *> informationSources() const;
    Q_INVOKABLE const QSet<QObject *> informationTargets() const;
    Q_INVOKABLE const QSet<QObject *> realizations() const;
    Q_INVOKABLE const QSet<QObject *> realizingActivityEdges() const;
    Q_INVOKABLE const QSet<QObject *> realizingConnectors() const;
    Q_INVOKABLE const QSet<QObject *> realizingMessages() const;

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

    // Operations [ParameterableElement]
    Q_TODO Q_INVOKABLE bool isCompatibleWith(QObject *p) const;
    Q_TODO Q_INVOKABLE bool isTemplateParameter() const;

    // Operations [NamedElement]
    Q_INVOKABLE QList<QObject *> allNamespaces() const;
    Q_TODO Q_INVOKABLE QSet<QObject *> allOwningPackages() const;
    Q_TODO Q_INVOKABLE bool isDistinguishableFrom(QObject *n, QObject *ns) const;
    Q_INVOKABLE QString separator() 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 [Relationship]
    void Q_DECL_HIDDEN addRelatedElement(QObject *relatedElement);
    void Q_DECL_HIDDEN removeRelatedElement(QObject *relatedElement);

    // Slots for owned attributes [DirectedRelationship]
    void Q_DECL_HIDDEN addSource(QObject *source);
    void Q_DECL_HIDDEN removeSource(QObject *source);
    void Q_DECL_HIDDEN addTarget(QObject *target);
    void Q_DECL_HIDDEN removeTarget(QObject *target);

    // Slots for owned attributes [ParameterableElement]
    void setOwningTemplateParameter(QObject *owningTemplateParameter = 0);
    void setTemplateParameter(QObject *templateParameter = 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);

    // Slots for owned attributes [PackageableElement]
    void setVisibility(QtUml::VisibilityKind visibility);
    void unsetVisibility();

    // Slots for owned attributes [InformationFlow]
    void addConveyed(QObject *conveyed);
    void removeConveyed(QObject *conveyed);
    void addInformationSource(QObject *informationSource);
    void removeInformationSource(QObject *informationSource);
    void addInformationTarget(QObject *informationTarget);
    void removeInformationTarget(QObject *informationTarget);
    void addRealization(QObject *realization);
    void removeRealization(QObject *realization);
    void addRealizingActivityEdge(QObject *realizingActivityEdge);
    void removeRealizingActivityEdge(QObject *realizingActivityEdge);
    void addRealizingConnector(QObject *realizingConnector);
    void removeRealizingConnector(QObject *realizingConnector);
    void addRealizingMessage(QObject *realizingMessage);
    void removeRealizingMessage(QObject *realizingMessage);

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 [Relationship]
    void relatedElementsChanged(QSet<QObject *> relatedElements);

    // Signals for owned attributes [DirectedRelationship]
    void sourcesChanged(QSet<QObject *> sources);
    void targetsChanged(QSet<QObject *> targets);

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

    // 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);

    // Signals for owned attributes [PackageableElement]
    void visibilityChanged(QtUml::VisibilityKind visibility);

    // Signals for owned attributes [InformationFlow]
    void conveyedChanged(QSet<QObject *> conveyed);
    void informationSourcesChanged(QSet<QObject *> informationSources);
    void informationTargetsChanged(QSet<QObject *> informationTargets);
    void realizationsChanged(QSet<QObject *> realizations);
    void realizingActivityEdgesChanged(QSet<QObject *> realizingActivityEdges);
    void realizingConnectorsChanged(QSet<QObject *> realizingConnectors);
    void realizingMessagesChanged(QSet<QObject *> realizingMessages);

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

QT_END_NAMESPACE

#endif // QUMLINFORMATIONFLOWOBJECT_H