umbrello  2.35.1
Umbrello UML Modeller is a Unified Modelling Language (UML) diagram program based on KDE Technology
Public Slots | Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
CodeParameter Class Referenceabstract

#include <codeparameter.h>

Inheritance diagram for CodeParameter:
Collaboration diagram for CodeParameter:

Public Slots

void syncToParent ()
 

Public Member Functions

 CodeParameter (ClassifierCodeDocument *doc, UMLObject *parentObj)
 
virtual ~CodeParameter ()
 
ClassifierCodeDocumentgetParentDocument ()
 
UMLObjectgetParentObject ()
 
bool getAbstract ()
 
bool getStatic ()
 
QString getName () const
 
virtual QString getTypeName ()
 
Uml::Visibility::Enum getVisibility () const
 
virtual void setInitialValue (const QString &new_var)
 
virtual QString getInitialValue ()
 
void setComment (CodeComment *comment)
 
CodeCommentgetComment ()
 
QString ID () const
 
virtual void updateContent ()=0
 

Protected Member Functions

virtual void setAttributesOnNode (QXmlStreamWriter &writer)
 
virtual void setAttributesFromNode (QDomElement &element)
 

Private Member Functions

void initFields (ClassifierCodeDocument *doc, UMLObject *obj)
 

Private Attributes

ClassifierCodeDocumentm_parentDocument
 
UMLObjectm_parentObject
 
CodeCommentm_comment
 
QString m_initialValue
 initial value of this code parameter More...
 

Detailed Description

class CodeParameter A parameter on some type of code.

Constructor & Destructor Documentation

CodeParameter::CodeParameter ( ClassifierCodeDocument parentDoc,
UMLObject parentObject 
)

Constructor.

Here is the call graph for this function:

CodeParameter::~CodeParameter ( )
virtual

Destructor.

Member Function Documentation

bool CodeParameter::getAbstract ( )

Utility method to get the value of parent object abstract value

Returns
the value of parent object abstrtact

Here is the call graph for this function:

CodeComment * CodeParameter::getComment ( )

Get the Comment on this object.

QString CodeParameter::getInitialValue ( )
virtual

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

Returns
the value of m_initialValue

Reimplemented in CPPCodeClassField, DCodeClassField, JavaCodeClassField, and RubyCodeClassField.

QString CodeParameter::getName ( ) const

Utility method to get the value of parent object name The name of this code parameter.

Returns
the value

Here is the call graph for this function:

ClassifierCodeDocument * CodeParameter::getParentDocument ( )

Get the parent Code Document

UMLObject * CodeParameter::getParentObject ( )

Get the ParentObject object.

bool CodeParameter::getStatic ( )

Utility method to get the value of parent object static Whether or not this is static.

Returns
the value of static

Here is the call graph for this function:

QString CodeParameter::getTypeName ( )
virtual

Utility method to get the value of parent object type. the typeName of this parameters (e.g. boolean, int, etc or perhaps Class name of an object)

Returns
the value of type

Reimplemented in CodeClassField, DCodeClassField, JavaCodeClassField, and RubyCodeClassField.

Here is the call graph for this function:

Uml::Visibility::Enum CodeParameter::getVisibility ( ) const

Utility method to get the value of parent object scope. The visibility of this code parameter.

Returns
the value of parent object scope

Here is the call graph for this function:

QString CodeParameter::ID ( ) const

Here is the call graph for this function:

void CodeParameter::initFields ( ClassifierCodeDocument doc,
UMLObject obj 
)
private

Here is the call graph for this function:

void CodeParameter::setAttributesFromNode ( QDomElement &  root)
protectedvirtual

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

Reimplemented in CodeClassField.

Here is the call graph for this function:

void CodeParameter::setAttributesOnNode ( QXmlStreamWriter &  writer)
protectedvirtual

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

Reimplemented in CodeClassField.

Here is the call graph for this function:

void CodeParameter::setComment ( CodeComment object)

Set a Comment object.

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

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

Parameters
new_varthe new value of m_initialValue
void CodeParameter::syncToParent ( )
slot

Create the string representation of this code parameter.

Returns
QString

Here is the call graph for this function:

virtual void CodeParameter::updateContent ( )
pure virtual

Implemented in CodeClassField.

Member Data Documentation

CodeComment* CodeParameter::m_comment
private
QString CodeParameter::m_initialValue
private

initial value of this code parameter

ClassifierCodeDocument* CodeParameter::m_parentDocument
private
UMLObject* CodeParameter::m_parentObject
private

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