CodeParameter Class Reference

class CodeParameter A parameter on some type of code. More...

#include <codeparameter.h>

Inheritance diagram for CodeParameter:


Public Slots
void	syncToParent ()
	create the string representation of this code parameter.
Public Member Functions
	CodeParameter (ClassifierCodeDocument doc, UMLObject parentObj)
	Empty Constructor.
virtual	~CodeParameter ()
	Empty Destructor.
ClassifierCodeDocument *	getParentDocument ()
	Get the parent Code Document.
UMLObject *	getParentObject ()
	Get the parent UMLObject.
bool	getAbstract ()
	Utility method.
bool	getStatic ()
	Utility method.
QString	getName () const
	The name of this code parameter.
virtual QString	getTypeName ()
	Get the value of m_typeName the typeName of this parameters (e.g.
Uml::Visibility	getVisibility () const
	Get the value of m_visibility The visibility of this code parameter.
virtual void	setInitialValue (const QString &new_var)
	Set the value of m_initialValue The initial value of this code parameter.
virtual QString	getInitialValue ()
	Get the value of m_initialValue The initial value of this code parameter.
void	setComment (CodeComment *comment)
	Set a Comment.
CodeComment *	getComment ()
	get any Comment object on this
QString	getID ()
Protected Member Functions
virtual void	updateContent ()=0
virtual void	setAttributesOnNode (QDomDocument &doc, QDomElement &blockElement)
	set attributes of the node that represents this class in the XMI document.
virtual void	setAttributesFromNode (QDomElement &element)
	set the class attributes of this object from the passed element node.

Detailed Description

class CodeParameter A parameter on some type of code.

Definition at line 34 of file codeparameter.h.

Constructor & Destructor Documentation

CodeParameter::CodeParameter ( ClassifierCodeDocument * doc,

UMLObject * parentObj

)

Empty Constructor.

Definition at line 36 of file codeparameter.cpp.

CodeParameter::~CodeParameter ( ) [virtual]

Empty Destructor.

Definition at line 42 of file codeparameter.cpp.

Member Function Documentation

ClassifierCodeDocument * CodeParameter::getParentDocument ( )

Get the parent Code Document.

Definition at line 131 of file codeparameter.cpp.
Referenced by CodeClassField::cleanName(), CodeClassField::finishInitialization(), CodeClassField::removeMethod(), and CodeClassField::~CodeClassField().

UMLObject * CodeParameter::getParentObject ( )

Get the parent UMLObject.

Definition at line 138 of file codeparameter.cpp.
Referenced by CodeClassField::fieldIsSingleValue(), ClassifierCodeDocument::findCodeClassFieldFromParentID(), CodeClassField::finishInitialization(), CodeClassFieldDeclarationBlock::getParentObject(), CodeClassField::getTypeName(), ClassifierCodeDocument::hasObjectVectorClassFields(), ClassifierCodeDocument::loadClassFieldsFromXMI(), CodeClassField::maximumListOccurances(), CodeClassField::minimumListOccurances(), ClassifierCodeDocument::removeCodeClassField(), and syncToParent().

bool CodeParameter::getAbstract ( )

Utility method.
Get the value of parent abstract value.
Returns:
the value

Definition at line 56 of file codeparameter.cpp.
References UMLObject::getAbstract().

bool CodeParameter::getStatic ( )

Utility method.
Get the value of parent Static Whether or not this is static.
Returns:
the value

Definition at line 65 of file codeparameter.cpp.
References UMLObject::getStatic().
Referenced by ClassifierCodeDocument::getSpecificClassFields().

QString CodeParameter::getName ( ) const

The name of this code parameter.

Returns:
the value of parameter name

Definition at line 74 of file codeparameter.cpp.
References UMLObject::getName().

QString CodeParameter::getTypeName ( ) [virtual]

Get the value of m_typeName the typeName of this parameters (e.g.
boolean, int, etc or perhaps Class name of an object)
Returns:
the value of m_typeName

Reimplemented in CodeClassField.
Definition at line 84 of file codeparameter.cpp.
References UMLClassifierListItem::getTypeName().

Uml::Visibility CodeParameter::getVisibility ( ) const

Get the value of m_visibility The visibility of this code parameter.

Returns:
the value of m_visibility

Definition at line 94 of file codeparameter.cpp.
References UMLObject::getVisibility().
Referenced by ClassifierCodeDocument::getSpecificClassFields().

void CodeParameter::setInitialValue ( const QString & new_var ) [virtual]

Set the value of m_initialValue The initial value of this code parameter.

Parameters:

new_var the new value of m_initialValue

Definition at line 103 of file codeparameter.cpp.
Referenced by setAttributesFromNode().

QString CodeParameter::getInitialValue ( ) [virtual]

Get the value of m_initialValue The initial value of this code parameter.

Returns:
the value of m_initialValue

Definition at line 112 of file codeparameter.cpp.
Referenced by setAttributesOnNode().

void CodeParameter::setComment ( CodeComment * object )

Set a Comment.

Definition at line 119 of file codeparameter.cpp.

CodeComment * CodeParameter::getComment ( )

get any Comment object on this

Definition at line 126 of file codeparameter.cpp.
Referenced by setAttributesFromNode(), setAttributesOnNode(), and syncToParent().

void CodeParameter::setAttributesOnNode ( QDomDocument & doc,

QDomElement & blockElement

) [protected, virtual]

set attributes of the node that represents this class in the XMI document.

Definition at line 160 of file codeparameter.cpp.
References getComment(), getInitialValue(), UMLRole::getRole(), and CodeComment::saveToXMI().
Referenced by CodeClassField::saveToXMI().

void CodeParameter::setAttributesFromNode ( QDomElement & root ) [protected, virtual]

set the class attributes of this object from the passed element node.

Definition at line 188 of file codeparameter.cpp.
References UMLDoc::findObjectById(), getComment(), UMLApp::getDocument(), UMLAssociation::getUMLRole(), CodeComment::loadFromXMI(), and setInitialValue().
Referenced by CodeClassField::loadFromXMI().

void CodeParameter::syncToParent ( ) [slot]

create the string representation of this code parameter.

Returns:
QString

Definition at line 267 of file codeparameter.cpp.
References getComment(), getParentObject(), and TextBlock::setText().

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

umbrello API Documentation

CodeParameter Class Reference

Public Slots

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation