CouplingStep¶
- class persalys.CouplingStep(*args)¶
Coupling step.
Represents one step of the coupling with one command to execute and the associated input or output files.
- Parameters
- commandstr
Command to execute By default it is run by the system else see
setIsShell().- input_filessequence of
CouplingInputFile Input file metadatas
- resource_filessequence of
CouplingResourceFile Resource file metadatas
- output_filessequence of
CouplingOutputFile Output file metadatas
Methods
Accessor to the object's name.
Path accessor.
Environment variables names accessor.
Environment variables values accessor.
Template path accessor.
Shell command property accessor.
getName()Accessor to the object's name.
Variable names accessor.
Template path accessor.
hasName()Test if the object is named.
setCommand(command)Path accessor.
setEnvironment(keys, values)Environment dictionary accessor.
setInputFiles(inputFiles)Tokens accessor.
setIsShell(isShell)Shell command property accessor.
setName(name)Accessor to the object's name.
setOutputFiles(outputFiles)Variable names accessor.
setResourceFiles(inputFiles)Tokens accessor.
getCode
getEncoding
getEscapedCode
getPPInputs
getPPOutputs
getTimeOut
setCode
setEncoding
setTimeOut
- __init__(*args)¶
- getClassName()¶
Accessor to the object’s name.
- Returns
- class_namestr
The object class name (object.__class__.__name__).
- getCommand()¶
Path accessor.
- Returns
- path
openturns.Description Path
- path
- getEnvironmentKeys()¶
Environment variables names accessor.
- Returns
- keys
openturns.Description Dictionary keys matching environment variables name
- keys
- getEnvironmentValues()¶
Environment variables values accessor.
- Returns
- values
openturns.Description Dictionary valuess matching environment variables values
- values
- getInputFiles()¶
Template path accessor.
- Returns
- input_filessequence of
CouplingInputFile Input file metadatas
- input_filessequence of
- getIsShell()¶
Shell command property accessor.
- Returns
- is_shellbool
Whether the command should be interpreted by the shell
- getName()¶
Accessor to the object’s name.
- Returns
- namestr
The name of the object.
- getOutputFiles()¶
Variable names accessor.
- Returns
- output_filessequence of
CouplingOutputFile Output file metadatas
- output_filessequence of
- getResourceFiles()¶
Template path accessor.
- Returns
- resource_filessequence of
CouplingResourceFile Resource file metadatas
- resource_filessequence of
- hasName()¶
Test if the object is named.
- Returns
- hasNamebool
True if the name is not empty.
- setCommand(command)¶
Path accessor.
- Parameters
- pathstr
Path
- setEnvironment(keys, values)¶
Environment dictionary accessor.
- Parameters
- keys
openturns.Description Dictionary keys matching environment variables names
- values
openturns.Description Dictionary values matching environment variables values
- keys
- setInputFiles(inputFiles)¶
Tokens accessor.
- Parameters
- input_filessequence of
CouplingInputFile Input file metadatas
- input_filessequence of
- setIsShell(isShell)¶
Shell command property accessor.
- Parameters
- is_shellbool
Whether the command should be interpreted by the shell
- setName(name)¶
Accessor to the object’s name.
- Parameters
- namestr
The name of the object.
- setOutputFiles(outputFiles)¶
Variable names accessor.
- Parameters
- output_filessequence of
CouplingOutputFile Output file metadatas
- output_filessequence of
- setResourceFiles(inputFiles)¶
Tokens accessor.
- Parameters
- resource_filessequence of
CouplingResourceFile Resource file metadatas
- resource_filessequence of
