PrgT_Progress_Update_Proc
Abstract
Callback: Notify the user of the progress of the shortest path calculation taking place.
Syntax
PrgT_Progress_Update_Proc (action_title, end_val, increment_val, action_type, client_state_ptr)
| Argument | Type | Description |
|---|---|---|
action_title |
const char * |
Name of the action to occur. |
end_val |
int |
Total span of the action that occurs. |
increment_val |
int |
Increment size of action progress. |
action_type |
PrgT_Action_Type |
Action that occurs during progress reporting (see action_type). |
client_state_ptr |
void * |
Arbitrary state pointer. |
Return Type
int
If the value returned is 1, the function aborted; otherwise it was successful.
Header
prg_djk.h
Details
This function is only called during prg_djk_all_sources_compute(). It updates the user on the progress of the shortest path computation. This function can either use a progress bar for visual updates, or can output update information to a file.
action_type
The possible values for action_type are:
PrgC_Action_StartPrgC_Action_Start_AbortablePrgC_Action_IncrementPrgC_Action_Change_EndPrgC_Action_End
This function is registered by prg_djk_update_proc_register().