save_designs_as

abstract RootSystem.save_designs_as(hid: str, file_name: str, format: FileOutputFormat = FileOutputFormat.JSON, dir: Path | str | None = None) → File

Save designs for a given state.

Parameters:

hidstr

Actor’s state.

file_namestr

Name of the file.

formatFileOutputFormat, optional

Format of the file, by default FileOutputFormat.JSON.

dirOptional[Union[Path, str]], optional

Directory, where file should be saved, by default None. Project’s working directory is used by default.

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 incorrect type of dir is passed.

ValueError

Raised when unsupported value of format or non-existing hid is passed.