KSLCore/ksl.modeling.entity/KSLProcessBuilder/move

move

abstract suspend fun move(fromLoc: LocationIfc, toLoc: LocationIfc, velocity: Double = entity.velocity.value, movePriority: Int = PRIORITY, suspensionName: String? = null)
open suspend fun move(fromLoc: LocationIfc, toLoc: LocationIfc, velocity: GetValueIfc = entity.velocity, movePriority: Int = PRIORITY, suspensionName: String? = null)

Causes movement of the entity from the specified location to the specified location at the supplied velocity. If the entity is not currently at fromLoc then its current location is quietly set to fromLoc, without movement before the move commences. To move directly from the current location, use moveTo().

Parameters

fromLoc

, the location from which the entity is supposed to move

toLoc

the location to which the entity is supposed to move

velocity

the velocity associated with the movement

movePriority

, since the move is scheduled, a priority can be used to determine the order of events for moves that might be scheduled to complete at the same time.

suspensionName

the name of the delay. can be used to identify which delay the entity is experiencing if there are more than one delay suspension points within the process. The user is responsible for uniqueness.

abstract suspend fun move(spatialElement: SpatialElementIfc, toLoc: LocationIfc, velocity: Double, movePriority: Int = PRIORITY, suspensionName: String? = null)

Causes movement of the spatial element from its current location to the specified location at the supplied velocity.

Parameters

spatialElement

, the spatial element that will be moved

toLoc

the location to which the entity is supposed to move

velocity

the velocity associated with the movement

movePriority

, since the move is scheduled, a priority can be used to determine the order of events for moves that might be scheduled to complete at the same time.

suspensionName

the name of the delay. can be used to identify which delay the entity is experiencing if there are more than one delay suspension points within the process. The user is responsible for uniqueness.

open suspend fun move(movableResource: MovableResource, toLoc: LocationIfc, velocity: Double = movableResource.velocity.value, movePriority: Int = PRIORITY, suspensionName: String? = null)

Causes movement of the movable resource from its current location to the specified location at the supplied velocity.

Parameters

movableResource

, the spatial element that will be moved

toLoc

the location to which the entity is supposed to move

velocity

the velocity associated with the movement

movePriority

, since the move is scheduled, a priority can be used to determine the order of events for moves that might be scheduled to complete at the same time.

suspensionName

the name of the delay. can be used to identify which delay the entity is experiencing if there are more than one delay suspension points within the process. The user is responsible for uniqueness.

open suspend fun move(movableResourceWithQ: MovableResourceWithQ, toLoc: LocationIfc, velocity: Double = movableResourceWithQ.velocity.value, movePriority: Int = PRIORITY, suspensionName: String? = null)

Causes movement of the movable resource from its current location to the specified location at the supplied velocity.

Parameters

movableResourceWithQ

, the spatial element that will be moved

toLoc

the location to which the entity is supposed to move

velocity

the velocity associated with the movement

movePriority

, since the move is scheduled, a priority can be used to determine the order of events for moves that might be scheduled to complete at the same time.

suspensionName

the name of the delay. can be used to identify which delay the entity is experiencing if there are more than one delay suspension points within the process. The user is responsible for uniqueness.