get_description

abstractmethod Project.get_description() → str | None

Get the description of the optiSLang project.

Returns:

Optional[str]

Description of the optiSLang project. If no project is loaded in optiSLang, None is returned.

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.