Class IdlSettings

Declaration :

This class manages settings concerning IDL, configured through
the 'Generation settings' dialog.

This class may be defined as a 'singleton', but I prefer to use static
members allowing to just write 'IdlSettings::member' rather than
'IdlSettings::instance()->member' or other long sentence like this.

Artifact : IdlSettings

Operation useDefaults

Declaration :

returns TRUE when the created Java objects are initialized
with the default declaration/definition

Operation set_UseDefaults

Declaration :

if y is TRUE the future created Java objects will be initialized
with the default declaration/definition

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

Operation type

Declaration :

returns the IDL type corresponding to the 'UML' type given in
argument, as it is configured in the first 'Generation settings'
dialog's tab

Operation set_Type

Declaration :

set the IDL type corresponding to the 'UML' type given in
argument, as it is configured in the first 'Generation settings'
dialog's tab

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

Operation umlType

Declaration :

reverse of the Type() operation, returns the 'UML' type corresponding
to the IDL type given in argument

Operation relationAttributeStereotype

Declaration :

returns the IDL stereotype corresponding to the 'UML' stereotype given
in argument

Operation set_RelationAttributeStereotype

Declaration :

set the IDL stereotype corresponding to the 'UML' stereotype given
in argument

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

Operation relationAttributeUmlStereotype

Declaration :

reverse of the RelationAttributeStereotype() operation, returns the 'UML'
stereotype corresponding to the IDL one given in argument

Operation classStereotype

Declaration :

returns the IDL stereotype corresponding to the 'UML' stereotype given
in argument

Operation set_ClassStereotype

Declaration :

set the IDL stereotype corresponding to the 'UML' stereotype given
in argument

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

Operation classUmlStereotype

Declaration :

reverse of the ClassStereotype() operation, returns the 'UML'
stereotype corresponding to the IDL one given in argument

Operation include

Declaration :

returns the #include or other form specified in the last
'Generation settings' tab for the Idl type given in argument.

Operation set_Include

Declaration :

set the #include or other form specified in the last
'Generation settings' tab for the Idl type given in argument.

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

Operation rootDir

Declaration :

returns the 'root' directory

Operation set_RootDir

Declaration :

set the 'root' directory

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

Operation sourceContent

Declaration :

returns the default source file content

Operation set_SourceContent

Declaration :

set the default source file content

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

Operation sourceExtension

Declaration :

returns the extension of the files produced by the Idl code generator

Operation set_SourceExtension

Declaration :

set the extension of the files produced by the Idl code generator

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

Operation interfaceDecl

Declaration :

returns the default definition of an interface

Operation set_InterfaceDecl

Declaration :

set the default definition of an interface

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

Operation valuetypeDecl

Declaration :

returns the default definition of a valuetype

Operation set_ValuetypeDecl

Declaration :

set the default definition of a valuetype

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

Operation externalClassDecl

Declaration :

returns the default specification for an 'external' class

Operation set_ExternalClassDecl

Declaration :

set the default specification for an 'external' class

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

Operation structDecl

Declaration :

returns the default definition of a struct

Operation set_StructDecl

Declaration :

set the default definition of a struct

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

Operation typedefDecl

Declaration :

returns the default definition of a typedef

Operation set_TypedefDecl

Declaration :

set the default definition of a typedef

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

Operation exceptionDecl

Declaration :

returns the default definition of an exception

Operation set_ExceptionDecl

Declaration :

set the default definition of an exception

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

Operation unionDecl

Declaration :

returns the default definition of an union

Operation set_UnionDecl

Declaration :

set the default definition of an union

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

Operation enumDecl

Declaration :

returns the default definition of an enum

Operation set_EnumDecl

Declaration :

set the default definition of an enum

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

Operation attributeDecl

Declaration :

returns the default definition of an attribute depending on the multiplicity

Operation set_AttributeDecl

Declaration :

set the default definition of an attribute

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

Operation valuetypeAttributeDecl

Declaration :

returns the default definition of an attribute
placed in a valuetype depending on the multiplicity

Operation set_ValuetypeAttributeDecl

Declaration :

set the default definition of an attribute
placed in a valuetype

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

Operation unionItemDecl

Declaration :

returns the default definition of an union item depending on the multiplicity

Operation set_UnionItemDecl

Declaration :

set the default definition of an union item

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

Operation enumItemDecl

Declaration :

returns the default definition of an enumeration item

Operation set_EnumItemDecl

Declaration :

set the default definition of an enumeration item

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

Operation constDecl

Declaration :

returns the default definition of a constant attribute depending on the multiplicity

Operation set_ConstDecl

Declaration :

set the default definition of a constant attribute

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

Operation relationDecl

Declaration :

returns the default definition of a relation depending on the
multiplicity given in argument.

Operation set_RelationDecl

Declaration :

set the default definition of a relation depending on the
multiplicity given in argument.

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

Operation valuetypeRelationDecl

Declaration :

returns the default definition of a relation in a valuetype
depending on the multiplicity given in argument.

Operation set_ValuetypeRelationDecl

Declaration :

set the default definition of a relation in a valuetype
depending on the multiplicity given in argument.

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

Operation unionRelationDecl

Declaration :

returns the default definition of a relation in an union
depending on the multiplicity given in argument.

Operation set_UnionRelationDecl

Declaration :

set the default definition of a relation in an union
depending on the multiplicity given in argument.

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

Operation operationDecl

Declaration :

returns the default declaration of an operation

Operation set_OperationDecl

Declaration :

set the default declaration of an operation

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

Operation getName

Declaration :

returns the default name of a 'get' operation generated through
the attribute and relation 'add get operation' menu

Operation set_GetName

Declaration :

set the default name of a 'get' operation generated through
the attribute and relation 'add get operation' menu

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

Operation setName

Declaration :

returns the default name of a 'set' operation generated
through the attribute and relation 'add set operation' menu

Operation set_SetName

Declaration :

set the default name of a 'set' operation generated
through the attribute and relation 'add set operation' menu

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

Operation isSetOneway

Declaration :

returns if a 'set' operation generated through the attribute
and relation 'add set operation' menu is oneway by default

Operation set_IsSetOneway

Declaration :

set if a 'set' operation generated through the attribute
and relation 'add set operation' menu is oneway by default

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

Operation IdlSettings

Declaration :

never called !

Attribut _defined

Declaration :

Attribut _root

Declaration :

Attribut _interface_decl

Declaration :

Attribut _valuetype_decl

Declaration :

Attribut _struct_decl

Declaration :

Attribut _typedef_decl

Declaration :

Attribut _exception_decl

Declaration :

Attribut _union_decl

Declaration :

Attribut _enum_decl

Declaration :

Attribut _external_class_decl

Declaration :

Attribut _attr_decl

Declaration :

Attribut _valuetype_attr_decl

Declaration :

Attribut _union_item_decl

Declaration :

Attribut _enum_item_decl

Declaration :

Attribut _const_decl

Declaration :

Attribut _rel_decl

Declaration :

Attribut _valuetype_rel_decl

Declaration :

Attribut _union_rel_decl

Declaration :

Attribut _oper_decl

Declaration :

Attribut _get_name

Declaration :

Attribut _set_name

Declaration :

Attribut _is_set_oneway

Declaration :

Attribut _src_content

Declaration :

Attribut _ext

Declaration :

Attribut _map_includes

Declaration :

Operation read_

Declaration :

internal, do NOT use it

Operation read_if_needed_

Declaration :

internal, do NOT use it

All public operations : artifactDescription , attributeDecl , attributeDescription , classDescription , classStereotype , classUmlStereotype , constDecl , enumDecl , enumItemDecl , exceptionDecl , externalClassDecl , getName , include , interfaceDecl , isSetOneway , operationDecl , operationDescription , relationAttributeStereotype , relationAttributeUmlStereotype , relationDecl , relationDescription , rootDir , set_ArtifactDescription , set_AttributeDecl , set_AttributeDescription , set_ClassDescription , set_ClassStereotype , set_ConstDecl , set_EnumDecl , set_EnumItemDecl , set_ExceptionDecl , set_ExternalClassDecl , set_GetName , set_Include , set_InterfaceDecl , set_IsSetOneway , set_OperationDecl , set_OperationDescription , set_RelationAttributeStereotype , set_RelationDecl , set_RelationDescription , set_RootDir , set_SetName , set_SourceContent , set_SourceExtension , set_StructDecl , set_Type , set_TypedefDecl , set_UmlGetName , set_UmlSetName , set_UnionDecl , set_UnionItemDecl , set_UnionRelationDecl , set_UseDefaults , set_ValuetypeAttributeDecl , set_ValuetypeDecl , set_ValuetypeRelationDecl , setName , sourceContent , sourceExtension , structDecl , type , typedefDecl , umlGetName , umlSetName , umlType , unionDecl , unionItemDecl , unionRelationDecl , useDefaults , valuetypeAttributeDecl , valuetypeDecl , valuetypeRelationDecl