Package io.github.ai4ci.config.inhost

Class ImmutablePhenomenologicalModel

java.lang.Object

io.github.ai4ci.config.inhost.ImmutablePhenomenologicalModel

All Implemented Interfaces:

DemographicAdjustment.Phenomenological<Abstraction.Distribution,Double>, InHostConfiguration, PhenomenologicalModel, Serializable

@ParametersAreNonnullByDefault
@Generated("org.immutables.processor.ProxyProcessor")
@Immutable
@CheckReturnValue
public final class ImmutablePhenomenologicalModel
extends Object
implements PhenomenologicalModel

Immutable implementation of PhenomenologicalModel.

Use the builder to create immutable instances: ImmutablePhenomenologicalModel.builder().

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ImmutablePhenomenologicalModel.Builder	Builds instances of type ImmutablePhenomenologicalModel.

Nested classes/interfaces inherited from interface io.github.ai4ci.config.inhost.PhenomenologicalModel

PhenomenologicalModel._PartialPhenomenologicalModel

Field Summary

Fields inherited from interface io.github.ai4ci.config.inhost.InHostConfiguration

LIMIT, log

Fields inherited from interface io.github.ai4ci.config.inhost.PhenomenologicalModel

DEFAULT

Method Summary

Modifier and Type	Method	Description
static ImmutablePhenomenologicalModel.Builder	builder()	Creates a builder for ImmutablePhenomenologicalModel.
static ImmutablePhenomenologicalModel	copyOf(PhenomenologicalModel instance)	Creates an immutable copy of a PhenomenologicalModel value.
boolean	equals(Object another)	This instance is equal to all instances of ImmutablePhenomenologicalModel that have equal attribute values.
Abstraction.Distribution	getApproxPeakImmuneResponse()
Abstraction.Distribution	getApproxPeakViralLoad()
Abstraction.Distribution	getImmuneWaningHalfLife()
Abstraction.Distribution	getIncubationPeriod()
Abstraction.Distribution	getIncubationToPeakViralLoadDelay()
Double	getInfectiousnessCutoff()
Abstraction.Distribution	getPeakImmuneResponseDelay()
Abstraction.Distribution	getPeakToRecoveryDelay()
int	hashCode()	Computes a hash code from attributes: infectiousnessCutoff, incubationPeriod, approxPeakViralLoad, incubationToPeakViralLoadDelay, peakToRecoveryDelay, approxPeakImmuneResponse, peakImmuneResponseDelay, immuneWaningHalfLife.
ImmutablePhenomenologicalModel.Builder	toBuilder()	Creates a builder for ImmutablePhenomenologicalModel.prefilled with attibute values of this instance to easily create modified copies.
String	toString()	Prints the immutable value PhenomenologicalModel with attribute values.
final ImmutablePhenomenologicalModel	withApproxPeakImmuneResponse(Abstraction.Distribution value)	Copy the current immutable object by setting a value for the approxPeakImmuneResponse attribute.
final ImmutablePhenomenologicalModel	withApproxPeakViralLoad(Abstraction.Distribution value)	Copy the current immutable object by setting a value for the approxPeakViralLoad attribute.
final ImmutablePhenomenologicalModel	withImmuneWaningHalfLife(Abstraction.Distribution value)	Copy the current immutable object by setting a value for the immuneWaningHalfLife attribute.
final ImmutablePhenomenologicalModel	withIncubationPeriod(Abstraction.Distribution value)	Copy the current immutable object by setting a value for the incubationPeriod attribute.
final ImmutablePhenomenologicalModel	withIncubationToPeakViralLoadDelay(Abstraction.Distribution value)	Copy the current immutable object by setting a value for the incubationToPeakViralLoadDelay attribute.
final ImmutablePhenomenologicalModel	withInfectiousnessCutoff(Double value)	Copy the current immutable object by setting a value for the infectiousnessCutoff attribute.
final ImmutablePhenomenologicalModel	withPeakImmuneResponseDelay(Abstraction.Distribution value)	Copy the current immutable object by setting a value for the peakImmuneResponseDelay attribute.
final ImmutablePhenomenologicalModel	withPeakToRecoveryDelay(Abstraction.Distribution value)	Copy the current immutable object by setting a value for the peakToRecoveryDelay attribute.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.github.ai4ci.config.inhost.InHostConfiguration

getSeverityFatalityCutoff, getSeverityHospitalisationCutoff, getSeveritySymptomsCutoff

Method Details

getInfectiousnessCutoff

public Double getInfectiousnessCutoff()

Specified by:

getInfectiousnessCutoff in interface PhenomenologicalModel

Returns:

The value of the infectiousnessCutoff attribute

getIncubationPeriod

public Abstraction.Distribution getIncubationPeriod()

Specified by:

getIncubationPeriod in interface DemographicAdjustment.Phenomenological<Abstraction.Distribution,Double>

Specified by:

getIncubationPeriod in interface PhenomenologicalModel

Returns:

The value of the incubationPeriod attribute

getApproxPeakViralLoad

public Abstraction.Distribution getApproxPeakViralLoad()

Specified by:

getApproxPeakViralLoad in interface PhenomenologicalModel

Returns:

The value of the approxPeakViralLoad attribute

getIncubationToPeakViralLoadDelay

public Abstraction.Distribution getIncubationToPeakViralLoadDelay()

Specified by:

getIncubationToPeakViralLoadDelay in interface PhenomenologicalModel

Returns:

The value of the incubationToPeakViralLoadDelay attribute

getPeakToRecoveryDelay

public Abstraction.Distribution getPeakToRecoveryDelay()

Specified by:

getPeakToRecoveryDelay in interface DemographicAdjustment.Phenomenological<Abstraction.Distribution,Double>

Specified by:

getPeakToRecoveryDelay in interface PhenomenologicalModel

Returns:

The value of the peakToRecoveryDelay attribute

getApproxPeakImmuneResponse

public Abstraction.Distribution getApproxPeakImmuneResponse()

Specified by:

getApproxPeakImmuneResponse in interface PhenomenologicalModel

Returns:

The value of the approxPeakImmuneResponse attribute

getPeakImmuneResponseDelay

public Abstraction.Distribution getPeakImmuneResponseDelay()

Specified by:

getPeakImmuneResponseDelay in interface PhenomenologicalModel

Returns:

The value of the peakImmuneResponseDelay attribute

getImmuneWaningHalfLife

public Abstraction.Distribution getImmuneWaningHalfLife()

Specified by:

getImmuneWaningHalfLife in interface DemographicAdjustment.Phenomenological<Abstraction.Distribution,Double>

Specified by:

getImmuneWaningHalfLife in interface PhenomenologicalModel

Returns:

The value of the immuneWaningHalfLife attribute

withInfectiousnessCutoff

public final ImmutablePhenomenologicalModel withInfectiousnessCutoff(Double value)

Copy the current immutable object by setting a value for the infectiousnessCutoff attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for infectiousnessCutoff

Returns:

A modified copy of the this object

withIncubationPeriod

public final ImmutablePhenomenologicalModel withIncubationPeriod(Abstraction.Distribution value)

Copy the current immutable object by setting a value for the incubationPeriod attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for incubationPeriod

Returns:

A modified copy of the this object

withApproxPeakViralLoad

public final ImmutablePhenomenologicalModel withApproxPeakViralLoad(Abstraction.Distribution value)

Copy the current immutable object by setting a value for the approxPeakViralLoad attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for approxPeakViralLoad

Returns:

A modified copy of the this object

withIncubationToPeakViralLoadDelay

public final ImmutablePhenomenologicalModel withIncubationToPeakViralLoadDelay(Abstraction.Distribution value)

Copy the current immutable object by setting a value for the incubationToPeakViralLoadDelay attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for incubationToPeakViralLoadDelay

Returns:

A modified copy of the this object

withPeakToRecoveryDelay

public final ImmutablePhenomenologicalModel withPeakToRecoveryDelay(Abstraction.Distribution value)

Copy the current immutable object by setting a value for the peakToRecoveryDelay attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for peakToRecoveryDelay

Returns:

A modified copy of the this object

withApproxPeakImmuneResponse

public final ImmutablePhenomenologicalModel withApproxPeakImmuneResponse(Abstraction.Distribution value)

Copy the current immutable object by setting a value for the approxPeakImmuneResponse attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for approxPeakImmuneResponse

Returns:

A modified copy of the this object

withPeakImmuneResponseDelay

public final ImmutablePhenomenologicalModel withPeakImmuneResponseDelay(Abstraction.Distribution value)

Copy the current immutable object by setting a value for the peakImmuneResponseDelay attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for peakImmuneResponseDelay

Returns:

A modified copy of the this object

withImmuneWaningHalfLife

public final ImmutablePhenomenologicalModel withImmuneWaningHalfLife(Abstraction.Distribution value)

Copy the current immutable object by setting a value for the immuneWaningHalfLife attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for immuneWaningHalfLife

Returns:

A modified copy of the this object

equals

public boolean equals(@Nullable
 Object another)

This instance is equal to all instances of ImmutablePhenomenologicalModel that have equal attribute values.

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: infectiousnessCutoff, incubationPeriod, approxPeakViralLoad, incubationToPeakViralLoadDelay, peakToRecoveryDelay, approxPeakImmuneResponse, peakImmuneResponseDelay, immuneWaningHalfLife.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value PhenomenologicalModel with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutablePhenomenologicalModel copyOf(PhenomenologicalModel instance)

Creates an immutable copy of a PhenomenologicalModel value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.

Parameters:

instance - The instance to copy

Returns:

A copied immutable PhenomenologicalModel instance

toBuilder

public ImmutablePhenomenologicalModel.Builder toBuilder()

Creates a builder for ImmutablePhenomenologicalModel.prefilled with attibute values of this instance to easily create modified copies.

Returns:

A new ImmutablePhenomenologicalModel builder with attributes of this instance

builder

public static ImmutablePhenomenologicalModel.Builder builder()

Creates a builder for ImmutablePhenomenologicalModel.

 ImmutablePhenomenologicalModel.builder()
    .setInfectiousnessCutoff(Double) // required infectiousnessCutoff
    .setIncubationPeriod(io.github.ai4ci.abm.mechanics.Abstraction.Distribution) // required incubationPeriod
    .setApproxPeakViralLoad(io.github.ai4ci.abm.mechanics.Abstraction.Distribution) // required approxPeakViralLoad
    .setIncubationToPeakViralLoadDelay(io.github.ai4ci.abm.mechanics.Abstraction.Distribution) // required incubationToPeakViralLoadDelay
    .setPeakToRecoveryDelay(io.github.ai4ci.abm.mechanics.Abstraction.Distribution) // required peakToRecoveryDelay
    .setApproxPeakImmuneResponse(io.github.ai4ci.abm.mechanics.Abstraction.Distribution) // required approxPeakImmuneResponse
    .setPeakImmuneResponseDelay(io.github.ai4ci.abm.mechanics.Abstraction.Distribution) // required peakImmuneResponseDelay
    .setImmuneWaningHalfLife(io.github.ai4ci.abm.mechanics.Abstraction.Distribution) // required immuneWaningHalfLife
    .build();
 

Returns:

A new ImmutablePhenomenologicalModel builder