CouplingInputFile

class persalys.CouplingInputFile(*args)

Input file metadata for coupling.

Parameters

pathstr

Path to the template file.

See also

CouplingStep, CouplingResourceFile, CouplingOutputFile

Notes

By default the configured path is the basename of the template path, minus the .in extension.

Methods

getClassName(self)	Accessor to the object’s name.
getConfiguredPath(self)	Template path accessor.
getFormats(self)	Variables format accessor.
getId(self)	Accessor to the object’s id.
getName(self)	Accessor to the object’s name.
getPath(self)	Template file path accessor.
getShadowedId(self)	Accessor to the object’s shadowed id.
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.
setConfiguredPath(self, configuredPath)	Configured path accessor.
setName(self, name)	Accessor to the object’s name.
setPath(self, templatePath)	Template file 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.

simulateInput

__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__).

getConfiguredPath(self)

Template path accessor.

Returns

configured_pathstr

Configured file path.

getFormats(self)

Variables format accessor.

Returns

formatsopenturns.Description

Input variables format

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)

Template file path accessor.

Returns

pathstr

Path to the template file.

getShadowedId(self)

Accessor to the object’s shadowed id.

Returns

idint

Internal unique identifier.

getTokens(self)

Tokens accessor.

Returns

tokensopenturns.Description

Tokens for each variable

getVariableNames(self)

Variable names accessor.

Returns

variable_namesopenturns.Description

Input 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.

setConfiguredPath(self, 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(self, name)

Accessor to the object’s name.

Parameters

namestr

The name of the object.

setPath(self, templatePath)

Template file path accessor.

Parameters

pathstr

Path to the template file.

setShadowedId(self, id)

Accessor to the object’s shadowed id.

Parameters

idint

Internal unique identifier.

setVariables(self, 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(self, visible)

Accessor to the object’s visibility state.

Parameters

visiblebool

Visibility flag.