Package gov.nasa.jpl.aerie.contrib.streamline.modeling.discrete

Class DiscreteEffects

java.lang.Object

gov.nasa.jpl.aerie.contrib.streamline.modeling.discrete.DiscreteEffects

public final class DiscreteEffects
extends Object

Method Summary

Modifier and Type	Method	Description
static <T> void	add(MutableResource<Discrete<List<T>>> resource, T element)	Add element to the end of the queue resource
static void	consume(MutableResource<Discrete<Double>> resource, double amount)	Subtract the given amount from resource.
static void	consume(UnitAware<MutableResource<Discrete<Double>>> resource, UnitAware<Double> amount)	Subtract the given amount from resource.
static void	decrease(MutableResource<Discrete<Double>> resource, double amount)	Subtract amount from resource's value
static void	decrement(MutableResource<Discrete<Integer>> resource)	Subtract one from the resource's value.
static void	decrement(MutableResource<Discrete<Integer>> resource, int amount)	Subtract the given amount from the resource's value.
static void	increase(MutableResource<Discrete<Double>> resource, double amount)	Add amount to resource's value
static void	increment(MutableResource<Discrete<Integer>> resource)	Add one to the resource's value.
static void	increment(MutableResource<Discrete<Integer>> resource, int amount)	Add the given amount to the resource's value.
static <T> Optional<T>	remove(MutableResource<Discrete<List<T>>> resource)	Remove an element from the front of the queue resource.
static void	restore(MutableResource<Discrete<Double>> resource, double amount)	Add the given amount to resource.
static void	restore(UnitAware<MutableResource<Discrete<Double>>> resource, UnitAware<Double> amount)	Add the given amount to resource.
static <A> void	set(MutableResource<Discrete<A>> resource, A newValue)	Set the resource to the given value.
static <A> void	set(UnitAware<MutableResource<Discrete<A>>> resource, UnitAware<A> newValue)	Set the resource to the given value.
static void	toggle(MutableResource<Discrete<Boolean>> resource)	Toggle the resource value.
static void	turnOff(MutableResource<Discrete<Boolean>> resource)	Set the resource to false.
static void	turnOn(MutableResource<Discrete<Boolean>> resource)	Set the resource to true.
static void	using(MutableResource<Discrete<Double>> resource, double amount, Runnable action)	Decrease resource by amount while action is running.
static void	using(MutableResource<Discrete<Integer>> resource, Runnable action)	Decrease resource by one while action is running.
static void	using(UnitAware<MutableResource<Discrete<Double>>> resource, UnitAware<Double> amount, Runnable action)	Decrease resource by amount while action is running.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

set

public static <A> void set(MutableResource<Discrete<A>> resource,
 A newValue)

Set the resource to the given value.

turnOn

public static void turnOn(MutableResource<Discrete<Boolean>> resource)

Set the resource to true.

turnOff

public static void turnOff(MutableResource<Discrete<Boolean>> resource)

Set the resource to false.

toggle

public static void toggle(MutableResource<Discrete<Boolean>> resource)

Toggle the resource value.

increment

public static void increment(MutableResource<Discrete<Integer>> resource)

Add one to the resource's value.

increment

public static void increment(MutableResource<Discrete<Integer>> resource,
 int amount)

Add the given amount to the resource's value.

decrement

public static void decrement(MutableResource<Discrete<Integer>> resource)

Subtract one from the resource's value.

decrement

public static void decrement(MutableResource<Discrete<Integer>> resource,
 int amount)

Subtract the given amount from the resource's value.

increase

public static void increase(MutableResource<Discrete<Double>> resource,
 double amount)

Add amount to resource's value

decrease

public static void decrease(MutableResource<Discrete<Double>> resource,
 double amount)

Subtract amount from resource's value

add

public static <T> void add(MutableResource<Discrete<List<T>>> resource,
 T element)

Add element to the end of the queue resource

remove

public static <T> Optional<T> remove(MutableResource<Discrete<List<T>>> resource)

Remove an element from the front of the queue resource.

Returns that element, or empty if the queue was already empty.

consume

public static void consume(MutableResource<Discrete<Double>> resource,
 double amount)

Subtract the given amount from resource.

restore

public static void restore(MutableResource<Discrete<Double>> resource,
 double amount)

Add the given amount to resource.

using

public static void using(MutableResource<Discrete<Double>> resource,
 double amount,
 Runnable action)

Decrease resource by amount while action is running.

using

public static void using(MutableResource<Discrete<Integer>> resource,
 Runnable action)

Decrease resource by one while action is running.

set

public static <A> void set(UnitAware<MutableResource<Discrete<A>>> resource,
 UnitAware<A> newValue)

Set the resource to the given value.

consume

public static void consume(UnitAware<MutableResource<Discrete<Double>>> resource,
 UnitAware<Double> amount)

Subtract the given amount from resource.

restore

public static void restore(UnitAware<MutableResource<Discrete<Double>>> resource,
 UnitAware<Double> amount)

Add the given amount to resource.

using

public static void using(UnitAware<MutableResource<Discrete<Double>>> resource,
 UnitAware<Double> amount,
 Runnable action)

Decrease resource by amount while action is running.