Class InstantTerra

class instant_terra.InstantTerra (show_UI = True, timeout = 3)

This class represents an InstantTerra instance.
show_UI: shows or hides Instant Terra's window. Default value: true.
timeout: Integer value, in number of seconds. When Instant Terra does not answer after a given duration, the connection stops automatically. The default value is 3, for 3 seconds. Set a higher value if you encounter connection issues.

>>> from wysilab import InstantTerra
>>> it = InstantTerra()  # Start the instance

InstantTerra.close()

Close the instance.

>>> it = InstantTerra()  # Start the instance
>>> it.close()           # Close the instance

InstantTerra.is_instance_initialized()

Returns

True if the instance is initialized, otherwise False.

Return type

bool

>>> it = InstantTerra()
>>> it.is_instance_initialized()
True

InstantTerra.version()

Returns

The version of Instant Terra, for instance "1.12.0.11397"

Return type

string

>>> it = InstantTerra()
>>> version = it.version

InstantTerra.project

Type

Project

Raises

ValueError : Impossible to override this attribute.

Access to the project.

>>> project = it.project