umlassociation.h

Go to the documentation of this file.

/*
    SPDX-License-Identifier: GPL-2.0-or-later
    SPDX-FileCopyrightText: 2003-2022 Umbrello UML Modeller Authors <umbrello-devel@kde.org>
*/
 
#ifndef ASSOCIATION_H
#define ASSOCIATION_H
 
#include "basictypes.h"
#include "umlobject.h"
 
#include <QDomDocument>
#include <QDomElement>
#include <QXmlStreamWriter>
 
class UMLRole;
 
class UMLAssociation : public UMLObject
{
    Q_OBJECT
    friend class AssociationWidget;
 
public:
    UMLAssociation(Uml::AssociationType::Enum type, UMLObject *roleA, UMLObject *roleB);
    explicit UMLAssociation(Uml::AssociationType::Enum type = Uml::AssociationType::Unknown);
 
    virtual ~UMLAssociation();
 
    bool operator==(const UMLAssociation &rhs) const;
 
    QString toString() const;
 
    UMLRole * getUMLRole(Uml::RoleType::Enum role) const;
    Uml::ID::Type getObjectId(Uml::RoleType::Enum role) const;
    Uml::ID::Type getRoleId(Uml::RoleType::Enum role) const;
 
    void setAssociationType(Uml::AssociationType::Enum assocType);
    Uml::AssociationType::Enum getAssocType() const;
 
    void setObject(UMLObject *obj, Uml::RoleType::Enum role);
    UMLObject* getObject(Uml::RoleType::Enum role) const;
 
    void setVisibility(Uml::Visibility::Enum value, Uml::RoleType::Enum role);
    Uml::Visibility::Enum visibility(Uml::RoleType::Enum role) const;
 
    void setChangeability(Uml::Changeability::Enum value, Uml::RoleType::Enum role);
    Uml::Changeability::Enum changeability(Uml::RoleType::Enum role) const;
 
    void setMultiplicity(const QString &multi, Uml::RoleType::Enum role);
    QString getMultiplicity(Uml::RoleType::Enum role) const;
 
    void setRoleName(const QString &roleName, Uml::RoleType::Enum role);
    QString getRoleName(Uml::RoleType::Enum role) const;
 
    void setRoleDoc(const QString &doc, Uml::RoleType::Enum role);
    QString getRoleDoc(Uml::RoleType::Enum role) const;
 
    void setOldLoadMode(bool value = true);
    bool getOldLoadMode() const;
 
    virtual UMLObject* clone() const { return nullptr; }
 
    virtual bool resolveRef();
 
    void saveToXMI(QXmlStreamWriter& writer);
 
    virtual bool showPropertiesDialog(QWidget *parent = nullptr);
 
protected:
 
    bool load1(QDomElement& element);
 
    // keep track of number of parent widgets
    // @todo The UMLAssocation should continue to exist when no AssociationWidget exists.
    //       We do not yet have the means to delete the UMLAssocation because it is not
    //       represented in the list view. For the time being it is deleted when the last
    //       AssociationWidget representing it is deleted.
    int nrof_parent_widgets;
 
    void init(Uml::AssociationType::Enum type, UMLObject *roleAObj, UMLObject *roleBObj);
 
    UMLRole *                    m_pRole[2];
    Uml::AssociationType::Enum   m_AssocType;
    QString                      m_Name;
    bool                         m_bOldLoadMode;
 
private:
 
    bool isRealization(UMLObject* objA, UMLObject* objB) const;
};
 
#endif