Interface IOptimizationProgress

All Superinterfaces:

IOptimizationOutcome, Serializable

All Known Implementing Classes:

OptimizationProgress

public interface IOptimizationProgress
extends IOptimizationOutcome

This interfaces provides a way of accessing the current progress.

Since:

19/11/2018

Version:

03/08/2019

Author:

DNA

Method Summary

Modifier and Type	Method	Description
String	getCallerId()	Gets the OptimizationProgress.callerId.
int	getOptimizationStage()	Gets the OptimizationProgress.optimizationStage, the default value is 0.
double	getProgress()	Gets the OptimizationProgress.currentProgress, the default value is 0.0.
String	getProgressString()	Gets the OptimizationProgress.progressString.

Methods inherited from interface IOptimizationOutcome

getJobCost, getJobElementCount, getJobIdleTimeSeconds, getJobNodesCount, getJobPillarsCount, getJobProductiveTimeSeconds, getJobRelationshipCost, getJobResourceCount, getJobRouteCount, getJobSpecificViolationSummary, getJobTerminationTransitionDistanceMeter, getJobTerminationTransitionTimeSeconds, getJobTimeSeconds, getJobTransitionDistanceMeter, getJobTransitionTimeSeconds, getJobUnScheduledRoutesCount, getJobUtilizationPercent, getJobViolations, getJoinedViolationSummary, getOptimizationIdent, getResourceId, getResourceWorkingHours, getResultEntity, getRouteCost, getRouteId, getRouteIdleTimeSeconds, getRouteProductiveTimeSeconds, getRoutes, getRouteStartId, getRouteTerminationId, getRouteTerminationTransitionDistanceMeter, getRouteTerminationTransitionTimeSeconds, getRouteTimeSeconds, getRouteTransitionDistanceMeter, getRouteTransitionTimeSeconds, getRouteUtilizationPercent, getRouteViolations, getRouteViolationSummaries, getRouteViolationSummary, getUnassignedNodes

Method Details

getCallerId

String getCallerId()

Gets the OptimizationProgress.callerId.

Returns:

the callerId

getProgress

double getProgress()

Gets the OptimizationProgress.currentProgress, the default value is 0.0.

Returns:

the current progress

getOptimizationStage

int getOptimizationStage()

Gets the OptimizationProgress.optimizationStage, the default value is 0.

Returns:

the optimizationStage

getProgressString

String getProgressString()

Gets the OptimizationProgress.progressString.

Returns:

the progressString