ITGIS_BusyEventManager interface

DK for ActiveX | TatukGIS_XDK11.ITGIS_BusyEventManager | Interfaces | Methods | Properties

Class useful for progress implementation in single or multistage algorithms.

Available also on: Delphi | .NET | Java | ActiveX | Python.

// C#
public interface ITGIS_BusyEventManager: ITBaseObject
{
}

' VisualBasic
Public Interface ITGIS_BusyEventManager
  Implements ITBaseObject
End Class

// Oxygene
type
  ITGIS_BusyEventManager = public interface( ITBaseObject )
  end;

ITBaseObject

Below you can find the Python example.

from time import sleep
import tatukgis_pdk as pdk
from typing import Any
 
 
def do_busy_event(sender: Any, position: int, end_value: int, abort: bool):
    busy_manager: pdk.TGIS_BusyEventManager = sender
    if position == -1:
        return
 
    # show first stage process details
    print(f"Global position: {position} / {end_value}")
    print(f"Estimated time left: {busy_manager.EstimatedTimeLeft(0)/1000} s.")
    print(f"\t{busy_manager.Name(0)}")
    print(f"\tLocal position: {busy_manager.Position(0)} / {busy_manager.EndValue(0)}")
 
    # show second stage process details
    if busy_manager.Count == 2:
        print(f"\t\t{busy_manager.Name(1)}")
        print(f"\t\tLocal position: {busy_manager.Position(1)} / {busy_manager.EndValue(1)}")
 
    # 'abort' can be used to abort the current process
    abort = False
 
 
event_manager = pdk.TGIS_BusyEventManager(None)
 
# a busy event will be triggered every time the PushEvent() method is called
event_manager.UseProgressThreshold = False
 
# assign a callback function to track the progress
event_manager.BusyEvent = do_busy_event
 
# start a first stage of the progress
event_manager.StartEvent("LEVEL 1", 100, event_manager)
try:
    for i in range(99):
        sleep(0.2)
        event_manager.PushEvent()
 
    # start a second stage at the last iteration of the first stage
    event_manager.StartEvent("LEVEL 2", 10, event_manager)
    try:
        for j in range (10):
            # PushEvent method can change the current stage name
            event_manager.PushEvent(f"LEVEL 2 - stage: {j}")
    finally:
        # end stage 2
        event_manager.EndEvent()
finally:
    # end stage 1
    event_manager.EndEvent()