UserDefinedDynamicsResultModel

class UserDefinedDynamicsResultModel

Bases: NamedResultsCollectionModel

Model for handling results of user-defined dynamics.

Inherits from NamedResultsCollectionModel.

Attributes

local_file_name: str

Default:

None

do_download: bool, optional

Default:

None

local_storage: str, optional

Default:

None

get_download_file_list_method: Callable, optional

Default:

<function NamedResultsCollectionModel.<lambda> at 0x75cbd36e5a20>

Properties

udd_names

Get the list of user-defined dynamics names.

Returns:

List of user-defined dynamics names.

Return type:

list of str

names: List[str]

Get the list of result names.

Returns:

List of result names.

Return type:

list of str

Methods

get_udd_by_name(name)

Get user-defined dynamics by name.

Parameters:

name (str) – The name of the user-defined dynamics.

Returns:

The UserDefinedDynamicsCSVModel corresponding to the given name.

Return type:

UserDefinedDynamicsCSVModel

Raises:

Flow360ValueError – If the user-defined dynamics with the provided name is not found.

get_result_by_name(name)

Get a result by name.

Parameters:

name (str) – The name of the result.

Returns:

The result model corresponding to the given name.

Return type:

ResultCSVModel

Raises:

Flow360ValueError – If the result with the provided name is not found.

download(to_folder='.', overwrite=False)

Download all result files to the specified location.

Parameters:

• to_folder (str, optional) – The folder where the files will be downloaded.

• overwrite (bool, optional) – Flag indicating whether to overwrite existing files.