Anark Core SDK
Loading...
Searching...
No Matches
Anark.CoreSdkApi.SdkProgressTracker Class Reference

More...

Inheritance diagram for Anark.CoreSdkApi.SdkProgressTracker:
Anark.CoreSdkApi.ISdkProgressTracker

Public Member Functions

 SdkProgressTracker (ProgressTracker progressTracker)
 Initialize a new progress tracker.
void Init (long numberOfItems)
 Use this to tell the progress tracker how much work is anticipated.
Parameters
numberOfItemsThe number of items to be processed.

void FinishedItem ()
 Call this each time an item is processed.
void SetNumberOfItemsFinished (long numFinished)
 Use this only for random access scenarios such as when progress could move backward.
void SetStatus (string value)
 Set a status message to indicate to the user what is occurring.
Parameters
valueThe status message.

Detailed Description

Constructor & Destructor Documentation

◆ SdkProgressTracker()

Anark.CoreSdkApi.SdkProgressTracker.SdkProgressTracker ( ProgressTracker progressTracker)
inline

Initialize a new progress tracker.

Parameters
progressTrackerInternal Anark Core progress tracker.

Member Function Documentation

◆ FinishedItem()

void Anark.CoreSdkApi.SdkProgressTracker.FinishedItem ( )
inline

Call this each time an item is processed.

Implements Anark.CoreSdkApi.ISdkProgressTracker.

◆ Init()

void Anark.CoreSdkApi.SdkProgressTracker.Init ( long numberOfItems)
inline

Use this to tell the progress tracker how much work is anticipated.

Parameters
numberOfItemsThe number of items to be processed.

Implements Anark.CoreSdkApi.ISdkProgressTracker.

◆ SetNumberOfItemsFinished()

void Anark.CoreSdkApi.SdkProgressTracker.SetNumberOfItemsFinished ( long numFinished)
inline

Use this only for random access scenarios such as when progress could move backward.

Implements Anark.CoreSdkApi.ISdkProgressTracker.

◆ SetStatus()

void Anark.CoreSdkApi.SdkProgressTracker.SetStatus ( string value)
inline

Set a status message to indicate to the user what is occurring.

Parameters
valueThe status message.

Implements Anark.CoreSdkApi.ISdkProgressTracker.