allocate
fun allocate(entity: ProcessModel.Entity, requestLocation: LocationIfc, queue: RequestQ, resourceSelectionRule: MovableResourceSelectionRuleIfc, resourceAllocationRule: MovableResourceAllocationRuleIfc, allocationName: String? = null): Allocation
It is an error to attempt to allocate a movable resource unit to an entity if there are insufficient units available at the time of allocation.
Return
an allocation representing that the units have been allocated to the entity. The reference to this allocation is necessary in order to deallocate the allocated units.
Parameters
entity
the entity that is requesting the units
allocation Name
an optional name for the allocation
queue
the queue associated with the allocation. That is, where the entities would have had to wait if the allocation was not immediately filled
resource Selection Rule
The rule to use to select resources to allocate from
resource Allocation Rule
The rule to use to determine the resources to allocate from given the selected resources