get_project_description

TcpOslServer.get_project_description() → str | None

Get description of optiSLang project.

Returns:

Optional[str]

optiSLang project description. If no project is loaded in the optiSLang, returns 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.

Deprecated since version 0.6.0: This functionality was moved to Project.