com.dna.jopt.member.bucket.route.controller.detail

Class LogicRouteElementDetailItem

java.lang.Object

com.dna.jopt.member.bucket.route.controller.detail.LogicRouteElementDetailItem

All Implemented Interfaces:

ILogicRouteElementDetailItem, Serializable, Cloneable

public class LogicRouteElementDetailItem
extends Object
implements ILogicRouteElementDetailItem

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.dna.jopt.member.bucket.route.controller.detail.ILogicRouteElementDetailItem

ILogicRouteElementDetailItem.ScheduleStatus

Constructor Summary

Constructors

Constructor and Description
LogicRouteElementDetailItem(IOptimizationElement node, long arrivalTime, long departureTime, long transitionTime, long idleTime, boolean isUnlocatedIdleTime, long whiteSpaceIdleTime, long durationTime, double distance2prevElement, long earlyDeviationMillis, long lateDeviationMillis, int choosenOpeningHoursIndex, int choosenWorkingHoursIndex, String visitorId, ILogicRouteElementDetailItem.ScheduleStatus status, double[] loadChange, double[] curCapacity, INodeDepot depotBeforeVisit, INodeDepot depotAfterVisit, com.dna.jopt.config.types.Position effectivePosition)
LogicRouteElementDetailItem(ZoneId zoneId, long arrivalTime, long departureTime, long transitionTime, long idleTime, boolean isUnlocatedIdleTime, long whiteSpaceIdleTime, long durationTime, double distance2prevElement, long earlyDeviationMillis, long lateDeviationMillis, int chosenOpeningHoursIndex, int chosenWorkingHoursIndex, String visitorId, ILogicRouteElementDetailItem.ScheduleStatus status, double[] curCapacity)

Method Summary

Modifier and Type	Method and Description
static ZoneId	extractZoneId(IOptimizationElement node)
long	getArrivalTime() Gets the arrival time of the Resource at the Node in milliseconds since UNIX timestamp.
int	getChosenOpeningHoursIndex() Gets the index of the OpeningHours from the Node.
int	getChosenWorkingHoursIndex() Gets the index of the WorkingHours of the Resource.
long	getDepartureTime()
long	getDepatureTime() Deprecated.
long	getDurationTime() Gets the duration between the last location of the Resource to the specific Node in milliseconds.
long	getEarlyDeviation() Gets the earlyDeviationMillis in milliseconds.
com.dna.jopt.config.types.Position	getEffectivePosition()
IOptimizationElement	getElement() Gets the Node.
long	getIdleTime() Gets the idle time that a Resource had to wait since it arrived prior to the OpeningHours of the Node in milliseconds.
long	getLateDeviation() Gets the lateDeviationMillis in milliseconds.
double[]	getLoadChange() Gets the load change.
Optional<INodeDepot>	getNodeDepotAfterVisit()
Optional<INodeDepot>	getNodeDepotBeforeVisit()
long	getOriginalTransitionTime()
ILogicRouteElementDetailItem.ScheduleStatus	getScheduleStatus() Gets the ILogicRouteElementDetailItem.ScheduleStatus, which either is UNKNOWN, EARLY, IDLE, INTIME or LATE.
double	getTransitionDistance() Gets the transition distance from the previous location of the Resource to the Node in meters.
long	getTransitionTime() Gets the time that was needed since the last geoLocation, likely a INode or IPillarNode in milliseconds.
String	getVisitorId() Gets the visitor ID, which is the given name of the Resource.
long	getWhiteSpaceIdleTime() Gets the white space idle time in milliseconds which is the time between the setLocalMaxRouteStartReductionTimePillar and the normal IWorkingHours.
boolean	isUnlocatedIdleTime() Checks unlocated idle time, which means the idle time is happening on the way and not at the Node.
void	setArrivalTime(long arrivalTime)
void	setDepartureTime(long depatureTime)
void	setDistance2prevElement(double distance2prevElement)
void	setDurationTime(long durationTime)
void	setIdleTime(long idleTime)
void	setOriginalTransitionTime(long originalTransitionTime)
void	setTransitionTime(long transitionTime)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

LogicRouteElementDetailItem

public LogicRouteElementDetailItem(ZoneId zoneId,
                                   long arrivalTime,
                                   long departureTime,
                                   long transitionTime,
                                   long idleTime,
                                   boolean isUnlocatedIdleTime,
                                   long whiteSpaceIdleTime,
                                   long durationTime,
                                   double distance2prevElement,
                                   long earlyDeviationMillis,
                                   long lateDeviationMillis,
                                   int chosenOpeningHoursIndex,
                                   int chosenWorkingHoursIndex,
                                   String visitorId,
                                   ILogicRouteElementDetailItem.ScheduleStatus status,
                                   double[] curCapacity)

LogicRouteElementDetailItem

public LogicRouteElementDetailItem(IOptimizationElement node,
                                   long arrivalTime,
                                   long departureTime,
                                   long transitionTime,
                                   long idleTime,
                                   boolean isUnlocatedIdleTime,
                                   long whiteSpaceIdleTime,
                                   long durationTime,
                                   double distance2prevElement,
                                   long earlyDeviationMillis,
                                   long lateDeviationMillis,
                                   int choosenOpeningHoursIndex,
                                   int choosenWorkingHoursIndex,
                                   String visitorId,
                                   ILogicRouteElementDetailItem.ScheduleStatus status,
                                   double[] loadChange,
                                   double[] curCapacity,
                                   INodeDepot depotBeforeVisit,
                                   INodeDepot depotAfterVisit,
                                   com.dna.jopt.config.types.Position effectivePosition)

Method Detail

extractZoneId

public static ZoneId extractZoneId(IOptimizationElement node)

setArrivalTime

public void setArrivalTime(long arrivalTime)

setDepartureTime

public void setDepartureTime(long depatureTime)

setDurationTime

public void setDurationTime(long durationTime)

setTransitionTime

public void setTransitionTime(long transitionTime)

setOriginalTransitionTime

public void setOriginalTransitionTime(long originalTransitionTime)

getOriginalTransitionTime

public long getOriginalTransitionTime()

Specified by:

getOriginalTransitionTime in interface ILogicRouteElementDetailItem

setDistance2prevElement

public void setDistance2prevElement(double distance2prevElement)

setIdleTime

public void setIdleTime(long idleTime)

getScheduleStatus

public ILogicRouteElementDetailItem.ScheduleStatus getScheduleStatus()

Description copied from interface: ILogicRouteElementDetailItem

Gets the ILogicRouteElementDetailItem.ScheduleStatus, which either is UNKNOWN, EARLY, IDLE, INTIME or LATE. The default is UNKNOWN.

Specified by:

getScheduleStatus in interface ILogicRouteElementDetailItem

Returns:

the Status

getVisitorId

public String getVisitorId()

Description copied from interface: ILogicRouteElementDetailItem

Gets the visitor ID, which is the given name of the Resource.

Specified by:

getVisitorId in interface ILogicRouteElementDetailItem

Returns:

the string of the visitor ID

getArrivalTime

public long getArrivalTime()

Description copied from interface: ILogicRouteElementDetailItem

Gets the arrival time of the Resource at the Node in milliseconds since UNIX timestamp.

Specified by:

getArrivalTime in interface ILogicRouteElementDetailItem

Returns:

the long arrival time

getChosenOpeningHoursIndex

public int getChosenOpeningHoursIndex()

Description copied from interface: ILogicRouteElementDetailItem

Gets the index of the OpeningHours from the Node.

Specified by:

getChosenOpeningHoursIndex in interface ILogicRouteElementDetailItem

Returns:

the int chosenOpeningHoursIndex

getChosenWorkingHoursIndex

public int getChosenWorkingHoursIndex()

Description copied from interface: ILogicRouteElementDetailItem

Gets the index of the WorkingHours of the Resource.

Specified by:

getChosenWorkingHoursIndex in interface ILogicRouteElementDetailItem

Returns:

the choosenWorkingHoursIndex

getDepatureTime

@Deprecated
public long getDepatureTime()

Deprecated.

Description copied from interface: ILogicRouteElementDetailItem

Gets the departure time of the Resource at the Node in milliseconds since UNIX timestamp.

Specified by:

getDepatureTime in interface ILogicRouteElementDetailItem

Returns:

the long departure time in milliseconds

getDepartureTime

public long getDepartureTime()

Specified by:

getDepartureTime in interface ILogicRouteElementDetailItem

getLoadChange

public double[] getLoadChange()

Description copied from interface: ILogicRouteElementDetailItem

Gets the load change. In case a node is requesting a pickup or delivery, the load change indicates how the load of the node changed after the visitation.

Specified by:

getLoadChange in interface ILogicRouteElementDetailItem

Returns:

the load change

getTransitionTime

public long getTransitionTime()

Description copied from interface: ILogicRouteElementDetailItem

Gets the time that was needed since the last geoLocation, likely a INode or IPillarNode in milliseconds.

Specified by:

getTransitionTime in interface ILogicRouteElementDetailItem

Returns:

the long transitionTime in milliseconds

getIdleTime

public long getIdleTime()

Description copied from interface: ILogicRouteElementDetailItem

Gets the idle time that a Resource had to wait since it arrived prior to the OpeningHours of the Node in milliseconds.

If the return number is bigger than 0 the INode.isWaitOnEarlyArrival() is set to true and the ILogicRouteElementDetailItem.ScheduleStatus will be set to IDLE. If INode.isWaitOnEarlyArrival() would be set to false the ILogicRouteElementDetailItem.ScheduleStatus would be set to EARLY and the return number would be 0 since the Resource is not idling.

Specified by:

getIdleTime in interface ILogicRouteElementDetailItem

Returns:

the long idleTime

isUnlocatedIdleTime

public boolean isUnlocatedIdleTime()

Description copied from interface: ILogicRouteElementDetailItem

Checks unlocated idle time, which means the idle time is happening on the way and not at the Node. The Resource will arrive at the Node when the work is starting. The default value is false.

Specified by:

isUnlocatedIdleTime in interface ILogicRouteElementDetailItem

Returns:

the boolean of isUnlocatedIdleTime

getWhiteSpaceIdleTime

public long getWhiteSpaceIdleTime()

Description copied from interface: ILogicRouteElementDetailItem

Gets the white space idle time in milliseconds which is the time between the setLocalMaxRouteStartReductionTimePillar and the normal IWorkingHours. The maxRouteStartReductionTimePillar can only be used by an IPillarNode.

Specified by:

getWhiteSpaceIdleTime in interface ILogicRouteElementDetailItem

Returns:

the whiteSpaceIdleTime

getDurationTime

public long getDurationTime()

Description copied from interface: ILogicRouteElementDetailItem

Gets the duration between the last location of the Resource to the specific Node in milliseconds.

Specified by:

getDurationTime in interface ILogicRouteElementDetailItem

Returns:

the long duration time

getEarlyDeviation

public long getEarlyDeviation()

Description copied from interface: ILogicRouteElementDetailItem

Gets the earlyDeviationMillis in milliseconds.

Specified by:

getEarlyDeviation in interface ILogicRouteElementDetailItem

Returns:

the earlyDeviationMillis

getLateDeviation

public long getLateDeviation()

Description copied from interface: ILogicRouteElementDetailItem

Gets the lateDeviationMillis in milliseconds.

Specified by:

getLateDeviation in interface ILogicRouteElementDetailItem

Returns:

the lateDeviationMillis

getTransitionDistance

public double getTransitionDistance()

Description copied from interface: ILogicRouteElementDetailItem

Gets the transition distance from the previous location of the Resource to the Node in meters.

Specified by:

getTransitionDistance in interface ILogicRouteElementDetailItem

Returns:

the double from the previous element

getElement

public IOptimizationElement getElement()

Description copied from interface: ILogicRouteElementDetailItem

Gets the Node.

Specified by:

getElement in interface ILogicRouteElementDetailItem

Returns:

the iOptimizationElement

getNodeDepotAfterVisit

public Optional<INodeDepot> getNodeDepotAfterVisit()

Specified by:

getNodeDepotAfterVisit in interface ILogicRouteElementDetailItem

getNodeDepotBeforeVisit

public Optional<INodeDepot> getNodeDepotBeforeVisit()

Specified by:

getNodeDepotBeforeVisit in interface ILogicRouteElementDetailItem

getEffectivePosition

public com.dna.jopt.config.types.Position getEffectivePosition()

Specified by:

getEffectivePosition in interface ILogicRouteElementDetailItem

toString

public String toString()

Overrides:

toString in class Object