Package com.dna.jopt.member.unit.node.event

Class InducedIdleEventNode

java.lang.Object

com.dna.jopt.member.unit.AbstractOptimizationElement

com.dna.jopt.member.unit.node.AbstractNode

com.dna.jopt.member.unit.node.event.EventNode

com.dna.jopt.member.unit.node.event.InducedIdleEventNode

All Implemented Interfaces:

IOptimizationElement, INode, Serializable

public class InducedIdleEventNode
extends EventNode

This class

Since:

31/01/2020

Version:

31/01/2020

Author:

DNA

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.dna.jopt.member.unit.IOptimizationElement

IOptimizationElement.OptimizationElementFlavour

Field Summary

Fields

Modifier and Type	Field	Description
static final int	RELATED_ELEMENT_INDEX

Fields inherited from class com.dna.jopt.member.unit.AbstractOptimizationElement

dutyHours

Constructor Summary

Constructors

Constructor	Description
InducedIdleEventNode(INode2NodeRelation rel, IOpeningHours openingHour, Duration duration)	The constructor of an InducedIdleEventNode to add to the Node ID the Relations to another Node.
InducedIdleEventNode(String nodeId, IOpeningHours openingHour, Duration duration)	The constructor of an InducedIdleEventNode.

Method Summary

Modifier and Type	Method	Description
Optional<Long>	getCreationTimeStamp()	Gets the TimeStamp of the creation of the InducedIdleEventNode as created by System.currentTimeMillis().
String	getId()	Gets the ID and the time it was created.
Optional<String>	getMasterNodeId()	Gets the ID of the MasterNode.
static String	getPartialNodeId(String masterNodeId, String relatedNodeId)	Gets the Node ID and adds the masterNodeId and the relatedNodeId.
Optional<String>	getRelatedNodeId()	Gets the ID of the RelatedNode.
static InducedIdleEventNode	getShrinkedCopy(InducedIdleEventNode baseEvent, long shinkMillis, long safetyAdditionalDuration)	Gets a copy of the input Node where the input shinkMillis and safetyAdditionalDuration are substracted or added respectively from/to the end of the timeWindow of the OpeningHours in seconds.
boolean	hasRouteDependentVisitDuration()	Checks for route dependent visit duration.
void	setCreationTimeStamp(long creationTimeStamp)	Sets the input in the form of System.currentTimeMillis() as the TimeStamp when the InducedIdleEventNode was created.
void	setMasterNodeId(String connectedMasterNodeId)	Sets the input ID as the MasterNode.
void	setRelatedNodeId(String connectedRelatedNodeId)	Sets the input ID as the RelatedNode

Methods inherited from class com.dna.jopt.member.unit.node.event.EventNode

getFlavour, hasRealGeoLocation, isPartialExchangeIdleForDrivingTime, isPillarNode, setIsPartialExchangeIdleForDrivingTime

Methods inherited from class com.dna.jopt.member.unit.node.AbstractNode

addConstraint, addNode2NodeRelation, addQualification, addSubsequentSlaveNode, addSubsequentSlaveNodes, addViolation, decrementCurrentAutoFilterProtectedExecutions, detachNodeRelations, detachResourceConstraints, detachResourceConstraints, equals, getAutoFilterViolationCollector, getBaseJointVisitDuration, getBaseJointVisitDurationMillis, getBaseVisitDuration, getBaseVisitDurationMillis, getConstraints, getCurrentLeftAutoFilterProtectedExecutions, getDutyHours, getFirstNodeInRouteImportance, getFixCost, getImportance, getIndividualOfferedNodeMultiplier, getJointVisitDuration, getJointVisitDurationMillis, getLastKnownAttachedAndRemovedResIds, getLastNodeInRouteImportance, getLoad, getLockdownTime, getMinVisitDuration, getMinVisitDurationMillis, getNode2NodeRelations, getNodeColor, getNodeDepot, getNodeId, getOriginalDutyHours, getQualifications, getStayAtStartDuration, getSubsequentSlaveNodes, getTempImplausibleScore, getTotalLoadDimension, getUnloadAllDimension, getViolations, getVisitDurationMillis, hasFullJobLevelRelations, hashCode, hasRelations, invokeDetachedResourceConstraints, isAllowMoveToReduceFlexTime, isAutoFilterProtected, isCausingIdleTimeCost, isDutyHoursIncludesVisitDuration, isOfferedNode, isOptimizable, isOptional, isReturnStart, isStayNode, isUnassigned, isUnloadAll, isUseJointVisitDuration, isWaitOnEarlyArrival, isWaitOnEarlyArrivalFirstNode, isWorkNode, removeConstraint, removeNode2NodeRelations, resetDutyHoursTempActivation, resetLockdownTime, resetSubsequentSlaveNodes, setAllowMoveToReduceFlexTime, setAutoFilterConstraints, setConstraints, setFirstNodeInRouteImportance, setFixCost, setHasRouteDependentVisitDuration, setImportance, setIndividualOfferedNodeMultiplier, setIsCausingIdleTimeCost, setIsDutyHoursIncludesVisitDuration, setIsOfferedNode, setIsOptional, setIsReturnStart, setIsStayNode, setIsWorkNode, setJointVisitDuration, setLastNodeInRouteImportance, setLoad, setLockdownTime, setMinAutoFilterProtectedExecutions, setMinimalVisitDuration, setNodeColor, setNodeDepot, setNodeId, setOptimizable, setOptimizable, setUnassigned, setUnloadAll, setUnloadAllDimension, setVisitDuration, setVisitDurationMillis, setWaitOnEarlyArrival, setWaitOnEarlyArrivalFirstNode, tempIncreaseImplausibleScore, tempSetActiveDutyHours, toString

Methods inherited from class com.dna.jopt.member.unit.AbstractOptimizationElement

forceSetId, getConstraintAliasId, getDistMatrixId, getExtraInfo, getLatitude, getLocationId, getLongitude, getNodeConnection, getNodeConnectionKeySet, getNodeConnections, getPosition, getPreferredHoursInteractionController, putNodeConnection, putNodeConnectionFromElement, removeNodeConnection, setConstraintAliasId, setDistMatrixId, setDutyHours, setExtraInfo, setId, setLatitude, setLocationId, setLongitude, setPosition

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.dna.jopt.member.unit.IOptimizationElement

forceSetId, getConstraintAliasId, getDistMatrixId, getExtraInfo, getLatitude, getLocationId, getLongitude, getNodeConnection, getNodeConnectionKeySet, getNodeConnections, getPosition, getPreferredHoursInteractionController, putNodeConnection, putNodeConnectionFromElement, removeNodeConnection, setConstraintAliasId, setDistMatrixId, setDutyHours, setExtraInfo, setId, setLatitude, setLocationId, setLongitude, setPosition

Field Details

RELATED_ELEMENT_INDEX

public static final int RELATED_ELEMENT_INDEX

See Also:

• Constant Field Values

Constructor Details

InducedIdleEventNode

public InducedIdleEventNode(String nodeId,
 IOpeningHours openingHour,
 Duration duration)

The constructor of an InducedIdleEventNode.

Parameters:

nodeId - the string ID of the Node

openingHour - the iOpeningHour

duration - the duration of the idle time

InducedIdleEventNode

public InducedIdleEventNode(INode2NodeRelation rel,
 IOpeningHours openingHour,
 Duration duration)

The constructor of an InducedIdleEventNode to add to the Node ID the Relations to another Node.

Parameters:

rel - the iNode2NodeRelation

openingHour - the iOpeningHour

duration - the duration of the idle time

Method Details

getPartialNodeId

public static String getPartialNodeId(String masterNodeId,
 String relatedNodeId)

Gets the Node ID and adds the masterNodeId and the relatedNodeId.

Used in InducedIdleEventNode(INode2NodeRelation, IOpeningHours, Duration) to add the IDs of the MasterNode and the RelatedNode to the to the ID of the InducedIdleEventNode

Parameters:

masterNodeId - the string ID of the MasterNode

relatedNodeId - the string ID of the RelatedNode

Returns:

the ID in conjunction with the Master- and RelatedNode ID

getId

public String getId()

Gets the ID and the time it was created.

Specified by:

getId in interface IOptimizationElement

Overrides:

getId in class AbstractOptimizationElement

Returns:

the ID String

getShrinkedCopy

public static InducedIdleEventNode getShrinkedCopy(InducedIdleEventNode baseEvent,
 long shinkMillis,
 long safetyAdditionalDuration)

Gets a copy of the input Node where the input shinkMillis and safetyAdditionalDuration are substracted or added respectively from/to the end of the timeWindow of the OpeningHours in seconds.

Parameters:

baseEvent - the node to shrink

shinkMillis - the long milliseconds to substract from the end of the OpeningHours

safetyAdditionalDuration - the long milliseconds to add to the end of the OpeningHours

Returns:

a copy of the Node with the changed TimeWindow

setMasterNodeId

public void setMasterNodeId(String connectedMasterNodeId)

Sets the input ID as the MasterNode.

This method does not actually set up Relations but only sets the input String in the class variable

Parameters:

connectedMasterNodeId - the string ID of the MasterNode

setRelatedNodeId

public void setRelatedNodeId(String connectedRelatedNodeId)

Sets the input ID as the RelatedNode

This method does not actually set up Relations but only sets the input String in the class variable

Parameters:

connectedRelatedNodeId - the string ID of the MasterNode

setCreationTimeStamp

public void setCreationTimeStamp(long creationTimeStamp)

Sets the input in the form of System.currentTimeMillis() as the TimeStamp when the InducedIdleEventNode was created.

Parameters:

creationTimeStamp - the long TimeStamp

getMasterNodeId

public Optional<String> getMasterNodeId()

Gets the ID of the MasterNode.

Returns:

the optional ID

getRelatedNodeId

public Optional<String> getRelatedNodeId()

Gets the ID of the RelatedNode.

Returns:

the optional ID

getCreationTimeStamp

public Optional<Long> getCreationTimeStamp()

Gets the TimeStamp of the creation of the InducedIdleEventNode as created by System.currentTimeMillis().

Returns:

the timestamp in milliseconds

hasRouteDependentVisitDuration

public boolean hasRouteDependentVisitDuration()

Description copied from interface: INode

Checks for route dependent visit duration.

Specified by:

hasRouteDependentVisitDuration in interface INode

Overrides:

hasRouteDependentVisitDuration in class AbstractNode

Returns:

true, if successful