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

Non-graphical information for a Artifact. More...

#include <artifact.h>

Inheritance diagram for UMLArtifact:
Collaboration diagram for UMLArtifact:

Public Types

enum  Draw_Type { defaultDraw , file , library , table }
 
- 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 Member Functions

 UMLArtifact (const QString &name=QString(), Uml::ID::Type id=Uml::ID::None)
 
virtual ~UMLArtifact ()
 
virtual UMLObjectclone () const
 
void saveToXMI (QXmlStreamWriter &writer)
 
void setDrawAsType (Draw_Type type)
 
Draw_Type getDrawAsType () const
 
QString fullPath () const
 
- Public Member Functions inherited from UMLPackage
 UMLPackage (const QString &name=QString(), Uml::ID::Type id=Uml::ID::None)
 
virtual ~UMLPackage ()
 
virtual void copyInto (UMLObject *lhs) const
 
bool addObject (UMLObject *pObject, bool interactOnConflict=true)
 
virtual void removeObject (UMLObject *pObject)
 
virtual void removeAllObjects ()
 
UMLObjectList containedObjects (bool includeInactive=false) const
 
void addAssocToConcepts (UMLAssociation *assoc)
 
void removeAssocFromConcepts (UMLAssociation *assoc)
 
UMLObjectfindObject (const QString &name) const
 
UMLObjectfindObjectById (Uml::ID::Type id) const
 
void appendPackages (UMLPackageList &packages, bool includeNested=true) const
 
void appendClassifiers (UMLClassifierList &classifiers, bool includeNested=true) const
 
void appendClassesAndInterfaces (UMLClassifierList &classifiers, bool includeNested=true) const
 
void appendEntities (UMLEntityList &entities, bool includeNested=true) const
 
virtual bool resolveRef ()
 
- 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
 
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 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 showPropertiesDialog (QWidget *parent=nullptr)
 
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)
 
- Protected Member Functions inherited from UMLObject
void init ()
 
void maybeSignalObjectCreated ()
 
void save1end (QXmlStreamWriter &writer)
 

Private Attributes

Draw_Type m_drawAsType
 

Additional Inherited Members

- Public Slots inherited from UMLObject
void emitModified ()
 
- 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 UMLPackage
UMLObjectList m_objects
 
- 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 a Artifact.

This class contains the non-graphical information required for a UML Artifact. This class inherits from UMLCanvasObject which contains most of the information.

Author
Jonathan Riddell
See also
UMLCanvasObject Bugs and comments to umbre.nosp@m.llo-.nosp@m.devel.nosp@m.@kde.nosp@m..org or https://bugs.kde.org

Member Enumeration Documentation

◆ Draw_Type

Artifacts can be drawn using one of several icons.

Enumerator
defaultDraw 
file 
library 
table 

Constructor & Destructor Documentation

◆ UMLArtifact()

UMLArtifact::UMLArtifact ( const QString & name = QString(),
Uml::ID::Type id = Uml::ID::None )
explicit

Sets up an Artifact.

Parameters
nameThe name of the Concept.
idThe unique id of the Concept.

◆ ~UMLArtifact()

UMLArtifact::~UMLArtifact ( )
virtual

Standard deconstructor.

Member Function Documentation

◆ clone()

UMLObject * UMLArtifact::clone ( ) const
virtual

Make a clone of this object.

Returns
the cloned object

Reimplemented from UMLPackage.

Here is the call graph for this function:

◆ fullPath()

QString UMLArtifact::fullPath ( ) const

Return full path of this artifact including its parent

Returns
full path
Here is the call graph for this function:

◆ getDrawAsType()

UMLArtifact::Draw_Type UMLArtifact::getDrawAsType ( ) const

Returns the value of m_drawAsType.

Returns
the value of the draw type attribute

◆ load1()

bool UMLArtifact::load1 ( QDomElement & element)
protectedvirtual

Loads the UML:Artifact element including its operations, attributes and templates.

Parameters
elementthe xml element to load
Returns
the success status of the operation

Reimplemented from UMLPackage.

◆ saveToXMI()

void UMLArtifact::saveToXMI ( QXmlStreamWriter & writer)
virtual

Creates the UML:Artifact element including its operations, attributes and templates

Parameters
writerthe QXmlStreamWriter serialization target

Reimplemented from UMLPackage.

Here is the call graph for this function:

◆ setDrawAsType()

void UMLArtifact::setDrawAsType ( Draw_Type type)

Sets m_drawAsType for which method to draw the artifact as.

Parameters
typethe draw type

Member Data Documentation

◆ m_drawAsType

Draw_Type UMLArtifact::m_drawAsType
private

Artifacts can be drawn as one of several different icons, this value choosing how to draw them.


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