save_designs_as_json

abstractmethod DesignManager.save_designs_as_json(file_path: Path | str, hid: str = '0') → File

Save designs for a given state to JSON file.

Parameters:

file_pathUnion[Path, str]

Path to the file.

hidstr, optional

State/Design hierarchical id. Defaults to the “root” id (“0”).

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.