Class UmlBaseClass

Declaration :

Directly inherited by : UmlClass

Manage the classes

Artifact : UmlBaseClass

Operation create

Declaration :

returns a new class named 's' created under 'parent'

In case it cannot be created (the name is already used or
invalid, 'parent' cannot contain it etc ...) return 0 in C++
and produce a RuntimeException in Java

Operation kind

Declaration :

returns the kind of the item

Operation isAbstract

Declaration :

returns TRUE in case the class is abstract

Operation set_isAbstract

Declaration :

the set if the class is abstract

On error return FALSE in C++, produce a RuntimeException in Java,
for instance you cannot set it to FALSE in case the class have
abstract operations

Operation baseType

Declaration :

returns the type on which the class (in fact a typedef) is based

Operation set_BaseType

Declaration :

to set the type on which the class (in fact a typedef) is based

On error return FALSE in C++, produce a RuntimeException in Java, does not check that the class is (already) a typedef

Operation formals

Declaration :

returns (a copy of) the formals list

Operation removeFormal

Declaration :

remove the formal of the given rank (0...), returns 0 on error

On error return FALSE in C++, produce a RuntimeException in Java,
does not check that the class is (already) a typedef

Operation addFormal

Declaration :

adds a formal at the given rank (0...), returns 0 on error

On error return FALSE in C++, produce a RuntimeException in Java,
does not check that the class is (already) a typedef

Operation replaceFormal

Declaration :

replace the formal at the given rank (0...)

On error return FALSE in C++, produce a RuntimeException in Java,
does not check that the class is (already) a typedef

Operation actuals

Declaration :

returns (a copy of) the actuals list

Operation replaceActual

Declaration :

replace the actual value at the given rank (0...)

On error return FALSE in C++, produce a RuntimeException in Java

Operation associatedDiagram

Declaration :

returns the optional associated diagram

Operation set_AssociatedDiagram

Declaration :

sets the associated diagram, arg may be null to unset it

On error return FALSE in C++, produce a RuntimeException in Java

Operation associatedArtifact

Declaration :

returns the optional associated artifact,
to set it refer to the UmlBaseArtifact's operations
addAssociatedClass(), removeAssociatedClass() and
setAssociatedClasses()

Operation associatedComponents

Declaration :

returns the components realizing or providing the class.
To set them refer to the UmlBaseComponent's operation setAssociatedClasses()

Operation isCppExternal

Declaration :

returns TRUE if the class is external, its definition
must contains how the name is made on the first line
(isCppExternal by default), the other lines if they exist
must contains the #include and may be using forms

Operation set_isCppExternal

Declaration :

set if the class is external

On error return FALSE in C++, produce a RuntimeException in Java

Operation isJavaExternal

Declaration :

returns TRUE if the class is external, its definition
must contain how the name is made on the first line
(isJavaExternal by default), the other lines are ignored

Operation set_isJavaExternal

Declaration :

set if the class is external

On error return FALSE in C++, produce a RuntimeException in Java

Operation isJavaPublic

Declaration :

returns TRUE is the class is public

Operation set_isJavaPublic

Declaration :

set if the class is public

On error return FALSE in C++, produce a RuntimeException in Java

Operation isJavaFinal

Declaration :

returns TRUE is the class is final

Operation set_isJavaFinal

Declaration :

set if the class is final

On error return FALSE in C++, produce a RuntimeException in Java

Operation switchType

Declaration :

returns the switch's type, significant in case the class
is an union in IDL

Operation set_SwitchType

Declaration :

to set the switch type even the class is not (already) an IDL union

On error return FALSE in C++, produce a RuntimeException in Java

Operation isIdlExternal

Declaration :

returns TRUE if the class is external, its definition
must contain how the name is made on the first line
(isIdlExternal by default), the other lines are ignored

Operation set_isIdlExternal

Declaration :

set if the class is external

On error return FALSE in C++, produce a RuntimeException in Java

Operation isIdlLocal

Declaration :

returns TRUE if the class is local, have sense for an interface

Operation set_isIdlLocal

Declaration :

set if the class is local, have sense for an interface

On error return FALSE in C++, produce a RuntimeException in Java

Operation isIdlCustom

Declaration :

returns TRUE is the class is custom, have sense for a valuetype

Operation set_isIdlCustom

Declaration :

set if the class is custom have sense for aa valuetype

On error return FALSE in C++, produce a RuntimeException in Java

Operation get

Declaration :

returns the class having the name given in argument in case it
exist, else 0/null. In case the package is specified (not 0/null),
the returned class will be defined in a sub-level of the package.

Operation unload

Declaration :

to unload the object to free memory, it will be reloaded automatically
if needed. Recursively done for the sub items if 'rec' is TRUE.

if 'del' is true the sub items are deleted in C++, and removed from the
internal dictionnary in C++ and Java (to allow it to be garbaged),
you will have to call Children() to re-access to them

Operation set_Name

Declaration :

to set the name

On error return FALSE in C++, produce a RuntimeException in Java

Attribut _classes

Declaration :

Extra Class Member initialization

Definition :

Attribut _abstract

Declaration :

Attribut _cpp_external

Declaration :

Attribut _java_external

Declaration :

Attribut _java_final

Declaration :

Attribut _idl_external

Declaration :

Attribut _idl_local

Declaration :

Attribut _idl_custom

Declaration :

Relation _base_type (<directional aggregation by value>)

Declaration :

Relation _assoc_diagram (<unidirectional association>)

Declaration :

Relation _switch_type (<directional aggregation by value>)

Declaration :

union

Operation UmlBaseClass

Declaration :

the constructor, do not call it yourself !!!!!!!!!!

Operation read_uml_

Declaration :

internal, do NOT use it

Operation read_cpp_

Declaration :

internal, do NOT use it

Operation read_java_

Declaration :

internal, do NOT use it

Operation read_idl_

Declaration :

internal, do NOT use it

Operation reread_if_needed_

Declaration :

internal, do NOT use it

All public operations : actuals , addFormal , apply , associatedArtifact , associatedComponents , associatedDiagram , baseType , children , childrenVisible , constraint , cppDecl , cppVisibility , create , defined_ , deleteIt , description , formals , get , getIdentifier , identifier_ , idlDecl , isAbstract , isClassMember , isCppExternal , isIdlCustom , isIdlExternal , isIdlLocal , isJavaExternal , isJavaFinal , isJavaPublic , isMarked , isToolRunning , isVolatile , isWritable , javaAnnotations , javaDecl , kind , kind , markedItems , moveAfter , name , parent , properties , propertyValue , referencedBy , removeFormal , replaceActual , replaceFormal , set_AssociatedDiagram , set_BaseType , set_childrenVisible , set_Constraint , set_CppDecl , set_CppVisibility , set_Description , set_IdlDecl , set_isAbstract , set_isClassMember , set_isCppExternal , set_isIdlCustom , set_isIdlExternal , set_isIdlLocal , set_isJavaExternal , set_isJavaFinal , set_isJavaPublic , set_isMarked , set_isVolatile , set_JavaAnnotations , set_JavaDecl , set_Name , set_Name , set_PropertyValue , set_Stereotype , set_SwitchType , set_Visibility , stereotype , supportFile , switchType , unload , unload , unload , visibility