Class UmlBasePackage

Manage the packages

Declaration :

Directly inherited by : UmlPackage

Artifact : UmlBasePackage

Operation create

returns a new package named 'name' 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

Declaration :

Operation kind

returns the kind of the item

Declaration :

Operation associatedDiagram

returns the optional associated diagram

Declaration :

Operation set_AssociatedDiagram

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

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

Declaration :

Operation importProject

Import a project in the current package
fn is the pathname of the .prj file of the project to import
or an empty string (the project will be set through a dialog)
Return the new UmlPackage containing the imported project, or
0/null on error

Declaration :

Operation cppSrcDir

returns the path where the C++ source files are generated by the
c++ generator.

Declaration :

Operation set_CppSrcDir

to set the path where the C++ source files are generated by the
C++ generator, may be relative even the 'root' path is not
(already) an absolute path

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

Declaration :

Operation cppHDir

returns the path where the C++ header files are generated by the
C++ generator.

Declaration :

Operation set_CppHDir

to set the path where the C++ header files are generated by the
C++ generator, may be relative even the 'root' path is not
(already) an absolute path

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

Declaration :

Operation cppNamespace

returns the namespace name associed to the package

Declaration :

Operation set_CppNamespace

to set the namespace name associed to the package.

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

Declaration :

Operation findCppNamespace

returns a sub package of the current one having the c++ namespace 'n'
(including the current one), else 0/null

Declaration :

Operation javaDir

returns the path where the JAVA files are generated by the
JAVA generator.

Declaration :

Operation set_JavaDir

to set the path where the JAVA files are generated by the
JAVA generator, may be relative even the 'root' path is not
(already) an absolute path

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

Declaration :

Operation javaPackage

returns the java package name associed to the package

Declaration :

Operation set_JavaPackage

to set the java package name associed to the package.

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

Declaration :

Operation findJavaPackage

returns a sub package of the current one having the Java package 'n'
(including the current one), else 0/null

Declaration :

Operation phpDir

returns the path where the PHP files are generated by the
PHP generator.

Declaration :

Operation set_PhpDir

to set the path where the PHP files are generated by the
PHP generator, may be relative even the 'root' path is not
(already) an absolute path

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

Declaration :

Operation phpNamespace

return the namespace name associed to the package

Declaration :

Operation set_PhpNamespace

the namespace name associed to the package.

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

Declaration :

Operation findPhpNamespace

returns a sub package of the current one having the php namespace 'n'
(including the current one), else 0/null

Declaration :

Operation pythonDir

returns the path where the PYTHON files are generated by the
PYTHON generator.

Declaration :

Operation set_PythonDir

to set the path where the PYTHON files are generated by the
PYTHON generator, may be relative even the 'root' path is not
(already) an absolute path

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

Declaration :

Operation pythonPackage

returns the python package name associed to the package

Declaration :

Operation set_PythonPackage

to set the python package name associed to the package.

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

Declaration :

Operation findPythonPackage

returns a sub package of the current one having the Python package 'n'
(including the current one), else 0/null

Declaration :

Operation idlDir

returns the path where the IDL files are generated by the
IDL generator.

Declaration :

Operation set_IdlDir

to set the path where the IDL files are generated by the
IDL generator, may be relative even the 'root' path is not
(already) an absolute path

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

Declaration :

Operation idlModule

returns the module name associed to the package

Declaration :

Operation set_IdlModule

to set the module name associed to the package.

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

Declaration :

Operation findIdlModule

returns a sub package of the current one having the IDL module 'n'
(including the current one), else 0/null

Declaration :

Operation mysqlDir

returns the path where the MySql files are generated by the
Mysql generator.

Declaration :

Operation set_MysqlDir

to set the path where the MySQL files are generated by the
Mysql generator, may be relative even the 'root' path is not
(already) an absolute path

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

Declaration :

Operation getProject

Returns the project

Declaration :

Operation isProjectModified

return TRUE in case something is modified (i.e. the project must be saved)

Declaration :

Operation saveProject

save the project if needed

Declaration :

Operation loadProject

Does nothing in case an edition is on going under BOUML. Else :
close the current project (in case it is not saved the last modifications are lost),
load the specified one, and all the communications with the plug-outs including the
current one are closed.

Declaration :

Operation updateProfiles

Force consistency concerning the profiles and their stereotypes

Declaration :

Operation unload

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

Declaration :

Relation _assoc_diagram (<unidirectional association>)

Declaration :

Attribute _cpp_src_dir

Declaration :

Attribute _cpp_h_dir

Declaration :

Attribute _cpp_namespace

Declaration :

Attribute _java_dir

Declaration :

Attribute _java_package

Declaration :

Attribute _php_dir

Declaration :

Attribute _php_namespace

Declaration :

Attribute _python_dir

Declaration :

Attribute _python_package

Declaration :

Attribute _idl_dir

Declaration :

Attribute _idl_module

Declaration :

Attribute _mysql_dir

Declaration :

Operation read_uml_

internal, do NOT use it

Declaration :

Operation read_cpp_

internal, do NOT use it

Declaration :

Operation read_java_

internal, do NOT use it

Declaration :

Operation read_php_

internal, do NOT use it

Declaration :

Operation read_python_

internal, do NOT use it

Declaration :

Operation read_idl_

internal, do NOT use it

Declaration :

Operation read_mysql_

internal, do NOT use it

Declaration :

Operation UmlBasePackage

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

Declaration :

All public operations : apply , applyStereotype , associatedDiagram , children , childrenVisible , cppHDir , cppNamespace , cppSrcDir , create , defined_ , deleteIt , description , findCppNamespace , findIdlModule , findJavaPackage , findPhpNamespace , findPythonPackage , getIdentifier , getProject , identifier_ , idlDir , idlModule , importProject , isMarked , isProjectModified , isToolRunning , isWritable , javaDir , javaPackage , kind , kind , loadProject , markedItems , moveAfter , mysqlDir , name , parent , phpDir , phpNamespace , properties , propertyValue , pythonDir , pythonPackage , referencedBy , saveProject , set_AssociatedDiagram , set_childrenVisible , set_CppHDir , set_CppNamespace , set_CppSrcDir , set_Description , set_IdlDir , set_IdlModule , set_isMarked , set_JavaDir , set_JavaPackage , set_MysqlDir , set_Name , set_PhpDir , set_PhpNamespace , set_PropertyValue , set_PythonDir , set_PythonPackage , set_Stereotype , stereotype , supportFile , unload , unload , updateProfiles