Class UmlBasePackage

Declaration :

- C++ : class UmlBasePackage : public UmlItem
- Java : abstract class UmlBasePackage extends UmlItem

Directly inherited by : UmlPackage

Manage the packages

Artifact : UmlBasePackage

Operation create

Declaration :

- Uml : static, + create(inout parent : UmlPackage, in name : str) : UmlPackage, exceptions : RuntimeException
- C++ : public: static UmlPackage * create(UmlPackage * parent, const char * name)
- Java : public static UmlPackage create(UmlPackage parent, String name) throws RuntimeException

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

Operation kind

Declaration :

- Uml : + kind() : anItemKind
- C++ : public: virtual anItemKind kind()
- Java : public anItemKind kind()

returns the kind of the item

Operation associatedDiagram

Declaration :

- Uml : + associatedDiagram() : UmlDiagram
- C++ : public: UmlDiagram * associatedDiagram()
- Java : public UmlDiagram associatedDiagram()

returns the optional associated diagram

Operation set_AssociatedDiagram

Declaration :

- Uml : + set_AssociatedDiagram(inout d : UmlDiagram) : bool, exceptions : RuntimeException
- C++ : public: bool set_AssociatedDiagram(UmlDiagram * d)
- Java : public void set_AssociatedDiagram(UmlDiagram d) throws RuntimeException

sets the associated diagram, arg may be null to unset it
On error return FALSE in C++, produce a RuntimeException in Java

Operation cppSrcDir

Declaration :

- Uml : + cppSrcDir() : string
- C++ : public: const QCString & cppSrcDir()
- Java : public String cppSrcDir()

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

Operation set_CppSrcDir

Declaration :

- Uml : + set_CppSrcDir(in s : string) : bool, exceptions : RuntimeException
- C++ : public: bool set_CppSrcDir(const QCString & s)
- Java : public void set_CppSrcDir(String s) throws RuntimeException

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

Operation cppHDir

Declaration :

- Uml : + cppHDir() : string
- C++ : public: const QCString & cppHDir()
- Java : public String cppHDir()

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

Operation set_CppHDir

Declaration :

- Uml : + set_CppHDir(in s : string) : bool, exceptions : RuntimeException
- C++ : public: bool set_CppHDir(const QCString & s)
- Java : public void set_CppHDir(String s) throws RuntimeException

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

Operation cppNamespace

Declaration :

- Uml : + cppNamespace() : string
- C++ : public: QCString cppNamespace()
- Java : public String cppNamespace()

returns the namespace name associed to the package

Operation set_CppNamespace

Declaration :

- Uml : + set_CppNamespace(in s : string) : bool, exceptions : RuntimeException
- C++ : public: bool set_CppNamespace(const QCString & s)
- Java : public void set_CppNamespace(String s) throws RuntimeException

to set the namespace name associed to the package.
On error return FALSE in C++, produce a RuntimeException in Java

Operation findNamespace

Declaration :

- Uml : + findNamespace(in n : string) : UmlPackage
- C++ : public: UmlPackage * findNamespace(const QCString & n) const
- Java : public UmlPackage findNamespace(String n)

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

Operation javaDir

Declaration :

- Uml : + javaDir() : string
- C++ : public: const QCString & javaDir()
- Java : public String javaDir()

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

Operation set_JavaDir

Declaration :

- Uml : + set_JavaDir(in s : string) : bool, exceptions : RuntimeException
- C++ : public: bool set_JavaDir(const QCString & s)
- Java : public void set_JavaDir(String s) throws RuntimeException

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

Operation javaPackage

Declaration :

- Uml : + javaPackage() : string
- C++ : public: QCString javaPackage()
- Java : public String javaPackage()

returns the java package name associed to the package

Operation set_JavaPackage

Declaration :

- Uml : + set_JavaPackage(in s : string) : bool, exceptions : RuntimeException
- C++ : public: bool set_JavaPackage(const QCString & s)
- Java : public void set_JavaPackage(String s) throws RuntimeException

to set the java package name associed to the package.
On error return FALSE in C++, produce a RuntimeException in Java

Operation findPackage

Declaration :

- Uml : + findPackage(in n : string) : UmlPackage
- C++ : public: UmlPackage * findPackage(const QCString & n) const
- Java : public UmlPackage findPackage(String n)

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

Operation idlDir

Declaration :

- Uml : + idlDir() : string
- C++ : public: const QCString & idlDir()
- Java : public String idlDir()

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

Operation set_IdlDir

Declaration :

- Uml : + set_IdlDir(in s : string) : bool, exceptions : RuntimeException
- C++ : public: bool set_IdlDir(const QCString & s)
- Java : public void set_IdlDir(String s) throws RuntimeException

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

Operation idlModule

Declaration :

- Uml : + idlModule() : string
- C++ : public: QCString idlModule()
- Java : public String idlModule()

returns the module name associed to the package

Operation set_IdlModule

Declaration :

- Uml : + set_IdlModule(in s : string) : bool, exceptions : RuntimeException
- C++ : public: bool set_IdlModule(const QCString & s)
- Java : public void set_IdlModule(String s) throws RuntimeException

to set the module name associed to the package.
On error return FALSE in C++, produce a RuntimeException in Java

Operation findModule

Declaration :

- Uml : + findModule(in n : string) : UmlPackage
- C++ : public: UmlPackage * findModule(const QCString & n) const
- Java : public UmlPackage findModule(String n)

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

Operation getProject

Declaration :

- Uml : static, + getProject() : UmlPackage
- C++ : public: static UmlPackage * getProject()
- Java : public static UmlPackage getProject()

Returns the project

Operation isProjectModified

Declaration :

- Uml : static, + isProjectModified() : bool
- C++ : public: static bool isProjectModified()
- Java : public static boolean isProjectModified()

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

Operation saveProject

Declaration :

- Uml : static, + saveProject() : void
- C++ : public: static void saveProject()
- Java : public static void saveProject()

save the project if needed

Operation loadProject

Declaration :

- Uml : static, + loadProject(inout p : string) : void
- C++ : public: static void loadProject(QCString p)
- Java : public static void loadProject(String p)

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.

Operation unload

Declaration :

- Uml : + unload(in rec : bool, in del : bool) : void
- C++ : public: virtual void unload(bool rec = FALSE, bool del = FALSE)
- Java : public void unload(boolean rec, boolean del)

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

Relation _assoc_diagram (<unidirectional association>)

Declaration :

- Uml : - _assoc_diagram : UmlDiagram
- C++ : private: UmlDiagram * _assoc_diagram
- Java : private UmlDiagram _assoc_diagram

Attribut _cpp_src_dir

Declaration :

- Uml : - _cpp_src_dir : string
- C++ : private: QCString _cpp_src_dir
- Java : private String _cpp_src_dir

Attribut _cpp_h_dir

Declaration :

- Uml : - _cpp_h_dir : string
- C++ : private: QCString _cpp_h_dir
- Java : private String _cpp_h_dir

Attribut _cpp_namespace

Declaration :

- Uml : - _cpp_namespace : string
- C++ : private: QCString _cpp_namespace
- Java : private String _cpp_namespace

Attribut _java_dir

Declaration :

- Uml : - _java_dir : string
- C++ : private: QCString _java_dir
- Java : private String _java_dir

Attribut _java_package

Declaration :

- Uml : - _java_package : string
- C++ : private: QCString _java_package
- Java : private String _java_package

Attribut _idl_dir

Declaration :

- Uml : - _idl_dir : string
- C++ : private: QCString _idl_dir
- Java : private String _idl_dir

Attribut _idl_module

Declaration :

- Uml : - _idl_module : string
- C++ : private: QCString _idl_module
- Java : private String _idl_module

Operation read_uml_

Declaration :

- Uml : # read_uml_() : void
- C++ : protected: virtual void read_uml_()
- Java : protected void read_uml_()

internal, do NOT use it

Operation read_cpp_

Declaration :

- Uml : # read_cpp_() : void
- C++ : protected: virtual void read_cpp_()
- Java : protected void read_cpp_()

internal, do NOT use it

Operation read_java_

Declaration :

- Uml : # read_java_() : void
- C++ : protected: virtual void read_java_()
- Java : protected void read_java_()

internal, do NOT use it

Operation read_idl_

Declaration :

- Uml : # read_idl_() : void
- C++ : protected: virtual void read_idl_()
- Java : protected void read_idl_()

internal, do NOT use it

Operation UmlBasePackage

Declaration :

- Uml : # UmlBasePackage(in id : item_id, in n : string) :
- C++ : protected: UmlBasePackage(void * id, const QCString & n)
- Java : protected UmlBasePackage(long id, String n)

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

All public operations : apply , associatedDiagram , children , childrenVisible , cppHDir , cppNamespace , cppSrcDir , create , defined_ , deleteIt , description , findModule , findNamespace , findPackage , getIdentifier , getProject , identifier_ , idlDir , idlModule , isMarked , isProjectModified , isToolRunning , isWritable , javaDir , javaPackage , kind , kind , loadProject , markedItems , moveAfter , name , parent , properties , propertyValue , 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_Name , set_PropertyValue , set_Stereotype , stereotype , supportFile , unload , unload