UMLEnum Class Reference

#include <enum.h>

Inheritance diagram for UMLEnum:

Signals
void	enumLiteralAdded (UMLClassifierListItem *)
void	enumLiteralRemoved (UMLClassifierListItem *)
Signals inherited from UMLClassifier
void	attributeAdded (UMLClassifierListItem *)
void	attributeRemoved (UMLClassifierListItem *)
void	operationAdded (UMLClassifierListItem *)
void	operationRemoved (UMLClassifierListItem *)
void	templateAdded (UMLClassifierListItem *)
void	templateRemoved (UMLClassifierListItem *)
Signals inherited from UMLCanvasObject
void	sigAssociationEndAdded (UMLAssociation *assoc)
void	sigAssociationEndRemoved (UMLAssociation *assoc)
Signals inherited from UMLObject
void	modified ()

Public Member Functions
	UMLEnum (const QString &name=QString(), Uml::ID::Type id=Uml::ID::None)
virtual	~UMLEnum ()
UMLObject *	addEnumLiteral (const QString &name, Uml::ID::Type id=Uml::ID::None)
bool	addEnumLiteral (UMLEnumLiteral *literal, IDChangeLog *Log=0)
bool	addEnumLiteral (UMLEnumLiteral *literal, int position)
virtual UMLObject *	clone () const
virtual void	copyInto (UMLObject *lhs) const
UMLObject *	createEnumLiteral (const QString &name=QString())
int	enumLiterals ()
virtual UMLClassifierListItem *	makeChildObject (const QString &xmiTag)
bool	operator== (const UMLEnum &rhs) const
int	removeEnumLiteral (UMLEnumLiteral *literal)
virtual void	saveToXMI (QDomDocument &qDoc, QDomElement &qElement)
void	signalEnumLiteralRemoved (UMLClassifierListItem *elit)
Public Member Functions inherited from UMLClassifier
	UMLClassifier (const QString &name=QString(), Uml::ID::Type id=Uml::ID::None)
virtual	~UMLClassifier ()
virtual bool	acceptAssociationType (Uml::AssociationType::Enum type)
UMLAttribute *	addAttribute (const QString &name, Uml::ID::Type id=Uml::ID::None)
UMLAttribute *	addAttribute (const QString &name, UMLObject *type, Uml::Visibility::Enum scope)
bool	addAttribute (UMLAttribute *att, IDChangeLog *log=0, int position=-1)
bool	addOperation (UMLOperation *op, int position=-1)
bool	addOperation (UMLOperation *op, IDChangeLog *log)
UMLTemplate *	addTemplate (const QString &name, Uml::ID::Type id=Uml::ID::None)
bool	addTemplate (UMLTemplate *newTemplate, IDChangeLog *log=0)
bool	addTemplate (UMLTemplate *templt, int position)
int	attributes ()
UMLOperation *	checkOperationSignature (const QString &name, UMLAttributeList opParams, UMLOperation *exemptOp=NULL)
virtual UMLAttribute *	createAttribute (const QString &name=QString(), UMLObject *type=0, Uml::Visibility::Enum vis=Uml::Visibility::Private, const QString &init=QString())
UMLOperation *	createOperation (const QString &name=QString(), bool *isExistingOp=NULL, Model_Utils::NameAndType_List *params=NULL)
UMLObject *	createTemplate (const QString &name=QString())
virtual UMLObject *	findChildObjectById (Uml::ID::Type id, bool considerAncestors=false)
UMLOperation *	findOperation (const QString &name, Model_Utils::NameAndType_List params)
UMLOperationList	findOperations (const QString &n)
UMLClassifierList	findSubClassConcepts (ClassifierType type=ALL)
UMLClassifierList	findSuperClassConcepts (ClassifierType type=ALL)
UMLTemplate *	findTemplate (const QString &name)
UMLAttributeList	getAttributeList () const
UMLAttributeList	getAttributeList (Uml::Visibility::Enum scope) const
UMLAttributeList	getAttributeListStatic (Uml::Visibility::Enum scope) const
UMLAssociation *	getClassAssoc () const
virtual UMLClassifierListItemList	getFilteredList (UMLObject::ObjectType ot) const
UMLOperationList	getOpList (bool includeInherited=false, UMLClassifierSet *alreadyTraversed=0)
UMLTemplateList	getTemplateList () const
virtual UMLAssociationList	getUniAssociationToBeImplemented ()
bool	hasAbstractOps ()
bool	hasAccessorMethods ()
bool	hasAssociations ()
bool	hasAttributes ()
bool	hasMethods ()
bool	hasOperationMethods ()
bool	hasStaticAttributes ()
bool	hasVectorFields ()
bool	isDatatype () const
bool	isInterface () const
bool	isReference () const
int	operations ()
bool	operator== (const UMLClassifier &rhs) const
UMLClassifier *	originType () const
int	removeAttribute (UMLAttribute *att)
int	removeOperation (UMLOperation *op)
int	removeTemplate (UMLTemplate *umltemplate)
virtual bool	resolveRef ()
void	setBaseType (UMLObject::ObjectType ot)
void	setClassAssoc (UMLAssociation *assoc)
void	setIsReference (bool isRef=true)
void	setOriginType (UMLClassifier *origType)
int	takeItem (UMLClassifierListItem *item)
int	templates ()
Public Member Functions inherited from UMLPackage
	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)
UMLObjectList	containedObjects ()
UMLObject *	findObject (const QString &name)
UMLObject *	findObjectById (Uml::ID::Type id)
virtual void	removeAllObjects ()
void	removeAssocFromConcepts (UMLAssociation *assoc)
void	removeObject (UMLObject *pObject)
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)
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 ()
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)
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
bool	load (QDomElement &element)
Protected Member Functions inherited from UMLObject
void	init ()
void	maybeSignalObjectCreated ()

Additional Inherited Members
Public Types inherited from UMLClassifier
enum	ClassifierType { ALL = 0, CLASS, INTERFACE, DATATYPE }
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 ()
Static Public Member Functions inherited from UMLObject
static QString	toString (ObjectType ot)
Protected Attributes inherited from UMLPackage
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

Detailed Description

This class contains the non-graphical information required for a UML Enum.

This class inherits from UMLClassifier which contains most of the information.

Non-graphical Information for an Enum.

Author

Jonathan Riddell Bugs and comments to umbre.nosp@m.llo-.nosp@m.devel.nosp@m.@kde.nosp@m..org or http://bugs.kde.org

Definition at line 28 of file enum.h.

Constructor & Destructor Documentation

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

explicit

Sets up an enum.

Parameters

name	The name of the Enum.
id	The unique id of the Enum.

Definition at line 31 of file enum.cpp.

UMLEnum::~UMLEnum ( )

virtual

Standard destructor.

Definition at line 39 of file enum.cpp.

Member Function Documentation

UMLObject * UMLEnum::addEnumLiteral	(	const QString &	name,
		Uml::ID::Type	id = Uml::ID::None
	)

Adds an enumliteral to the enum.

Parameters

name	The name of the enumliteral.
id	The id of the enumliteral (optional.) If omitted a new ID is assigned internally.

Returns

Pointer to the UMLEnumliteral created.

Definition at line 132 of file enum.cpp.

bool UMLEnum::addEnumLiteral	(	UMLEnumLiteral *	literal,
		IDChangeLog *	Log = 0
	)

Adds an already created enumliteral.

The enumliteral object must not belong to any other concept.

Parameters

literal	Pointer to the UMLEnumLiteral.
Log	Pointer to the IDChangeLog.

Returns

True if the enumliteral was successfully added.

Definition at line 154 of file enum.cpp.

bool UMLEnum::addEnumLiteral	(	UMLEnumLiteral *	literal,
		int	position
	)

Adds an enumliteral to the enum, at the given position.

If position is negative or too large, the enumliteral is added to the end of the list. TODO: give default value -1 to position (append) - now it conflicts with the method above..

Parameters

literal	Pointer to the UMLEnumLiteral.
position	Position index for the insertion.

Returns

True if the enumliteral was successfully added.

Definition at line 180 of file enum.cpp.

UMLObject * UMLEnum::clone ( ) const

virtual

Make a clone of this object.

Reimplemented from UMLClassifier.

Definition at line 64 of file enum.cpp.

void UMLEnum::copyInto ( UMLObject *  lhs ) const

virtual

Copy the internal presentation of this object into the new object.

Reimplemented from UMLClassifier.

Definition at line 56 of file enum.cpp.

UMLObject * UMLEnum::createEnumLiteral

(

const QString &

name = QString()

)

Creates a literal for the enum.

Returns

The UMLEnum created

Definition at line 85 of file enum.cpp.

void UMLEnum::enumLiteralAdded ( UMLClassifierListItem *  )

signal

void UMLEnum::enumLiteralRemoved ( UMLClassifierListItem *  )

signal

int UMLEnum::enumLiterals

(

)

Returns the number of enumliterals for the class.

Returns

The number of enumliterals for the class.

Definition at line 223 of file enum.cpp.

bool UMLEnum::load ( QDomElement &  element )

protectedvirtual

Loads the <UML:Enum> element including its enumliterals.

Reimplemented from UMLClassifier.

Definition at line 253 of file enum.cpp.

UMLClassifierListItem * UMLEnum::makeChildObject ( const QString &  xmiTag )

virtual

Create a new ClassifierListObject (enumLiteral) according to the given XMI tag.

Returns NULL if the string given does not contain one of the tags <UML:EnumLiteral> Used by the clipboard for paste operation. Reimplemented from UMLClassifier for UMLEnum

Reimplemented from UMLClassifier.

Definition at line 288 of file enum.cpp.

bool UMLEnum::operator==

(

const UMLEnum &

rhs

)

const

Overloaded '==' operator.

Definition at line 47 of file enum.cpp.

int UMLEnum::removeEnumLiteral

(

UMLEnumLiteral *

literal

)

Removes an enumliteral from the class.

Parameters

literal

The enumliteral to remove.

Returns

Count of the remaining enumliterals after removal. Returns -1 if the given enumliteral was not found.

Definition at line 204 of file enum.cpp.

void UMLEnum::saveToXMI ( QDomDocument &  qDoc, QDomElement &  qElement  )

virtual

Creates the <UML:Enum> element including its enumliterals.

Reimplemented from UMLClassifier.

Definition at line 239 of file enum.cpp.

void UMLEnum::signalEnumLiteralRemoved

(

UMLClassifierListItem *

elit

)

Emit the enumLiteralRemoved signal.

Definition at line 231 of file enum.cpp.

---

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

• enum.h
• enum.cpp