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

CouplingStep, CouplingInputFile, CouplingResourceFile

Attributes

thisown

The membership flag

Methods

getClassName()	Accessor to the object’s name.
getId()	Accessor to the object’s id.
getName()	Accessor to the object’s name.
getPath()	Path accessor.
getShadowedId()	Accessor to the object’s shadowed id.
getSkipColumns()	Skip columns accessor.
getSkipLines()	Skip lines accessor.
getTokens()	Tokens accessor.
getVariableNames()	Variable names accessor.
getVisibility()	Accessor to the object’s visibility state.
hasName()	Test if the object is named.
hasVisibleName()	Test if the object has a distinguishable name.
setName(name)	Accessor to the object’s name.
setPath(path)	Path accessor.
setShadowedId(id)	Accessor to the object’s shadowed id.
setVariables(variableNames, tokens, …)	Variables accessor.
setVisibility(visible)	Accessor to the object’s visibility state.

checkOutputFile
getSkipTokens

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

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()

Path accessor.

Returns

pathstr

Path

getShadowedId()

Accessor to the object’s shadowed id.

Returns

idint

Internal unique identifier.

getSkipColumns()

Skip columns accessor.

Returns

skip_columnsopenturns.Point

Number of columns skipped for each variable

getSkipLines()

Skip lines accessor.

Returns

skip_linesopenturns.Point

Number of lines skipped for each variable

getTokens()

Tokens accessor.

Returns

tokensopenturns.Description

Tokens for each variable

getVariableNames()

Variable names accessor.

Returns

variable_namesopenturns.Description

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

setName(name)

Accessor to the object’s name.

Parameters

namestr

The name of the object.

setPath(path)

Path accessor.

Parameters

pathstr

Path to the output file, must be relative.

setShadowedId(id)

Accessor to the object’s shadowed id.

Parameters

idint

Internal unique identifier.

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

Accessor to the object’s visibility state.

Parameters

visiblebool

Visibility flag.

property thisown

The membership flag