open

TcpOslServer.open(file_path: str | Path, force: bool = True, restore: bool = False, reset: bool = False, project_properties_file: str | None = None) → None

Open a new project.

Parameters:

file_pathUnion[str, pathlib.Path]

Path to the optiSLang project file to open.

forcebool, optional

Whether to force opening of project even if (non-critical) errors occur. Non-critical errors include: - Timestamp of (auto) save point newer than project timestamp - Project (file) incomplete

restorebool, optional

Whether to restore project from last (auto) save point (if present).

resetbool, optional

Whether to reset project after load.

project_properties_fileOptional[str], optional

Project properties file to import, by default None.

Raises:

OslCommunicationError

Raised when an error occurs while communicating with server.

OslCommandError

Raised when the command or query fails.

TimeoutError

Raised when the timeout float value expires.