pytuflow.TCFRunState.output_folder_2d

pytuflow.TCFRunState.output_folder_2d#

TCFRunState.output_folder_2d(context=None)#

Returns the 2D output folder.

Returns the last instance of the command. If multiple versions of the output folder command exist and some exist in IF logic blocks, a context must be provided to resolve the correct one.

Returns the file path to the tcf file directory if the output folder command is not found.

Parameters:

context (Context, optional) – A context object to resolve the correct 2D output directory. Not required unless more than one 1D output directory exists.

Returns:

The 2D output directory.

Return type:

Path

Raises:

ValueError – If the output folder cannot be determined.

Examples

>>> tcf = ... # assuming is an instance of TCF
>>> tcf.output_folder_2d()
WindowsPath('../results/EG15')
Contents