Class CppSettings

Declaration :

This class manages settings concerning C++, 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 'CppSettings::member' rather than
'CppSettings::instance()->member' or other long sentence like this.

Artifact : CppSettings

Operation useDefaults

Declaration :

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

Operation set_UseDefaults

Declaration :

if y is TRUE the future created C++ 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 C++ 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 C++ 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 C++ type given in argument

Operation relationAttributeStereotype

Declaration :

returns the C++ stereotype corresponding to the 'UML' stereotype given
in argument

Operation set_RelationAttributeStereotype

Declaration :

set the C++ 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 C++ one given in argument

Operation classStereotype

Declaration :

returns the C++ stereotype corresponding to the 'UML' stereotype given
in argument

Operation set_ClassStereotype

Declaration :

set the C++ 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 C++ one given in argument

Operation include

Declaration :

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

Operation set_Include

Declaration :

set the #include or other form specified in the last
'Generation settings' tab for the C++ 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 headerContent

Declaration :

returns the default header file content

Operation set_HeaderContent

Declaration :

set the default header file content

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 headerExtension

Declaration :

returns the extension of the header files produced by the
C++ code generator

Operation set_HeaderExtension

Declaration :

set the extension of the header files produced by the
C++ code generator

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

Operation sourceExtension

Declaration :

returns the extension of the source files produced by the
C++ code generator

Operation set_SourceExtension

Declaration :

set the extension of the source files produced by the
C++ code generator

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

Operation includeWithPath

Declaration :

indicates to the code generator if the #include may specify
the path of just the file's name

Operation set_IncludeWithPath

Declaration :

to indicates to the code generator if the #include may specify
the path of just the file's name

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

Operation isRelativePath

Declaration :

return if a relative path must be used when the path
must be generated in the produced #includes

Operation set_IsRelativePath

Declaration :

set if a relative path must be used when the path
must be generated in the produced #includes

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

Operation isRootRelativePath

Declaration :

return if a path relative to the project root must be used
when the path must be generated in the produced #includes

Operation set_IsRootRelativePath

Declaration :

set if a relative to the project root path must be used
when the path must be generated in the produced #includes

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

Operation isForceNamespacePrefixGeneration

Declaration :

return if the namespace prefix must be
always generated before class's names

Operation set_IsForceNamespacePrefixGeneration

Declaration :

set if the namespace prefix must be always generated before class's names

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

Operation isGenerateJavadocStyleComment

Declaration :

return if generate Javadoc style comment

Operation set_IsGenerateJavadocStyleComment

Declaration :

set if generate Javadoc style comment

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

Operation enumIn

Declaration :

returns the default operation 'in' parameter specification
in case its type is an enum

Operation set_EnumIn

Declaration :

set the default operation 'in' parameter specification
in case its type is an enum

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

Operation enumOut

Declaration :

returns the default operation 'out' parameter specification
in case its type is an enum

Operation set_EnumOut

Declaration :

set the default operation 'out' parameter specification
in case its type is an enum

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

Operation enumInout

Declaration :

returns the default operation 'inout' parameter specification
in case its type is an enum

Operation set_EnumInout

Declaration :

set the default operation 'inout' parameter specification
in case its type is an enum

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

Operation enumReturn

Declaration :

return the default operation value type form

Operation set_EnumReturn

Declaration :

set the default operation value type form

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

Operation in

Declaration :

returns the default operation 'in' parameter specification
in case its type is not an enum or a type specified in the
first 'Generation settings' tab

Operation set_In

Declaration :

set the default operation 'in' parameter specification
in case its type is not an enum or a type specified in the
first 'Generation settings' tab

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

Operation out

Declaration :

returns the default operation 'out' parameter specification
in case its type is not an enum or a type specified in the
first 'Generation settings' tab

Operation set_Out

Declaration :

set the default operation 'out' parameter specification
in case its type is not an enum or a type specified in the
first 'Generation settings' tab

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

Operation inout

Declaration :

returns the default operation 'inout' parameter specification
in case its type is not an enum or a type specified in the
first 'Generation settings' tab

Operation set_Inout

Declaration :

set the default operation 'inout' parameter specification
in case its type is not an enum or a type specified in the
first 'Generation settings' tab

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

Operation Return

Declaration :

return the default operation value type form

Operation set_Return

Declaration :

set the default operation value type form

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

Operation classDecl

Declaration :

returns the default definition of a class

Operation set_ClassDecl

Declaration :

set the default definition of a class

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 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 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 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 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 relationDecl

Declaration :

returns the default definition of a relation depending on it is an
aggregation by value or not and the multiplicity, given in argument.

Operation set_RelationDecl

Declaration :

set the default definition of a relation depending on it is an
aggregation by value or not and 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 operationDef

Declaration :

returns the default definition of an operation

Operation set_OperationDef

Declaration :

set the default definition of an operation

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

Operation operationForceThrow

Declaration :

return TRUE if the operations profile must contain 'throw()'
when the operations does not have exception

Operation set_OperationForceThrow

Declaration :

set if the operations profile must contain 'throw()'
when the operations does not have exception

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

Operation getVisibility

Declaration :

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

Operation set_GetVisibility

Declaration :

set the default visibility 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 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 isGetInline

Declaration :

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

Operation set_IsGetInline

Declaration :

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

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

Operation isGetConst

Declaration :

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

Operation set_IsGetConst

Declaration :

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

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

Operation isGetValueConst

Declaration :

returns if the value returned by a 'get' operation generated through
the attribute and relation 'add get operation' menu is const by default

Operation set_IsGetValueConst

Declaration :

set if the value returned by a 'get' operation generated through
the attribute and relation 'add get operation' menu is const by default


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

Operation setVisibility

Declaration :

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

Operation set_SetVisibility

Declaration :

set the default visibility 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 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 isSetInline

Declaration :

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

Operation set_IsSetInline

Declaration :

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


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

Operation isSetParamConst

Declaration :

returns if the parameters of a 'set' operation generated through the
attribute and relation 'add set operation' menu are const by default

Operation set_IsSetParamConst

Declaration :

set if the parameters of a 'set' operation generated through the
attribute and relation 'add set operation' menu are const by default


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

Operation isSetParamRef

Declaration :

return if the parameter of a 'set' operation generated through the
attribute and relation 'add set operation' menu is a reference by default

Operation set_IsSetParamRef

Declaration :

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

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

Operation CppSettings

Declaration :

never called !

Attribut _defined

Declaration :

Attribut _root

Declaration :

Attribut _in

Declaration :

Attribut _out

Declaration :

Attribut _inout

Declaration :

Attribut _return

Declaration :

Attribut _enum_in

Declaration :

Attribut _enum_out

Declaration :

Attribut _enum_inout

Declaration :

Attribut _enum_return

Declaration :

Attribut _class_decl

Declaration :

Attribut _external_class_decl

Declaration :

Attribut _struct_decl

Declaration :

Attribut _union_decl

Declaration :

Attribut _enum_decl

Declaration :

Attribut _typedef_decl

Declaration :

Attribut _attr_decl

Declaration :

Attribut _enum_item_decl

Declaration :

Attribut _rel_decl

Declaration :

Attribut _oper_decl

Declaration :

Attribut _oper_def

Declaration :

Attribut _force_oper_throw

Declaration :

Relation _get_visibility (<directional aggregation by value>)

Declaration :

Attribut _get_name

Declaration :

Attribut _is_get_inline

Declaration :

Attribut _is_get_const

Declaration :

Attribut _is_get_value_const

Declaration :

Relation _set_visibility (<directional aggregation by value>)

Declaration :

Attribut _set_name

Declaration :

Attribut _is_set_inline

Declaration :

Attribut _is_set_param_const

Declaration :

Attribut _is_set_param_ref

Declaration :

Attribut _h_content

Declaration :

Attribut _src_content

Declaration :

Attribut _h_ext

Declaration :

Attribut _src_ext

Declaration :

Attribut _incl_with_path

Declaration :

Attribut _is_relative_path

Declaration :

Attribut _is_root_relative_path

Declaration :

Attribut _is_force_namespace_gen

Declaration :

Attribut _is_generate_javadoc_comment

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 , classDecl , classDescription , classStereotype , classUmlStereotype , enumDecl , enumIn , enumInout , enumItemDecl , enumOut , enumReturn , externalClassDecl , getName , getVisibility , headerContent , headerExtension , in , include , includeWithPath , inout , isForceNamespacePrefixGeneration , isGenerateJavadocStyleComment , isGetConst , isGetInline , isGetValueConst , isRelativePath , isRootRelativePath , isSetInline , isSetParamConst , isSetParamRef , operationDecl , operationDef , operationDescription , operationForceThrow , out , relationAttributeStereotype , relationAttributeUmlStereotype , relationDecl , relationDescription , Return , rootDir , set_ArtifactDescription , set_AttributeDecl , set_AttributeDescription , set_ClassDecl , set_ClassDescription , set_ClassStereotype , set_EnumDecl , set_EnumIn , set_EnumInout , set_EnumItemDecl , set_EnumOut , set_EnumReturn , set_ExternalClassDecl , set_GetName , set_GetVisibility , set_HeaderContent , set_HeaderExtension , set_In , set_Include , set_IncludeWithPath , set_Inout , set_IsForceNamespacePrefixGeneration , set_IsGenerateJavadocStyleComment , set_IsGetConst , set_IsGetInline , set_IsGetValueConst , set_IsRelativePath , set_IsRootRelativePath , set_IsSetInline , set_IsSetParamConst , set_IsSetParamRef , set_OperationDecl , set_OperationDef , set_OperationDescription , set_OperationForceThrow , set_Out , set_RelationAttributeStereotype , set_RelationDecl , set_RelationDescription , set_Return , set_RootDir , set_SetName , set_SetVisibility , set_SourceContent , set_SourceExtension , set_StructDecl , set_Type , set_TypedefDecl , set_UmlGetName , set_UmlSetName , set_UnionDecl , set_UseDefaults , setName , setVisibility , sourceContent , sourceExtension , structDecl , type , typedefDecl , umlGetName , umlSetName , umlType , unionDecl , useDefaults