umbrello  2.31.80
Umbrello UML Modeller is a Unified Modelling Language (UML) diagram program based on KDE Technology
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
UMLRole Class Reference

#include <umlrole.h>

Inheritance diagram for UMLRole:
UMLObject

Public Member Functions

 UMLRole (UMLAssociation *parent, UMLObject *parentUMLObject, Uml::RoleType::Enum role)
 
virtual ~UMLRole ()
 
bool operator== (const UMLRole &rhs) const
 
QString toString () const
 
void setObject (UMLObject *obj)
 
UMLObjectobject () const
 
void setChangeability (Uml::Changeability::Enum value)
 
Uml::Changeability::Enum changeability () const
 
void setMultiplicity (const QString &multi)
 
QString multiplicity () const
 
UMLAssociationparentAssociation () const
 
Uml::RoleType::Enum role () const
 
UMLObjectclone () const
 
void saveToXMI1 (QDomDocument &qDoc, QDomElement &qElement)
 
virtual bool showPropertiesDialog (QWidget *parent=0)
 
- Public Member Functions inherited from UMLObject
 UMLObject (const UMLObject &other)
 
 UMLObject (UMLObject *parent, const QString &name, Uml::ID::Type id=Uml::ID::None)
 
 UMLObject (UMLObject *parent)
 
 UMLObject (const QString &name=QString(), Uml::ID::Type id=Uml::ID::None)
 
virtual ~UMLObject ()
 
bool operator== (const UMLObject &rhs) const
 
virtual void copyInto (UMLObject *lhs) const
 
virtual void setBaseType (ObjectType ot)
 
ObjectType baseType () const
 
QLatin1String baseTypeStr () const
 
virtual void setID (Uml::ID::Type NewID)
 
virtual Uml::ID::Type id () const
 
QString doc () const
 
bool hasDoc () const
 
void setDoc (const QString &d)
 
void setVisibility (Uml::Visibility::Enum visibility)
 
void setVisibilityCmd (Uml::Visibility::Enum visibility)
 
Uml::Visibility::Enum visibility () const
 
void setStereotype (const QString &_name)
 
void setStereotypeCmd (const QString &_name)
 
QString stereotype (bool includeAdornments=false) const
 
void setUMLStereotype (UMLStereotype *stereo)
 
UMLStereotypeumlStereotype ()
 
QString package (const QString &separator=QString(), bool includeRoot=false)
 
UMLPackageList packages (bool includeRoot=false) const
 
bool setUMLPackage (UMLPackage *pPkg)
 
UMLPackageumlPackage () const
 
void setUMLParent (UMLObject *parent)
 
UMLObjectumlParent () const
 
virtual void setName (const QString &strName)
 
virtual void setNameCmd (const QString &strName)
 
QString name () const
 
virtual QString fullyQualifiedName (const QString &separator=QString(), bool includeRoot=false) const
 
void setAbstract (bool bAbstract)
 
bool isAbstract () const
 
virtual bool resolveRef ()
 
virtual bool loadFromXMI1 (QDomElement &element)
 
bool loadStereotype (QDomElement &element)
 
void setStatic (bool bStatic)
 
bool isStatic () const
 
virtual bool acceptAssociationType (Uml::AssociationType::Enum)
 
void setSecondaryId (const QString &id)
 
QString secondaryId () const
 
void setSecondaryFallback (const QString &id)
 
QString secondaryFallback () const
 
QDomElement save1 (const QString &tag, QDomDocument &qDoc)
 
bool isUMLActor ()
 
bool isUMLArtifact ()
 
bool isUMLAssociation ()
 
bool isUMLAttribute ()
 
bool isUMLCategory ()
 
bool isUMLCheckConstraint ()
 
bool isUMLClassifier ()
 
bool isUMLComponent ()
 
bool isUMLDatatype ()
 
bool isUMLEntity ()
 
bool isUMLEntityAttribute ()
 
bool isUMLEntityConstraint ()
 
bool isUMLEnum ()
 
bool isUMLEnumLiteral ()
 
bool isUMLFolder ()
 
bool isUMLForeignKeyConstraint ()
 
bool isUMLInstance ()
 
bool isUMLInstanceAttribute ()
 
bool isUMLNode ()
 
bool isUMLObject ()
 
bool isUMLOperation ()
 
bool isUMLPackage ()
 
bool isUMLPort ()
 
bool isUMLRole ()
 
bool isUMLStereotype ()
 
bool isUMLTemplate ()
 
bool isUMLUniqueConstraint ()
 
bool isUMLUseCase ()
 
UMLActorasUMLActor ()
 
UMLArtifactasUMLArtifact ()
 
UMLAssociationasUMLAssociation ()
 
UMLAttributeasUMLAttribute ()
 
UMLCanvasObjectasUMLCanvasObject ()
 
UMLCategoryasUMLCategory ()
 
UMLCheckConstraintasUMLCheckConstraint ()
 
UMLClassifierasUMLClassifier ()
 
UMLClassifierListItemasUMLClassifierListItem ()
 
UMLClassifierSetasUMLClassifierSet ()
 
UMLComponentasUMLComponent ()
 
UMLDatatypeasUMLDatatype ()
 
UMLEntityasUMLEntity ()
 
UMLEntityAttributeasUMLEntityAttribute ()
 
UMLEntityConstraintasUMLEntityConstraint ()
 
UMLEnumasUMLEnum ()
 
UMLEnumLiteralasUMLEnumLiteral ()
 
UMLFolderasUMLFolder ()
 
UMLForeignKeyConstraintasUMLForeignKeyConstraint ()
 
UMLInstanceasUMLInstance ()
 
UMLInstanceAttributeasUMLInstanceAttribute ()
 
UMLNodeasUMLNode ()
 
UMLObjectasUMLObject ()
 
UMLOperationasUMLOperation ()
 
UMLPackageasUMLPackage ()
 
UMLPortasUMLPort ()
 
UMLRoleasUMLRole ()
 
UMLStereotypeasUMLStereotype ()
 
UMLTemplateasUMLTemplate ()
 
UMLUniqueConstraintasUMLUniqueConstraint ()
 
UMLUseCaseasUMLUseCase ()
 

Protected Member Functions

bool load1 (QDomElement &element)
 
- Protected Member Functions inherited from UMLObject
void init ()
 
void maybeSignalObjectCreated ()
 

Private Attributes

UMLAssociationm_pAssoc
 
Uml::RoleType::Enum m_role
 
QString m_Multi
 
Uml::Changeability::Enum m_Changeability
 

Additional Inherited Members

- Public Types inherited from UMLObject
enum  ObjectType {
  ot_Unknown = -1, ot_UMLObject = 100, ot_Actor, ot_UseCase,
  ot_Package, ot_Interface, ot_Datatype, ot_Enum,
  ot_Class, ot_Instance, ot_Association, ot_Attribute,
  ot_Operation, ot_EnumLiteral, ot_Template, ot_Component,
  ot_Artifact, ot_Node, ot_Stereotype, ot_Role,
  ot_Entity, ot_EntityAttribute, ot_Folder, ot_EntityConstraint,
  ot_UniqueConstraint, ot_ForeignKeyConstraint, ot_CheckConstraint, ot_Category,
  ot_Port, ot_InstanceAttribute, ot_SubSystem
}
 
- Public Slots inherited from UMLObject
void emitModified ()
 
- Signals inherited from UMLObject
void modified ()
 
- Static Public Member Functions inherited from UMLObject
static QString toString (ObjectType ot)
 
static QString toI18nString (ObjectType t)
 
static Icon_Utils::IconType toIcon (ObjectType t)
 
- Protected Attributes inherited from UMLObject
Uml::ID::Type m_nId
 object's id More...
 
QString m_Doc
 object's documentation More...
 
QPointer< UMLStereotypem_pStereotype
 stereotype of the object if applicable More...
 
QString m_name
 objects name More...
 
ObjectType m_BaseType
 objects type More...
 
Uml::Visibility::Enum m_visibility
 objects visibility More...
 
bool m_bAbstract
 state of whether the object is abstract or not More...
 
bool m_bStatic
 flag for instance scope More...
 
bool m_bInPaste
 caller sets this true when in paste operation More...
 
bool m_bCreationWasSignalled
 auxiliary to maybeSignalObjectCreated() More...
 
QPointer< UMLObjectm_pSecondary
 
QString m_SecondaryId
 
QString m_SecondaryFallback
 
UMLObjectPrivatem_d
 private data More...
 

Detailed Description

This class contains the non-graphic representation of an association role.

Author
Brian Thomas brian.nosp@m..tho.nosp@m.mas@g.nosp@m.sfc..nosp@m.nasa..nosp@m.gov
See also
UMLObject

Constructor & Destructor Documentation

◆ UMLRole()

UMLRole::UMLRole ( UMLAssociation parent,
UMLObject parentObj,
Uml::RoleType::Enum  role 
)

Sets up an association.

Parameters
parentThe parent (association) of this UMLRole.
parentObjThe Parent UML Object of this UMLRole
roleThe Uml::RoleType::Enum of this UMLRole

◆ ~UMLRole()

UMLRole::~UMLRole ( )
virtual

Standard destructor.

Member Function Documentation

◆ changeability()

Uml::Changeability::Enum UMLRole::changeability ( ) const

Returns the Changeablity of the role.

Returns
Changeability of role.

◆ clone()

UMLObject* UMLRole::clone ( ) const
inlinevirtual

Reimplemented from UMLObject.

◆ load1()

bool UMLRole::load1 ( QDomElement &  element)
protectedvirtual

Loads the <UML:AssociationEnd> XMI element. Auxiliary to UMLObject::loadFromXMI.

Reimplemented from UMLObject.

◆ multiplicity()

QString UMLRole::multiplicity ( ) const

Returns the multiplicity assigned to the role.

Returns
The multiplicity assigned to the role.

◆ object()

UMLObject * UMLRole::object ( ) const

Returns the UMLObject assigned to the role.

Returns
Pointer to the UMLObject in role.

◆ operator==()

bool UMLRole::operator== ( const UMLRole rhs) const

Overloaded '==' operator.

◆ parentAssociation()

UMLAssociation * UMLRole::parentAssociation ( ) const

◆ role()

Uml::RoleType::Enum UMLRole::role ( ) const

Get the 'id' of the role (NOT the parent object). This could be either Uml::RoleType::A or Uml::RoleType::B. Yes, it would be better if we could get along without this, but we need it to distinguish saved umlrole objects in the XMI for 'self' associations where both roles will point to the same underlying UMLObject.

◆ saveToXMI1()

void UMLRole::saveToXMI1 ( QDomDocument &  qDoc,
QDomElement &  qElement 
)
virtual

Creates the <UML:AssociationEnd> XMI element.

Reimplemented from UMLObject.

◆ setChangeability()

void UMLRole::setChangeability ( Uml::Changeability::Enum  value)

Sets the changeability of the role.

Parameters
valueChangeability::Enum of role.

◆ setMultiplicity()

void UMLRole::setMultiplicity ( const QString &  multi)

Sets the multiplicity of the role.

Parameters
multiThe multiplicity of role.

◆ setObject()

void UMLRole::setObject ( UMLObject obj)

Sets the UMLObject playing the role in the association.

Parameters
objPointer to the UMLObject of role.

◆ showPropertiesDialog()

bool UMLRole::showPropertiesDialog ( QWidget *  parent = 0)
virtual

Display the properties configuration dialog for the object.

Parameters
parentThe parent widget.
Returns
True for success of this operation.

Reimplemented from UMLObject.

◆ toString()

QString UMLRole::toString ( ) const

Returns a String representation of this UMLRole instance.

Member Data Documentation

◆ m_Changeability

Uml::Changeability::Enum UMLRole::m_Changeability
private

◆ m_Multi

QString UMLRole::m_Multi
private

◆ m_pAssoc

UMLAssociation* UMLRole::m_pAssoc
private

◆ m_role

Uml::RoleType::Enum UMLRole::m_role
private

The documentation for this class was generated from the following files: