umbrello 25.04.2
Umbrello UML Modeller is a Unified Modelling Language (UML) diagram program based on KDE Technology
UMLInstance Class Reference

Non-graphical Information for an Instance. More...

#include <instance.h>

Inheritance diagram for UMLInstance:
Collaboration diagram for UMLInstance:

Public Slots

void attributeAdded (UMLClassifierListItem *)
void attributeRemoved (UMLClassifierListItem *)
Public Slots inherited from UMLObject
void emitModified ()

Public Member Functions

 UMLInstance (const QString &instanceName=QString(), Uml::ID::Type id=Uml::ID::None, UMLClassifier *classifier=nullptr)
void setClassifier (UMLClassifier *classifier)
void setClassifierCmd (UMLClassifier *classifier, bool emitSignal=true)
UMLClassifierclassifier () const
virtual void saveToXMI (QXmlStreamWriter &writer)
Public Member Functions inherited from UMLCanvasObject
 UMLCanvasObject (const QString &name=QString(), Uml::ID::Type id=Uml::ID::None)
virtual ~UMLCanvasObject ()
bool operator== (const UMLCanvasObject &rhs) const
virtual void copyInto (UMLObject *lhs) const
bool addAssociationEnd (UMLAssociation *assoc)
bool hasAssociation (UMLAssociation *assoc) const
int removeAssociationEnd (UMLAssociation *assoc)
void removeAllAssociationEnds ()
int associations () const
UMLAssociationList getAssociations () const
UMLAssociationList getSpecificAssocs (Uml::AssociationType::Enum assocType) const
UMLClassifierList getSuperClasses (bool withRealizations=true) const
UMLClassifierList getSubClasses () const
virtual UMLAssociationList getRealizations () const
UMLAssociationList getAggregations () const
UMLAssociationList getCompositions () const
UMLAssociationList getRelationships () const
virtual UMLObjectfindChildObject (const QString &n, UMLObject::ObjectType t=UMLObject::ot_UMLObject) const
virtual UMLObjectfindChildObjectById (Uml::ID::Type id, bool considerAncestors=false) const
virtual QString uniqChildName (const UMLObject::ObjectType type, const QString &prefix=QString()) const
virtual void removeAllChildObjects ()
UMLObjectListsubordinates () const
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 UMLObjectclone () 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 () const
QStringList & tags ()
QString package (const QString &separator=QString(), bool includeRoot=false) const
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 loadFromXMI (QDomElement &element)
bool loadStereotype (QDomElement &element)
void setStatic (bool bStatic)
bool isStatic () const
virtual bool acceptAssociationType (Uml::AssociationType::Enum) const
void setSecondaryId (const QString &id)
QString secondaryId () const
void setSecondaryFallback (const QString &id)
QString secondaryFallback () const
void save1 (QXmlStreamWriter &writer, const QString &type, const QString &tag=QString())
bool isUMLActor () const
bool isUMLArtifact () const
bool isUMLAssociation () const
bool isUMLAttribute () const
bool isUMLCategory () const
bool isUMLCheckConstraint () const
bool isUMLClassifier () const
bool isUMLComponent () const
bool isUMLDatatype () const
bool isUMLEntity () const
bool isUMLEntityAttribute () const
bool isUMLEntityConstraint () const
bool isUMLEnum () const
bool isUMLEnumLiteral () const
bool isUMLFolder () const
bool isUMLForeignKeyConstraint () const
bool isUMLInstance () const
bool isUMLInstanceAttribute () const
bool isUMLNode () const
bool isUMLObject () const
bool isUMLOperation () const
bool isUMLPackage () const
bool isUMLPort () const
bool isUMLRole () const
bool isUMLStereotype () const
bool isUMLTemplate () const
bool isUMLUniqueConstraint () const
bool isUMLUseCase () const
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 ()
const UMLActorasUMLActor () const
const UMLArtifactasUMLArtifact () const
const UMLAssociationasUMLAssociation () const
const UMLAttributeasUMLAttribute () const
const UMLCanvasObjectasUMLCanvasObject () const
const UMLCategoryasUMLCategory () const
const UMLCheckConstraintasUMLCheckConstraint () const
const UMLClassifierasUMLClassifier () const
const UMLClassifierListItemasUMLClassifierListItem () const
const UMLClassifierSetasUMLClassifierSet () const
const UMLComponentasUMLComponent () const
const UMLDatatypeasUMLDatatype () const
const UMLEntityasUMLEntity () const
const UMLEntityAttributeasUMLEntityAttribute () const
const UMLEntityConstraintasUMLEntityConstraint () const
const UMLEnumasUMLEnum () const
const UMLEnumLiteralasUMLEnumLiteral () const
const UMLFolderasUMLFolder () const
const UMLForeignKeyConstraintasUMLForeignKeyConstraint () const
const UMLInstanceasUMLInstance () const
const UMLInstanceAttributeasUMLInstanceAttribute () const
const UMLNodeasUMLNode () const
const UMLObjectasUMLObject () const
const UMLOperationasUMLOperation () const
const UMLPackageasUMLPackage () const
const UMLPortasUMLPort () const
const UMLRoleasUMLRole () const
const UMLStereotypeasUMLStereotype () const
const UMLTemplateasUMLTemplate () const
const UMLUniqueConstraintasUMLUniqueConstraint () const
const UMLUseCaseasUMLUseCase () const

Protected Member Functions

bool load1 (QDomElement &element)
virtual bool resolveRef ()
bool showPropertiesDialog (QWidget *parent)
Protected Member Functions inherited from UMLObject
void init ()
void maybeSignalObjectCreated ()
void save1end (QXmlStreamWriter &writer)

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
}
Signals inherited from UMLCanvasObject
void sigAssociationEndAdded (UMLAssociation *assoc)
void sigAssociationEndRemoved (UMLAssociation *assoc)
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
QString m_Doc
 object's documentation
QPointer< UMLStereotypem_pStereotype
 stereotype of the object if applicable
QString m_name
 objects name
ObjectType m_BaseType
 objects type
Uml::Visibility::Enum m_visibility
 objects visibility
bool m_bAbstract
 state of whether the object is abstract or not
bool m_bStatic
 flag for instance scope
bool m_bCreationWasSignalled
 auxiliary to maybeSignalObjectCreated()
QPointer< UMLObjectm_pSecondary
QString m_SecondaryId
QString m_SecondaryFallback
QStringList m_TaggedValues
UMLObjectPrivatem_d
 private data

Detailed Description

Non-graphical Information for an Instance.

This class contains the non-graphical information required for a UML Instance. An Instance may be either standalone not tied to any other object, or it may be the instance of a classifier. If it represents a classifier then it will contain concrete values for the attributes of the classifier (see UMLCanvasObject::m_List). Conversely, in Umbrello a standalone instance cannot have attributes. UMLObject::m_pSecondary is used for storing the reference to the classifier. In case of a standalone instance, m_pSecondary is nullptr. UMLObject::m_name is used for storing the instance name. The notation for an instance is instanceName : classifierName where the entire text is underlined. Both instanceName and classifierName are optional. The notation for a standalone instance not representing a classifier is instanceName : The notation for an anonymous instance of a classifier is : classifierName This class inherits from UMLCanvasObject which contains most of the information.

Author
Lays Rodrigues
Ralf Habacker
Oliver Kellogg Bugs and comments to umbre.nosp@m.llo-.nosp@m.devel.nosp@m.@kde.nosp@m..org or https://bugs.kde.org

Constructor & Destructor Documentation

◆ UMLInstance()

UMLInstance::UMLInstance ( const QString & instanceName = QString(),
Uml::ID::Type id = Uml::ID::None,
UMLClassifier * c = nullptr )
explicit

Construct UMLInstance

Parameters
instanceNameName of the instance
idThe unique id to assign
cThe UMLClassifier that this instance represents, or nullptr in case of an untyped instance. The classifier can also be set after construction by calling setClassifier().
Here is the call graph for this function:

Member Function Documentation

◆ attributeAdded

void UMLInstance::attributeAdded ( UMLClassifierListItem * item)
slot
Here is the call graph for this function:

◆ attributeRemoved

void UMLInstance::attributeRemoved ( UMLClassifierListItem * item)
slot
Here is the call graph for this function:

◆ classifier()

UMLClassifier * UMLInstance::classifier ( ) const

◆ load1()

bool UMLInstance::load1 ( QDomElement & element)
protectedvirtual

Loads the <UML:Instance> element including its instanceAttributes.

Reimplemented from UMLObject.

Here is the call graph for this function:

◆ resolveRef()

bool UMLInstance::resolveRef ( )
protectedvirtual

Resolve forward declaration of referenced classifier held in m_secondaryId after loading object from xmi file.

Returns
true - resolve was successful
false - resolve was not successful

Reimplemented from UMLCanvasObject.

Here is the call graph for this function:

◆ saveToXMI()

void UMLInstance::saveToXMI ( QXmlStreamWriter & writer)
virtual

Creates the <UML:Instance> element including its slots.

Reimplemented from UMLObject.

Here is the call graph for this function:

◆ setClassifier()

void UMLInstance::setClassifier ( UMLClassifier * classifier)

Set undoable classifier

Parameters
classifier
Here is the call graph for this function:

◆ setClassifierCmd()

void UMLInstance::setClassifierCmd ( UMLClassifier * classifier,
bool emitSignal = true )

Set classifier

Parameters
classifierthe classifier which is the type of this instance
emitSignalflag controlling whether to emit a modification signal (default: true)
Here is the call graph for this function:

◆ showPropertiesDialog()

bool UMLInstance::showPropertiesDialog ( QWidget * parent)
protectedvirtual

Display the properties configuration dialog.

Parameters
parentParent widget
Returns
true - configuration has been applied
false - configuration has not been applied

Reimplemented from UMLObject.

Here is the call graph for this function:

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