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

See also

CouplingPhysicalModel, CouplingInputFile, CouplingResourceFile, CouplingOutputFile

Methods

getClassName()	Accessor to the object's name.
getCommand()	Path accessor.
getEnvironmentKeys()	Environment variables names accessor.
getEnvironmentValues()	Environment variables values accessor.
getId()	Accessor to the object's id.
getInputFiles()	Template path accessor.
getIsShell()	Shell command property accessor.
getName()	Accessor to the object's name.
getOutputFiles()	Variable names accessor.
getResourceFiles()	Template path accessor.
getShadowedId()	Accessor to the object's shadowed id.
getVisibility()	Accessor to the object's visibility state.
hasName()	Test if the object is named.
hasVisibleName()	Test if the object has a distinguishable name.
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.
setShadowedId(id)	Accessor to the object's shadowed id.
setVisibility(visible)	Accessor to the object's visibility state.

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:

pathopenturns.Description

Path

getEnvironmentKeys()

Environment variables names accessor.

Returns:

keysopenturns.Description

Dictionary keys matching environment variables name

getEnvironmentValues()

Environment variables values accessor.

Returns:

valuesopenturns.Description

Dictionary valuess matching environment variables values

getId()

Accessor to the object’s id.

Returns:

idint

Internal unique identifier.

getInputFiles()

Template path accessor.

Returns:

input_filessequence of CouplingInputFile

Input file metadatas

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

getResourceFiles()

Template path accessor.

Returns:

resource_filessequence of CouplingResourceFile

Resource file metadatas

getShadowedId()

Accessor to the object’s shadowed id.

Returns:

idint

Internal unique identifier.

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.

setCommand(command)

Path accessor.

Parameters:

pathstr

Path

setEnvironment(keys, values)

Environment dictionary accessor.

Parameters:

keysopenturns.Description

Dictionary keys matching environment variables names

valuesopenturns.Description

Dictionary values matching environment variables values

setInputFiles(inputFiles)

Tokens accessor.

Parameters:

input_filessequence of CouplingInputFile

Input file metadatas

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

setResourceFiles(inputFiles)

Tokens accessor.

Parameters:

resource_filessequence of CouplingResourceFile

Resource file metadatas

setShadowedId(id)

Accessor to the object’s shadowed id.

Parameters:

idint

Internal unique identifier.

setVisibility(visible)

Accessor to the object’s visibility state.

Parameters:

visiblebool

Visibility flag.