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

#include <QtUml/QtUmlGlobal>

#include <QtUml/QUmlNamedElement>

QT_BEGIN_NAMESPACE

QT_MODULE(QtUml)

class QUmlConstraint;
class QUmlElementImport;
class QUmlPackageableElement;
class QUmlPackageImport;

class Q_UML_EXPORT QUmlNamespace : public virtual QUmlNamedElement
{
public:
    virtual ~QUmlNamespace();

    Q_DECL_HIDDEN virtual QModelingElement *clone() const;

    // Owned attributes
    const QSet<QUmlElementImport *> elementImports() const;
    void addElementImport(QUmlElementImport *elementImport);
    void removeElementImport(QUmlElementImport *elementImport);
    const QSet<QUmlPackageableElement *> importedMembers() const;
    Q_DECL_HIDDEN void addImportedMember(QUmlPackageableElement *importedMember);
    Q_DECL_HIDDEN void removeImportedMember(QUmlPackageableElement *importedMember);
    const QSet<QUmlNamedElement *> members() const;
    Q_DECL_HIDDEN void addMember(QUmlNamedElement *member);
    Q_DECL_HIDDEN void removeMember(QUmlNamedElement *member);
    const QSet<QUmlNamedElement *> ownedMembers() const;
    Q_DECL_HIDDEN void addOwnedMember(QUmlNamedElement *ownedMember);
    Q_DECL_HIDDEN void removeOwnedMember(QUmlNamedElement *ownedMember);
    const QSet<QUmlConstraint *> ownedRules() const;
    void addOwnedRule(QUmlConstraint *ownedRule);
    void removeOwnedRule(QUmlConstraint *ownedRule);
    const QSet<QUmlPackageImport *> packageImports() const;
    void addPackageImport(QUmlPackageImport *packageImport);
    void removePackageImport(QUmlPackageImport *packageImport);

    // Operations
    QSet<QUmlPackageableElement *> excludeCollisions(QSet<QUmlPackageableElement *> imps) const;
    QSet<QString> getNamesOfMember(QUmlNamedElement *element) const;
    QSet<QUmlPackageableElement *> importMembers(QSet<QUmlPackageableElement *> imps) const;
    bool membersAreDistinguishable() const;

protected:
    explicit QUmlNamespace();

    QSet<QUmlElementImport *> _elementImports;
    QSet<QUmlNamedElement *> _members;
    QSet<QUmlNamedElement *> _ownedMembers;
    QSet<QUmlConstraint *> _ownedRules;
    QSet<QUmlPackageImport *> _packageImports;
};

QT_END_NAMESPACE

Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlNamespace) *)

#endif // QUMLNAMESPACE_H