CouplingOutputFile¶
-
class
persalys.CouplingOutputFile(*args)¶ Output file metadata for coupling.
- Parameters
- pathstr
Path to the output file. It must be must be relative, and is joined to the temporary working directory.
See also
Methods
getClassName(self)Accessor to the object’s name.
getId(self)Accessor to the object’s id.
getName(self)Accessor to the object’s name.
getPath(self)Path accessor.
getShadowedId(self)Accessor to the object’s shadowed id.
getSkipColumns(self)Skip columns accessor.
getSkipLines(self)Skip lines accessor.
getTokens(self)Tokens accessor.
getVariableNames(self)Variable names accessor.
getVisibility(self)Accessor to the object’s visibility state.
hasName(self)Test if the object is named.
hasVisibleName(self)Test if the object has a distinguishable name.
setName(self, name)Accessor to the object’s name.
setPath(self, path)Path accessor.
setShadowedId(self, id)Accessor to the object’s shadowed id.
setVariables(self, variableNames, tokens, …)Variables accessor.
setVisibility(self, visible)Accessor to the object’s visibility state.
checkOutputFile
getSkipTokens
-
__init__(self, *args)¶ Initialize self. See help(type(self)) for accurate signature.
-
getClassName(self)¶ Accessor to the object’s name.
- Returns
- class_namestr
The object class name (object.__class__.__name__).
-
getId(self)¶ Accessor to the object’s id.
- Returns
- idint
Internal unique identifier.
-
getName(self)¶ Accessor to the object’s name.
- Returns
- namestr
The name of the object.
-
getPath(self)¶ Path accessor.
- Returns
- pathstr
Path
-
getShadowedId(self)¶ Accessor to the object’s shadowed id.
- Returns
- idint
Internal unique identifier.
-
getSkipColumns(self)¶ Skip columns accessor.
- Returns
- skip_columns
openturns.Point Number of columns skipped for each variable
- skip_columns
-
getSkipLines(self)¶ Skip lines accessor.
- Returns
- skip_lines
openturns.Point Number of lines skipped for each variable
- skip_lines
-
getTokens(self)¶ Tokens accessor.
- Returns
- tokens
openturns.Description Tokens for each variable
- tokens
-
getVariableNames(self)¶ Variable names accessor.
- Returns
- variable_names
openturns.Description Output variable names
- variable_names
-
getVisibility(self)¶ Accessor to the object’s visibility state.
- Returns
- visiblebool
Visibility flag.
-
hasName(self)¶ Test if the object is named.
- Returns
- hasNamebool
True if the name is not empty.
-
hasVisibleName(self)¶ Test if the object has a distinguishable name.
- Returns
- hasVisibleNamebool
True if the name is not empty and not the default one.
-
setName(self, name)¶ Accessor to the object’s name.
- Parameters
- namestr
The name of the object.
-
setPath(self, path)¶ Path accessor.
- Parameters
- pathstr
Path to the output file, must be relative.
-
setShadowedId(self, id)¶ Accessor to the object’s shadowed id.
- Parameters
- idint
Internal unique identifier.
-
setVariables(self, variableNames, tokens, skipTokens, skipLines, skipColumns)¶ Variables accessor.
- Parameters
- namessequence of str
Variable names
- tokenssequence of str
Tokens used for reading in the output file for each variable.
- skip_linessequence of int
Number of lines skipped for each variable.
- skip_columnssequence of int
Number of columnes skipped for each variable.
-
setVisibility(self, visible)¶ Accessor to the object’s visibility state.
- Parameters
- visiblebool
Visibility flag.
