umbrello/umbrello
#include <package.h>
Public Member Functions | |
UMLPackage (const QString &name=QString(), Uml::ID::Type id=Uml::ID::None) | |
virtual | ~UMLPackage () |
void | addAssocToConcepts (UMLAssociation *assoc) |
bool | addObject (UMLObject *pObject) |
void | appendClasses (UMLClassifierList &classes, bool includeNested=true) |
void | appendClassesAndInterfaces (UMLClassifierList &classifiers, bool includeNested=true) |
void | appendClassifiers (UMLClassifierList &classifiers, bool includeNested=true) |
void | appendEntities (UMLEntityList &entities, bool includeNested=true) |
void | appendInterfaces (UMLClassifierList &interfaces, bool includeNested=true) |
void | appendPackages (UMLPackageList &packages, bool includeNested=true) |
virtual UMLObject * | clone () const |
UMLObjectList | containedObjects () |
virtual void | copyInto (UMLObject *lhs) const |
UMLObject * | findObject (const QString &name) |
UMLObject * | findObjectById (Uml::ID::Type id) |
virtual void | removeAllObjects () |
void | removeAssocFromConcepts (UMLAssociation *assoc) |
void | removeObject (UMLObject *pObject) |
virtual bool | resolveRef () |
virtual void | saveToXMI (QDomDocument &qDoc, QDomElement &qElement) |
Public Member Functions inherited from UMLCanvasObject | |
UMLCanvasObject (const QString &name=QString(), Uml::ID::Type id=Uml::ID::None) | |
virtual | ~UMLCanvasObject () |
bool | addAssociationEnd (UMLAssociation *assoc) |
int | associations () |
virtual UMLObject * | findChildObject (const QString &n, UMLObject::ObjectType t=UMLObject::ot_UMLObject) |
virtual UMLObject * | findChildObjectById (Uml::ID::Type id, bool considerAncestors=false) |
UMLAssociationList | getAggregations () |
UMLAssociationList | getAssociations () |
UMLAssociationList | getCompositions () |
virtual UMLAssociationList | getRealizations () |
UMLAssociationList | getRelationships () |
UMLAssociationList | getSpecificAssocs (Uml::AssociationType::Enum assocType) |
UMLClassifierList | getSubClasses () |
UMLClassifierList | getSuperClasses () |
bool | hasAssociation (UMLAssociation *assoc) |
bool | operator== (const UMLCanvasObject &rhs) const |
void | removeAllAssociationEnds () |
virtual void | removeAllChildObjects () |
int | removeAssociationEnd (UMLAssociation *assoc) |
UMLObjectList | subordinates () const |
virtual QString | uniqChildName (const UMLObject::ObjectType type, const QString &prefix=QString()) |
Public Member Functions inherited from UMLObject | |
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 () |
virtual bool | acceptAssociationType (Uml::AssociationType::Enum) |
ObjectType | baseType () const |
QLatin1String | baseTypeStr () const |
QString | doc () const |
virtual QString | fullyQualifiedName (const QString &separator=QString(), bool includeRoot=false) const |
bool | hasDoc () const |
virtual Uml::ID::Type | id () const |
bool | isAbstract () const |
bool | isStatic () const |
virtual bool | loadFromXMI (QDomElement &element) |
bool | loadStereotype (QDomElement &element) |
QString | name () const |
bool | operator== (const UMLObject &rhs) const |
QString | package (const QString &separator=QString(), bool includeRoot=false) |
UMLPackageList | packages (bool includeRoot=false) const |
QDomElement | save (const QString &tag, QDomDocument &qDoc) |
QString | secondaryFallback () const |
QString | secondaryId () const |
void | setAbstract (bool bAbstract) |
virtual void | setBaseType (ObjectType ot) |
void | setDoc (const QString &d) |
virtual void | setID (Uml::ID::Type NewID) |
void | setInPaste (bool bInPaste=true) |
virtual void | setName (const QString &strName) |
void | setNameCmd (const QString &strName) |
void | setPackage (const QString &_name) |
void | setSecondaryFallback (const QString &id) |
void | setSecondaryId (const QString &id) |
void | setStatic (bool bStatic) |
void | setStereotype (const QString &_name) |
void | setStereotypeCmd (const QString &_name) |
bool | setUMLPackage (UMLPackage *pPkg) |
void | setUMLStereotype (UMLStereotype *stereo) |
void | setVisibility (Uml::Visibility::Enum visibility) |
void | setVisibilityCmd (Uml::Visibility::Enum visibility) |
virtual bool | showPropertiesPagedDialog (int page=0, bool assoc=false) |
QString | stereotype (bool includeAdornments=false) const |
UMLPackage * | umlPackage () |
const UMLStereotype * | umlStereotype () |
Uml::Visibility::Enum | visibility () const |
Protected Member Functions | |
virtual bool | load (QDomElement &element) |
Protected Member Functions inherited from UMLObject | |
void | init () |
void | maybeSignalObjectCreated () |
Protected Attributes | |
UMLObjectList | m_objects |
Protected Attributes inherited from UMLCanvasObject | |
UMLObjectList | m_List |
Protected Attributes inherited from UMLObject | |
bool | m_bAbstract |
ObjectType | m_BaseType |
bool | m_bCreationWasSignalled |
bool | m_bInPaste |
bool | m_bStatic |
QString | m_Doc |
QString | m_name |
Uml::ID::Type | m_nId |
UMLObject * | m_pSecondary |
UMLStereotype * | m_pStereotype |
UMLPackage * | m_pUMLPackage |
QString | m_SecondaryFallback |
QString | m_SecondaryId |
Uml::Visibility::Enum | m_visibility |
Additional Inherited Members | |
Public Types inherited from UMLObject | |
enum | ObjectType { ot_UMLObject = 100, ot_Actor, ot_UseCase, ot_Package, ot_Interface, ot_Datatype, ot_Enum, ot_Class, 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 } |
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) |
Detailed Description
This class contains the non-graphical information required for a UML Package.
This class inherits from UMLCanvasObject which contains most of the information.
Non-graphical information for a Package.
- See also
- UMLCanvasObject Bugs and comments to umbre or llo- devel @kde .orghttp://bugs.kde.org
Constructor & Destructor Documentation
|
explicit |
Sets up a Package.
- Parameters
-
name The name of the Concept. id The unique id of the Concept.
Definition at line 36 of file package.cpp.
|
virtual |
Destructor.
Definition at line 45 of file package.cpp.
Member Function Documentation
void UMLPackage::addAssocToConcepts | ( | UMLAssociation * | assoc | ) |
Adds an existing association to the matching concept in the list of concepts.
The selection of the matching concept depends on the association type: For generalizations, the assoc is added to the concept that matches role A. For aggregations and compositions, the assoc is added to the concept that matches role B.
- Parameters
-
assoc the association to add
Definition at line 80 of file package.cpp.
bool UMLPackage::addObject | ( | UMLObject * | pObject | ) |
Adds an object in this package.
- Parameters
-
pObject Pointer to the UMLObject to add.
- Returns
- True if the object was actually added.
Definition at line 130 of file package.cpp.
void UMLPackage::appendClasses | ( | UMLClassifierList & | classes, |
bool | includeNested = true |
||
) |
Append all classes from this package (and those from nested packages) to the given UMLClassifierList.
- Parameters
-
classes The list to append to. includeNested Whether to include the classes from nested packages (default: true.)
Definition at line 322 of file package.cpp.
void UMLPackage::appendClassesAndInterfaces | ( | UMLClassifierList & | classifiers, |
bool | includeNested = true |
||
) |
Append all classes and interfaces from this package (and those from nested packages) to the given UMLClassifierList.
- Parameters
-
classifiers The list to append to. includeNested Whether to include the classifiers from nested packages (default: true.)
Definition at line 370 of file package.cpp.
void UMLPackage::appendClassifiers | ( | UMLClassifierList & | classifiers, |
bool | includeNested = true |
||
) |
Append all classifiers from this package (and those from nested packages) to the given UMLClassifierList.
- Parameters
-
classifiers The list to append to. includeNested Whether to include the classifiers from nested packages (default: true.)
Definition at line 298 of file package.cpp.
void UMLPackage::appendEntities | ( | UMLEntityList & | entities, |
bool | includeNested = true |
||
) |
Append all entities from this package (and those from nested packages) to the given UMLEntityList.
- Parameters
-
entities The list to append to. includeNested Whether to include the entities from nested packages (default: true.)
Definition at line 346 of file package.cpp.
void UMLPackage::appendInterfaces | ( | UMLClassifierList & | interfaces, |
bool | includeNested = true |
||
) |
Append all interfaces from this package (and those from nested packages) to the given UMLClassifierList.
- Parameters
-
interfaces The list to append to. includeNested Whether to include the interfaces from nested packages (default: true.)
Definition at line 394 of file package.cpp.
void UMLPackage::appendPackages | ( | UMLPackageList & | packages, |
bool | includeNested = true |
||
) |
Append all packages from this packaed (and those from nested packeges) to the given UMLPackageList.
- Parameters
-
packages The list to append to includeNested Whether to include the packages from nested packages (default:true)
Definition at line 275 of file package.cpp.
|
virtual |
Make a clone of this object.
Implements UMLObject.
Reimplemented in UMLClassifier, UMLArtifact, UMLEntity, UMLFolder, UMLEnum, and UMLComponent.
Definition at line 64 of file package.cpp.
UMLObjectList UMLPackage::containedObjects | ( | ) |
Returns the list of objects contained in this package.
Definition at line 230 of file package.cpp.
|
virtual |
Copy the internal presentation of this object into the new object.
Reimplemented from UMLCanvasObject.
Reimplemented in UMLClassifier, UMLEntity, and UMLEnum.
Definition at line 52 of file package.cpp.
UMLObject * UMLPackage::findObject | ( | const QString & | name | ) |
Find the object of the given name in the list of contained objects.
- Parameters
-
name The name to seek.
- Returns
- Pointer to the UMLObject found or NULL if not found.
Definition at line 241 of file package.cpp.
UMLObject * UMLPackage::findObjectById | ( | Uml::ID::Type | id | ) |
Find the object of the given ID in the list of contained objects.
- Parameters
-
id The ID to seek.
- Returns
- Pointer to the UMLObject found or NULL if not found.
Definition at line 262 of file package.cpp.
|
protectedvirtual |
Loads the <UML:Package> XMI element.
Auxiliary to UMLObject::loadFromXMI.
Reimplemented from UMLObject.
Reimplemented in UMLClassifier, UMLEntity, UMLFolder, UMLEnum, UMLArtifact, and UMLComponent.
Definition at line 460 of file package.cpp.
|
virtual |
Removes all objects from this package.
Inner containers (e.g. nested packages) are removed recursively.
Definition at line 211 of file package.cpp.
void UMLPackage::removeAssocFromConcepts | ( | UMLAssociation * | assoc | ) |
Remove the association from the participating concepts.
- Parameters
-
assoc the association to remove
Definition at line 108 of file package.cpp.
void UMLPackage::removeObject | ( | UMLObject * | pObject | ) |
Removes an object from this package.
Does not physically delete the object.
- Parameters
-
pObject Pointer to the UMLObject to be removed.
Definition at line 193 of file package.cpp.
|
virtual |
Resolve types.
Required when dealing with foreign XMI files. Needs to be called after all UML objects are loaded from file. Overrides the method from UMLObject. Calls resolveRef() on each contained object.
- Returns
- True for overall success.
Reimplemented from UMLCanvasObject.
Reimplemented in UMLClassifier, and UMLEntity.
Definition at line 418 of file package.cpp.
|
virtual |
Creates the <UML:Package> XMI element.
Implements UMLObject.
Reimplemented in UMLClassifier, UMLEntity, UMLFolder, UMLEnum, UMLArtifact, and UMLComponent.
Definition at line 436 of file package.cpp.
Member Data Documentation
|
protected |
References to the objects contained in this package.
The UMLPackage is the owner of the objects.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 23:06:03 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.