PyANGKernel.GKTask¶

class GKTask¶

A class for tasks

Details

These tasks are used by Aimsun operations to give the user feedback on the amount of time required to complete the task. It allows also the cancel of such task.

The user will create a new task using the createTask . From this method the developer will set the label of the task (File Loading for example), the number of steps to complete the task (the simulation steps, the length of a file in kilobytes,…), the minimum step to refresh the task or the time between updates, if the task can be cancelled (if not the Cancel button will not appear) and if the dialog will process events (if it will refresh the GUI).

To start a task the developer has to call start() .

The current implementation refreshes the GUI each stepsToUpdate or timeToUpdate depending on what the user set.

After creating the dialog the developer must call stepTask to inform the dialog that the step N has been done. This method will return true if the task has been cancelled.

When a task is complete the developer has to call GKTask::end().

Example:

GKModel                         *model;
GTask                           *task;
uint                            i;
bool                            cancelled = false;

task = GKSystem::getSystem().createTask();
task->setName( tr( "Doing 10 Steps" ) );
task->setTotalSteps( 10 );
task->start();

for( i = 0; cancelled == false && i < 10; i++ ){
        // do something that requires some time...
        cancelled = task->stepTask( i );
}

task->end();

Synopsis¶

Methods¶

def __init__()
def addAlwaysEditableType()
def addSubTask()
def allowUserInput()
def cancel()
def disableModelEdition()
def end()
def failed()
def getCancelable()
def getErrorMessage()
def getExecutionInfo()
def getInteractiveTime()
def getInterativeExtension()
def getInternalName()
def getIsMultiTask()
def getMode()
def getModelUID()
def getName()
def getShowExtensionOnClose()
def getSingleDay()
def getStartTime()
def getState()
def getStepsDone()
def getSubTasks()
def getTargetId()
def getTimeUpdate()
def getTotalSteps()
def getUID()
def getUUID()
def isEditionAllowed()
def isInternal()
def isQuick()
def multiTaskEnd()
def multiTaskStart()
def refresh()
def secondToFinish()
def setAllowUserInput()
def setCancelable()
def setExecutionInfo()
def setInteractiveTime()
def setInteractiveWidget()
def setInternal()
def setInternalName()
def setIsMultiTask()
def setMode()
def setModelUID()
def setName()
def setParent()
def setQuick()
def setShowExtensionOnClose()
def setSingleDay()
def setStartTime()
def setState()
def setStepsUpdate()
def setSubTasks()
def setTargetId()
def setTimeUpdate()
def setTotalSteps()
def start()
def statsInterval()
def stepTask()
def stop()
def taskTime()
def wasCancelled()
def wasStopped()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

class Mode¶: The task mode: - eModal: No other task can be done. Update GUI (if available) from time to time. This is the default one. - eSemiInteractive: Other task can be started (if possible). Update GUI on every step - eInteractive: A task that can be controlled by the user. Update GUI on every step.

class Storable¶

__init__(_modelUID[, uid=""])¶

Parameters:

_modelUID – QUuid
uid – str

Creates a task that will perform work on the given model

addAlwaysEditableType(type)¶

Parameters:: type – GKType

Adds a GKType exception to model edition

addSubTask(iModel)¶

Parameters:: iModel – GKModel
Return type:: GKTask

Add sub task

allowUserInput()¶

Return type:: bool

Returns true if user input should be processed during the ui update. true by default.

See also

setAllowUserInput()

cancel()¶

Cancels the task if it can be canceled

disableModelEdition()¶

Marks this task as one whose execution forbids modifications on existing objects

end([store=GKTask.Storable.eDoStore])¶

Parameters:: store – Storable

failed(errorMsg)¶

Parameters:: errorMsg – str

Mark this task as failed

getCancelable()¶

Return type:: bool

Gets if the task can be canceled or not

getErrorMessage()¶

Return type:: str

If the task failed, the reason as set when calling failed

getExecutionInfo()¶

Return type:: str

Gets the execution info of the task.

getInteractiveTime()¶

Return type:: QDateTime

In an interactive task, the time in where the task is. For example, for Aimsun Next Micro the simulation time.

getInterativeExtension()¶

Return type:: QDialog

The extension widget that will control the task.

getInternalName()¶

Return type:: str

The internal (cannot be translated) name of the task

getIsMultiTask()¶

Return type:: bool

getMode()¶

Return type:: Mode

The task mode.

See also

Mode

getModelUID()¶

Return type:: QUuid

Returns the UID of the model that creates this task or a empty string for system tasks

getName()¶

Return type:: str

Gets the name of the task

getShowExtensionOnClose()¶

Return type:: bool

Returns the value set with setShowExtensionOnClose .

getSingleDay()¶

Return type:: bool

UnknownCommand setSingleDay

getStartTime()¶

Return type:: QDateTime

When this task was started.

getState()¶

Return type:: str

Gets the state of the task.

getStepsDone()¶

Return type:: int

Steps done in this task

getSubTasks()¶

Return type:: .list of QString

Get the sub task ids of this task

getTargetId()¶

Return type:: int

The target id. The target id the object in where we are doing the task.

getTimeUpdate()¶

Return type:: float

getTotalSteps()¶

Return type:: int

Gets the number of steps the task is divided in

getUID()¶

Return type:: str

getUUID()¶

Return type:: str

Returns the unique identifier of this task (generated using QUuid::createUuid())

isEditionAllowed(type)¶

Parameters:: type – GKType
Return type:: bool

Indicates if objects can be modified while this task is active

isInternal()¶

Return type:: bool

Don’t notify this task to external apps

isQuick()¶

Return type:: bool

Returns true if the task is quick. UnknownCommand setQuick

multiTaskEnd()¶

multiTaskStart()¶

percentageDone(percentage)¶

Parameters:: percentage – int

refresh()¶

Emit a stepDone witg update = true to refresh the status (in the GUI)

secondToFinish()¶

Return type:: int

Seconds required to finish this task (a guess). Returns -1 if it cannot guess because no times have been given in stepTask or because too few steps have been done

setAllowUserInput(allow)¶

Parameters:: allow – bool

Configures if on the ui update the user inputs should be allowed or ignored.

See also

allowUserInput()

setCancelable(cancelable)¶

Parameters:: cancelable – bool

Sets if the task can be canceled or not. Tasks are cancelable by default.

setExecutionInfo(info)¶

Parameters:: info – str

Sets extra execution info for this task. It is task dependand but usually has information related a simulation (iterations info, vehs in/out…) in JSON format.

setInteractiveTime(dt)¶

Parameters:: dt – QDateTime

In an interactive task, the time in where the task is. For example, for Aimsun Next Micro the simulation time.

setInteractiveWidget(extension)¶

Parameters:: extension – QDialog

Mark this task as interactive as set the widget that wil control it.

setInternal()¶

Don’t notify this task to external apps

See also

isInternal()

setInternalName(aname)¶

Parameters:: aname – str

The internal (cannot be translated) name of the task

setIsMultiTask(isMultiTask)¶

Parameters:: isMultiTask – bool

setMode(mode)¶

Parameters:: mode – Mode

The task mode.

See also

Mode

setModelUID(uid)¶

Parameters:: uid – QUuid

Set the model uid (if not set in the GKTask constructor)

setName(aname)¶

Parameters:: aname – str

Sets the name of the task.

setParent(uuid)¶

Parameters:: uuid – str

Parent task, if this is a subtask

See also

parent()

setQuick(isQuick)¶

Parameters:: isQuick – bool

Sets the task as quick (needn’t a long-time process).

Note

Setting the task as quick won’t make it faster to process ! it will just let know other objects (f.ex, the UI) that this task is likely to be processed very fast, quick.