R1.2.2

KSLCore/ksl.modeling.spatial/MovableResource

MovableResource

open class MovableResource(parent: ModelElement, initLocation: LocationIfc, defaultVelocity: RVariableIfc, name: String? = null) : Resource, MovableResourceIfc, MoveableResourceCIfc(source)

A movable resource is a single unit capacity resource that resides within a spatial model and thus can be moved.

Parameters

parent

the parent model element

initLocation

the initial starting location of the resource within the spatial model

defaultVelocity

the default velocity for movement within the spatial model

name

the name of the resource

Inheritors

MovableResourceWithQ

Constructors

MovableResource

constructor(parent: ModelElement, initLocation: LocationIfc, defaultVelocity: RVariableIfc, name: String? = null)

Types

object Companion

Properties

open override var capacity: Int

The current capacity of the resource. In general, it can be 0 or greater

currentLocation

open override var currentLocation: LocationIfc

open override val fracTimeMoving: TWResponseCIfc

fracTimeMovingEmpty

open override val fracTimeMovingEmpty: TWResponseCIfc

fracTimeTransporting

open override val fracTimeTransporting: TWResponseCIfc

open override val hasHomeBase: Boolean

open override var homeBase: LocationIfc?

initialCapacity

@set:KSLControl(controlType = ControlType.INTEGER, lowerBound = 0.0, upperBound = 1.0)

open override var initialCapacity: Int

The initial capacity of the resource at the start of the replication. The initial capacity must be greater than 0.

initialHomeBase

open override var initialHomeBase: LocationIfc?

initialLocation

open override var initialLocation: LocationIfc

open override var isMoving: Boolean

var isMovingEmpty: Boolean

isReturningHome

val isReturningHome: Boolean

True indicates that the movable resource is in the process of returning to its home base.

open override val isTracked: Boolean

var isTransporting: Boolean

open override val modelElement: ModelElement

observableComponent

open override val observableComponent: ObservableComponent<SpatialElementIfc>

previousLocation

open override val previousLocation: LocationIfc

open override val spatialID: Int

open override val spatialName: String

open override val status: SpatialModel.Status

open override val velocity: GetValueIfc

A value for the velocity. May be random

open override val velocityRV: RandomVariableCIfc

Functions

open override fun attachObserver(observer: ObserverIfc<SpatialElementIfc>)

Allows the adding (attaching) of an observer to the observable

open override fun countObservers(): Int

Returns how many observers are currently attached to the observable

detachAllObservers

open override fun detachAllObservers()

Detaches all the observers from the observable

open override fun detachObserver(observer: ObserverIfc<SpatialElementIfc>)

Allows the deletion (removing) of an observer from the observable

homeQStatistics

fun homeQStatistics(option: Boolean)

initializeSpatialElement

open override fun initializeSpatialElement()

open override fun isAttached(observer: ObserverIfc<SpatialElementIfc>): Boolean

Returns true if the observer is already attached

fun sendToHomeBase()

If the movable resource has a defined home base, and it is not already returning to home, this function causes the movable resource to be requested and sent to its home base. If there are pending requests, this request will compete with them, possibly waiting until finally causing the resource to return to its home base.