Class CppSettings

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.

Declaration :

Artifact : CppSettings

Operation useDefaults

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

Declaration :

Operation set_UseDefaults

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

Declaration :

Operation type

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

Declaration :

Operation set_Type

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

Declaration :

Operation umlType

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

Declaration :

Operation relationAttributeStereotype

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

Declaration :

Operation set_RelationAttributeStereotype

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

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

Declaration :

Operation relationAttributeUmlStereotype

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

Declaration :

Operation classStereotype

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

Declaration :

Operation set_ClassStereotype

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

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

Declaration :

Operation classUmlStereotype

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

Declaration :

Operation include

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

Declaration :

Operation set_Include

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

Declaration :

Operation rootDir

returns the 'root' directory

Declaration :

Operation set_RootDir

set the 'root' directory

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

Declaration :

Operation headerContent

returns the default header file content

Declaration :

Operation set_HeaderContent

set the default header file content

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

Declaration :

Operation sourceContent

returns the default source file content

Declaration :

Operation set_SourceContent

set the default source file content

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

Declaration :

Operation headerExtension

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

Declaration :

Operation set_HeaderExtension

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

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

Declaration :

Operation sourceExtension

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

Declaration :

Operation set_SourceExtension

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

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

Declaration :

Operation reverseRoundtripDirRegExp

return the regular expression used to bypass
dir s on reverse/roundtrip

Declaration :

Operation isReverseRoundtripDirRegExpCaseSensitive

return if the regular expression used to bypass
dir s on reverse/roundtrip is case sensitive

Declaration :

Operation set_ReverseRoundtripDirRegExp

set the regular expression used to bypass
dir s on reverse/roundtrip
On error : return FALSE in C++, produce a RuntimeException in Java

Declaration :

Operation reverseRoundtripFileRegExp

return the regular expression used to bypass
file s on reverse/roundtrip

Declaration :

Operation isReverseRoundtripFileRegExpCaseSensitive

return if the regular expression used to bypass
file s on reverse/roundtrip is case sensitive

Declaration :

Operation set_ReverseRoundtripFileRegExp

set the regular expression used to bypass
file s on reverse/roundtrip
On error : return FALSE in C++, produce a RuntimeException in Java

Declaration :

Operation includeWithPath

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

Declaration :

Operation set_IncludeWithPath

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

Declaration :

Operation isRelativePath

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

Declaration :

Operation set_IsRelativePath

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

Declaration :

Operation isRootRelativePath

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

Declaration :

Operation set_IsRootRelativePath

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

Declaration :

Operation isForceNamespacePrefixGeneration

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

Declaration :

Operation set_IsForceNamespacePrefixGeneration

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

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

Declaration :

Operation isInlineOperationForceIncludesInHeader

return if the fact an operation is inline force the header of the
types referenced in the profile to be included in the header

Declaration :

Operation set_IsInlineOperationForceIncludesInHeader

set if the fact an operation is inline force the header of the
types referenced in the profile to be included in the header

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

Declaration :

Operation isGenerateJavadocStyleComment

return if generate Javadoc style comment

Declaration :

Operation set_IsGenerateJavadocStyleComment

set if generate Javadoc style comment

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

Declaration :

Operation visibilityIndent

return the indent of the visibility specifiers

Declaration :

Operation set_VisibilityIndent

set visibility specifiers indent

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

Declaration :

Operation friendClassIndent

return the indent of the friend class declaration

Declaration :

Operation set_FriendClassIndent

set friend class declaration indent

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

Declaration :

Operation nestedClassIndent

return the indent of the nested class declaration

Declaration :

Operation set_NestedClassIndent

set nested class declaration indent

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

Declaration :

Operation enumIn

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

Declaration :

Operation set_EnumIn

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

Declaration :

Operation enumOut

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

Declaration :

Operation set_EnumOut

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

Declaration :

Operation enumInout

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

Declaration :

Operation set_EnumInout

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

Declaration :

Operation enumReturn

return the default operation value type form

Declaration :

Operation set_EnumReturn

set the default operation value type form

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

Declaration :

Operation builtinIn

returns the default operation 'in' parameter specification
in case its type is specified in the first 'Generation
settings' tab, else an empty string/null

Declaration :

Operation set_BuiltinIn

set the default operation 'in' parameter specification
in case its type is specified in the first 'Generation
settings' tab

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

Declaration :

Operation builtinOut

returns the default operation 'out' parameter specification
in case its type is specified in the first 'Generation
settings' tab, else an empty string/null

Declaration :

Operation set_BuiltinOut

set the default operation 'out' parameter specification
in case its type is specified in the first 'Generation
settings' tab

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

Declaration :

Operation builtinInOut

returns the default operation 'inout' parameter specification
in case its type is specified in the first 'Generation
settings' tab, else an empty string/null

Declaration :

Operation set_BuiltinInOut

set the default operation 'inout' parameter specification
in case its type is specified in the first 'Generation
settings' tab

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

Declaration :

Operation builtinReturn

returns the default operation 'return' parameter specification
in case its type is specified in the first 'Generation
settings' tab, else an empty string/null

Declaration :

Operation set_BuiltinReturn

set the default operation 'return' parameter specification
in case its type is specified in the first 'Generation
settings' tab

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

Declaration :

Operation in

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

Declaration :

Operation set_In

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

Declaration :

Operation out

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

Declaration :

Operation set_Out

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

Declaration :

Operation inout

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

Declaration :

Operation set_Inout

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

Declaration :

Operation Return

return the default operation value type form

Declaration :

Operation set_Return

set the default operation value type form

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

Declaration :

Operation classDecl

returns the default definition of a class

Declaration :

Operation set_ClassDecl

set the default definition of a class

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

Declaration :

Operation externalClassDecl

returns the default specification for an 'external' class

Declaration :

Operation set_ExternalClassDecl

set the default specification for an 'external' class

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

Declaration :

Operation structDecl

returns the default definition of a struct

Declaration :

Operation set_StructDecl

set the default definition of a struct

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

Declaration :

Operation unionDecl

returns the default definition of an union

Declaration :

Operation set_UnionDecl

set the default definition of an union

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

Declaration :

Operation enumDecl

returns the default definition of an enum

Declaration :

Operation set_EnumDecl

set the default definition of an enum

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

Declaration :

Operation enumClassDecl

returns the default definition of an enum class

Declaration :

Operation set_EnumClassDecl

set the default definition of an enum class

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

Declaration :

Operation typedefDecl

returns the default definition of a typedef

Declaration :

Operation set_TypedefDecl

set the default definition of a typedef

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

Declaration :

Operation templateTypedefDecl

returns the default definition of a template typedef

Declaration :

Operation set_TemplateTypedefDecl

set the default definition of a template typedef

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

Declaration :

Operation attributeDecl

returns the default definition of an attribute depending on the multiplicity

Declaration :

Operation set_AttributeDecl

set the default definition of an attribute

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

Declaration :

Operation enumItemDecl

returns the default definition of an enumeration item

Declaration :

Operation set_EnumItemDecl

set the default definition of an enumeration item

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

Declaration :

Operation relationDecl

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

Declaration :

Operation set_RelationDecl

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

Declaration :

Operation operationDecl

returns the default declaration of an operation

Declaration :

Operation set_OperationDecl

set the default declaration of an operation

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

Declaration :

Operation operationDef

returns the default definition of an operation

Declaration :

Operation set_OperationDef

set the default definition of an operation

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

Declaration :

Operation operationForceThrow

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

Declaration :

Operation set_OperationForceThrow

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

Declaration :

Operation operationForceNoexcept

return TRUE if the operations profile must contain 'noexcept'
when the operations does not have exception

Declaration :

Operation set_OperationForceNoexcept

set if the operations profile must contain 'noexcept'
when the operations does not have exception

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

Declaration :

Operation getVisibility

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

Declaration :

Operation set_GetVisibility

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

Declaration :

Operation getName

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

Declaration :

Operation set_GetName

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

Declaration :

Operation isGetInline

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

Declaration :

Operation set_IsGetInline

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

Declaration :

Operation isGetConst

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

Declaration :

Operation set_IsGetConst

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

Declaration :

Operation isGetValueConst

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

Declaration :

Operation set_IsGetValueConst

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

Declaration :

Operation setVisibility

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

Declaration :

Operation set_SetVisibility

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

Declaration :

Operation setName

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

Declaration :

Operation set_SetName

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

Declaration :

Operation isSetInline

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

Declaration :

Operation set_IsSetInline

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

Declaration :

Operation isSetParamConst

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

Declaration :

Operation set_IsSetParamConst

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

Declaration :

Operation isSetParamRef

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

Declaration :

Operation set_IsSetParamRef

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

Declaration :

Operation isTypeUsedByValueForceItsIncludesInHeader

return if the fact a type is used by value in a definition
(out of the body of an operation) force the #include of its header
to be generated in the header file

Declaration :

Operation set_isTypeUsedByValueForceItsIncludesInHeader

set if the fact a type is used by value in a definition
(out of the body of an operation) force the #include of its header
to be generated in the header file

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

Declaration :

Operation CppSettings

never called !

Declaration :

Attribute _defined

Declaration :

Attribute _root

Declaration :

Attribute _in

Declaration :

Attribute _out

Declaration :

Attribute _inout

Declaration :

Attribute _return

Declaration :

Attribute _enum_in

Declaration :

Attribute _enum_out

Declaration :

Attribute _enum_inout

Declaration :

Attribute _enum_return

Declaration :

Attribute _class_decl

Declaration :

Attribute _external_class_decl

Declaration :

Attribute _struct_decl

Declaration :

Attribute _union_decl

Declaration :

Attribute _enum_decl

Declaration :

Attribute _enumclass_decl

Declaration :

Attribute _typedef_decl

Declaration :

Attribute _template_typedef_decl

Declaration :

Attribute _attr_decl

Declaration :

Attribute _enum_item_decl

Declaration :

Attribute _rel_decl

Declaration :

Attribute _oper_decl

Declaration :

Attribute _oper_def

Declaration :

Attribute _force_oper_throw

Declaration :

Attribute _force_oper_noexcept

Declaration :

Relation _get_visibility (<directional composition>)

Declaration :

Attribute _get_name

Declaration :

Attribute _is_get_inline

Declaration :

Attribute _is_get_const

Declaration :

Attribute _is_get_value_const

Declaration :

Relation _set_visibility (<directional composition>)

Declaration :

Attribute _set_name

Declaration :

Attribute _is_set_inline

Declaration :

Attribute _is_set_param_const

Declaration :

Attribute _is_set_param_ref

Declaration :

Attribute _h_content

Declaration :

Attribute _src_content

Declaration :

Attribute _h_ext

Declaration :

Attribute _src_ext

Declaration :

Attribute _dir_regexp

Declaration :

Attribute _dir_regexp_case_sensitive

Declaration :

Attribute _file_regexp

Declaration :

Attribute _file_regexp_case_sensitive

Declaration :

Attribute _incl_with_path

Declaration :

Attribute _is_relative_path

Declaration :

Attribute _is_root_relative_path

Declaration :

Attribute _is_force_namespace_gen

Declaration :

Attribute _is_generate_javadoc_comment

Declaration :

Attribute _is_inline_force_header_in_h

Declaration :

Attribute _visibility_indent

Declaration :

Attribute _friendclass_indent

Declaration :

Attribute _nestedclass_indent

Declaration :

Attribute _type_by_value_force_its_incl_in_h

Declaration :

Attribute _map_includes

Declaration :

Operation read_

internal, do NOT use it

Declaration :

Operation read_if_needed_

internal, do NOT use it

Declaration :

All public operations : artifactDescription , attributeDecl , attributeDescription , builtinIn , builtinInOut , builtinOut , builtinReturn , classDecl , classDescription , classStereotype , classUmlStereotype , enumClassDecl , enumDecl , enumIn , enumInout , enumItemDecl , enumOut , enumReturn , externalClassDecl , friendClassIndent , getName , getVisibility , headerContent , headerExtension , in , include , includeWithPath , inout , isForceNamespacePrefixGeneration , isGenerateJavadocStyleComment , isGetConst , isGetInline , isGetValueConst , isInlineOperationForceIncludesInHeader , isRelativePath , isReverseRoundtripDirRegExpCaseSensitive , isReverseRoundtripFileRegExpCaseSensitive , isRootRelativePath , isSetInline , isSetParamConst , isSetParamRef , isTypeUsedByValueForceItsIncludesInHeader , nestedClassIndent , operationDecl , operationDef , operationDescription , operationForceNoexcept , operationForceThrow , out , relationAttributeStereotype , relationAttributeUmlStereotype , relationDecl , relationDescription , Return , reverseRoundtripDirRegExp , reverseRoundtripFileRegExp , rootDir , set_ArtifactDescription , set_AttributeDecl , set_AttributeDescription , set_BuiltinIn , set_BuiltinInOut , set_BuiltinOut , set_BuiltinReturn , set_ClassDecl , set_ClassDescription , set_ClassStereotype , set_EnumClassDecl , set_EnumDecl , set_EnumIn , set_EnumInout , set_EnumItemDecl , set_EnumOut , set_EnumReturn , set_ExternalClassDecl , set_FriendClassIndent , 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_IsInlineOperationForceIncludesInHeader , set_IsRelativePath , set_IsRootRelativePath , set_IsSetInline , set_IsSetParamConst , set_IsSetParamRef , set_isTypeUsedByValueForceItsIncludesInHeader , set_NestedClassIndent , set_OperationDecl , set_OperationDef , set_OperationDescription , set_OperationForceNoexcept , set_OperationForceThrow , set_Out , set_RelationAttributeStereotype , set_RelationDecl , set_RelationDescription , set_Return , set_ReverseRoundtripDirRegExp , set_ReverseRoundtripFileRegExp , set_RootDir , set_SetName , set_SetVisibility , set_SourceContent , set_SourceExtension , set_StructDecl , set_TemplateTypedefDecl , set_Type , set_TypedefDecl , set_UmlGetName , set_UmlSetName , set_UnionDecl , set_UseDefaults , set_VisibilityIndent , setName , setVisibility , sourceContent , sourceExtension , structDecl , templateTypedefDecl , type , typedefDecl , umlGetName , umlSetName , umlType , unionDecl , useDefaults , visibilityIndent