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.

Methods

getClassName()	Accessor to the object's name.
getName()	Accessor to the object's name.
getPath()	Path accessor.
getSkipColumns()	Skip columns accessor.
getSkipLines()	Skip lines accessor.
getTokens()	Tokens accessor.
getVariableNames()	Variable names accessor.
hasName()	Test if the object is named.
setName(name)	Accessor to the object's name.
setPath(path)	Path accessor.
setVariables(variableNames, tokens, ...)	Variables accessor.

checkOutputFile
getSkipTokens

See also

CouplingStep, CouplingInputFile, CouplingResourceFile

__init__(*args)

getClassName()

Accessor to the object’s name.

Returns:

class_namestr

The object class name (object.__class__.__name__).

getName()

Accessor to the object’s name.

Returns:

namestr

The name of the object.

getPath()

Path accessor.

Returns:

pathstr

Path

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

hasName()

Test if the object is named.

Returns:

hasNamebool

True if the name is not empty.

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.

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.