CouplingInputFile¶
-
class
persalys.
CouplingInputFile
(*args)¶ Input file metadata for coupling.
- Parameters
- pathstr
Path to the template file.
See also
Notes
By default the configured path is the basename of the template path, minus the .in extension.
- Attributes
thisown
The membership flag
Methods
Accessor to the object’s name.
Template path accessor.
Variables format accessor.
getId
()Accessor to the object’s id.
getName
()Accessor to the object’s name.
getPath
()Template file path accessor.
Accessor to the object’s shadowed id.
Tokens accessor.
Variable names accessor.
Accessor to the object’s visibility state.
hasName
()Test if the object is named.
Test if the object has a distinguishable name.
setConfiguredPath
(configuredPath)Configured path accessor.
setName
(name)Accessor to the object’s name.
setPath
(templatePath)Template file path accessor.
setShadowedId
(id)Accessor to the object’s shadowed id.
setVariables
(variableNames, tokens, formats)Variables accessor.
setVisibility
(visible)Accessor to the object’s visibility state.
simulateInput
-
__init__
(*args)¶ Initialize self. See help(type(self)) for accurate signature.
-
getClassName
()¶ Accessor to the object’s name.
- Returns
- class_namestr
The object class name (object.__class__.__name__).
-
getConfiguredPath
()¶ Template path accessor.
- Returns
- configured_pathstr
Configured file path.
-
getFormats
()¶ Variables format accessor.
- Returns
- formats
openturns.Description
Input variables format
- formats
-
getId
()¶ Accessor to the object’s id.
- Returns
- idint
Internal unique identifier.
-
getName
()¶ Accessor to the object’s name.
- Returns
- namestr
The name of the object.
-
getPath
()¶ Template file path accessor.
- Returns
- pathstr
Path to the template file.
-
getShadowedId
()¶ Accessor to the object’s shadowed id.
- Returns
- idint
Internal unique identifier.
-
getTokens
()¶ Tokens accessor.
- Returns
- tokens
openturns.Description
Tokens for each variable
- tokens
-
getVariableNames
()¶ Variable names accessor.
- Returns
- variable_names
openturns.Description
Input variable names
- variable_names
-
getVisibility
()¶ Accessor to the object’s visibility state.
- Returns
- visiblebool
Visibility flag.
-
hasName
()¶ Test if the object is named.
- Returns
- hasNamebool
True if the name is not empty.
-
hasVisibleName
()¶ Test if the object has a distinguishable name.
- Returns
- hasVisibleNamebool
True if the name is not empty and not the default one.
-
setConfiguredPath
(configuredPath)¶ Configured path accessor.
- Parameters
- configured_pathstr
Configured file path, must be relative. It is interpreted as the path to the file with the actual input values relatively to the temporary working directory.
-
setName
(name)¶ Accessor to the object’s name.
- Parameters
- namestr
The name of the object.
-
setPath
(templatePath)¶ Template file path accessor.
- Parameters
- pathstr
Path to the template file.
-
setShadowedId
(id)¶ Accessor to the object’s shadowed id.
- Parameters
- idint
Internal unique identifier.
-
setVariables
(variableNames, tokens, formats)¶ Variables accessor.
- Parameters
- namessequence of str
Variable names
- tokenssequence of str
Tokens used for replacement in the template file.
- formatssequence of str
Variable numerical formats
-
setVisibility
(visible)¶ Accessor to the object’s visibility state.
- Parameters
- visiblebool
Visibility flag.
-
property
thisown
¶ The membership flag