save_designs_as_json

ParametricSystem.save_designs_as_json(hid: str, file_path: Path | str) → File

Save designs for a given state to JSON file.

Parameters:

hidstr

Actor’s state.

file_pathUnion[Path, str]

Path to the file.

Returns:

File

Object representing saved file.

Raises:

OslCommunicationError

Raised when an error occurs while communicating with the server.

OslCommandError

Raised when a command or query fails.

TimeoutError

Raised when the timeout float value expires.

TypeError

Raised when the hid is None -or- file_path is None or unsupported type.

ValueError

Raised when hid does not exist.