# builders.domain.scheduling.resource_availability
Domain specification
# UncertainResourceAvailabilityChanges
A domain must inherit this class if the availability of its resource vary in an uncertain way over time.
# check_unique_resource_names UncertainResourceAvailabilityChanges
check_unique_resource_names(
self
) -> bool
Return True if there are no duplicates in resource names across both resource types and resource units name lists.
# sample_quantity_resource UncertainResourceAvailabilityChanges
sample_quantity_resource(
self,
resource: str,
time: int,
**kwargs
) -> int
Sample an amount of resource availability (int) for the given resource (either resource type or resource unit) at the given time. This number should be the sum of the number of resource available at time t and the number of resource of this type consumed so far).
# _sample_quantity_resource UncertainResourceAvailabilityChanges
_sample_quantity_resource(
self,
resource: str,
time: int,
**kwargs
) -> int
Sample an amount of resource availability (int) for the given resource (either resource type or resource unit) at the given time. This number should be the sum of the number of resource available at time t and the number of resource of this type consumed so far).
# DeterministicResourceAvailabilityChanges
A domain must inherit this class if the availability of its resource vary in a deterministic way over time.
# check_unique_resource_names UncertainResourceAvailabilityChanges
check_unique_resource_names(
self
) -> bool
Return True if there are no duplicates in resource names across both resource types and resource units name lists.
# get_quantity_resource DeterministicResourceAvailabilityChanges
get_quantity_resource(
self,
resource: str,
time: int,
**kwargs
) -> int
Return the resource availability (int) for the given resource (either resource type or resource unit) at the given time.
# sample_quantity_resource UncertainResourceAvailabilityChanges
sample_quantity_resource(
self,
resource: str,
time: int,
**kwargs
) -> int
Sample an amount of resource availability (int) for the given resource (either resource type or resource unit) at the given time. This number should be the sum of the number of resource available at time t and the number of resource of this type consumed so far).
# _get_quantity_resource DeterministicResourceAvailabilityChanges
_get_quantity_resource(
self,
resource: str,
time: int,
**kwargs
) -> int
Return the resource availability (int) for the given resource (either resource type or resource unit) at the given time.
# _sample_quantity_resource UncertainResourceAvailabilityChanges
_sample_quantity_resource(
self,
resource: str,
time: int,
**kwargs
) -> int
Sample an amount of resource availability (int) for the given resource (either resource type or resource unit) at the given time. This number should be the sum of the number of resource available at time t and the number of resource of this type consumed so far).
# WithoutResourceAvailabilityChange
A domain must inherit this class if the availability of its resource does not vary over time.
# check_unique_resource_names UncertainResourceAvailabilityChanges
check_unique_resource_names(
self
) -> bool
Return True if there are no duplicates in resource names across both resource types and resource units name lists.
# get_original_quantity_resource WithoutResourceAvailabilityChange
get_original_quantity_resource(
self,
resource: str,
**kwargs
) -> int
Return the resource availability (int) for the given resource (either resource type or resource unit).
# get_quantity_resource DeterministicResourceAvailabilityChanges
get_quantity_resource(
self,
resource: str,
time: int,
**kwargs
) -> int
Return the resource availability (int) for the given resource (either resource type or resource unit) at the given time.
# sample_quantity_resource UncertainResourceAvailabilityChanges
sample_quantity_resource(
self,
resource: str,
time: int,
**kwargs
) -> int
Sample an amount of resource availability (int) for the given resource (either resource type or resource unit) at the given time. This number should be the sum of the number of resource available at time t and the number of resource of this type consumed so far).
# _get_original_quantity_resource WithoutResourceAvailabilityChange
_get_original_quantity_resource(
self,
resource: str,
**kwargs
) -> int
Return the resource availability (int) for the given resource (either resource type or resource unit).
# _get_quantity_resource DeterministicResourceAvailabilityChanges
_get_quantity_resource(
self,
resource: str,
time: int,
**kwargs
) -> int
Return the resource availability (int) for the given resource (either resource type or resource unit) at the given time.
# _sample_quantity_resource UncertainResourceAvailabilityChanges
_sample_quantity_resource(
self,
resource: str,
time: int,
**kwargs
) -> int
Sample an amount of resource availability (int) for the given resource (either resource type or resource unit) at the given time. This number should be the sum of the number of resource available at time t and the number of resource of this type consumed so far).