com.dna.jopt.framework.outcomewrapper

Class OptimizationProgress

java.lang.Object

com.dna.jopt.framework.outcomewrapper.AbstractOptimizationOutcome

com.dna.jopt.framework.outcomewrapper.OptimizationProgress

All Implemented Interfaces:

IOptimizationOutcome, IOptimizationProgress, Serializable

public class OptimizationProgress
extends AbstractOptimizationOutcome
implements IOptimizationProgress

A way of accessing the current progress.

Since:

03/08/2019

Version:

03/08/2019

Author:

DNA

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OptimizationProgress(IEntity resultEntity, IOptimization optimization, String callerId, double currentProgress, String progressString)

Method Summary

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

Methods inherited from class com.dna.jopt.framework.outcomewrapper.AbstractOptimizationOutcome

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.dna.jopt.framework.outcomewrapper.IOptimizationOutcome

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

Constructor Detail

OptimizationProgress

public OptimizationProgress(IEntity resultEntity,
                            IOptimization optimization,
                            String callerId,
                            double currentProgress,
                            String progressString)

Method Detail

getCallerId

public String getCallerId()

Description copied from interface: IOptimizationProgress

Gets the callerId.

Specified by:

getCallerId in interface IOptimizationProgress

Returns:

the callerId

getOptimizatioIdent

public String getOptimizatioIdent()

Specified by:

getOptimizatioIdent in interface IOptimizationProgress

getProgress

public double getProgress()

Description copied from interface: IOptimizationProgress

Gets the currentProgress, the default value is 0.0.

Specified by:

getProgress in interface IOptimizationProgress

Returns:

the current progress

getOptimizationStage

public int getOptimizationStage()

Description copied from interface: IOptimizationProgress

Gets the optimizationStage, the default value is 0.

Specified by:

getOptimizationStage in interface IOptimizationProgress

Returns:

the optimizationStage

getProgressString

public String getProgressString()

Description copied from interface: IOptimizationProgress

Gets the progressString.

Specified by:

getProgressString in interface IOptimizationProgress

Returns:

the progressString