Package io.github.ai4ci.abm.inhost

Class ImmutableInHostPhenomenologicalState

java.lang.Object

io.github.ai4ci.abm.inhost.ImmutableInHostPhenomenologicalState

All Implemented Interfaces:

InHostModelState<PhenomenologicalModel>, InHostPhenomenologicalState, Serializable

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

Immutable implementation of InHostPhenomenologicalState.

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

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from interface io.github.ai4ci.abm.inhost.InHostPhenomenologicalState

log

Method Summary

Modifier and Type	Method	Description
static ImmutableInHostPhenomenologicalState.Builder	builder()	Creates a builder for ImmutableInHostPhenomenologicalState.
static ImmutableInHostPhenomenologicalState	copyOf(InHostPhenomenologicalState instance)	Creates an immutable copy of a InHostPhenomenologicalState value.
boolean	equals(Object another)	This instance is equal to all instances of ImmutableInHostPhenomenologicalState that have equal attribute values.
com.google.common.collect.ImmutableList<ExposureModel>	getExposures()
double	getImmuneActivity()
ImmutableBiPhasicLogistic	getImmunityModel()
double	getInfectiousnessCutoff()
int	getTime()
double	getViralLoad()
ImmutableBiPhasicLogistic	getViralLoadModel()
int	hashCode()	Computes a hash code from attributes: viralLoadModel, immunityModel, exposures, infectiousnessCutoff, time, viralLoad, immuneActivity.
ImmutableInHostPhenomenologicalState.Builder	toBuilder()	Creates a builder for ImmutableInHostPhenomenologicalState.prefilled with attibute values of this instance to easily create modified copies.
String	toString()	Prints the immutable value InHostPhenomenologicalState with attribute values.
final ImmutableInHostPhenomenologicalState	withExposures(ExposureModel... elements)	Copy the current immutable object with elements that replace the content of exposures.
final ImmutableInHostPhenomenologicalState	withExposures(Iterable<? extends ExposureModel> elements)	Copy the current immutable object with elements that replace the content of exposures.
final ImmutableInHostPhenomenologicalState	withImmunityModel(ExposureModel.BiPhasicLogistic value)	Copy the current immutable object by setting a value for the immunityModel attribute.
final ImmutableInHostPhenomenologicalState	withInfectiousnessCutoff(double value)	Copy the current immutable object by setting a value for the infectiousnessCutoff attribute.
final ImmutableInHostPhenomenologicalState	withTime(int value)	Copy the current immutable object by setting a value for the time attribute.
final ImmutableInHostPhenomenologicalState	withViralLoadModel(ExposureModel.BiPhasicLogistic value)	Copy the current immutable object by setting a value for the viralLoadModel attribute.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.ai4ci.abm.inhost.InHostModelState

update

Methods inherited from interface io.github.ai4ci.abm.inhost.InHostPhenomenologicalState

getNormalisedSeverity, getNormalisedViralLoad, isInfected, update

Method Details

getViralLoadModel

public ImmutableBiPhasicLogistic getViralLoadModel()

Specified by:

getViralLoadModel in interface InHostPhenomenologicalState

Returns:

The value of the viralLoadModel attribute

getImmunityModel

public ImmutableBiPhasicLogistic getImmunityModel()

Specified by:

getImmunityModel in interface InHostPhenomenologicalState

Returns:

The value of the immunityModel attribute

getExposures

public com.google.common.collect.ImmutableList<ExposureModel> getExposures()

Specified by:

getExposures in interface InHostPhenomenologicalState

Returns:

The value of the exposures attribute

getInfectiousnessCutoff

public double getInfectiousnessCutoff()

Specified by:

getInfectiousnessCutoff in interface InHostPhenomenologicalState

Returns:

The value of the infectiousnessCutoff attribute

getTime

public int getTime()

Specified by:

getTime in interface InHostModelState<PhenomenologicalModel>

Specified by:

getTime in interface InHostPhenomenologicalState

Returns:

The value of the time attribute

getViralLoad

public double getViralLoad()

Specified by:

getViralLoad in interface InHostPhenomenologicalState

Returns:

The computed-at-construction value of the viralLoad attribute

getImmuneActivity

public double getImmuneActivity()

Specified by:

getImmuneActivity in interface InHostModelState<PhenomenologicalModel>

Specified by:

getImmuneActivity in interface InHostPhenomenologicalState

Returns:

The computed-at-construction value of the immuneActivity attribute

withViralLoadModel

public final ImmutableInHostPhenomenologicalState withViralLoadModel(ExposureModel.BiPhasicLogistic value)

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

Parameters:

value - A new value for viralLoadModel

Returns:

A modified copy of the this object

withImmunityModel

public final ImmutableInHostPhenomenologicalState withImmunityModel(ExposureModel.BiPhasicLogistic value)

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

Parameters:

value - A new value for immunityModel

Returns:

A modified copy of the this object

withExposures

public final ImmutableInHostPhenomenologicalState withExposures(ExposureModel... elements)

Copy the current immutable object with elements that replace the content of exposures.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withExposures

public final ImmutableInHostPhenomenologicalState withExposures(Iterable<? extends ExposureModel> elements)

Copy the current immutable object with elements that replace the content of exposures. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of exposures elements to set

Returns:

A modified copy of this object

withInfectiousnessCutoff

public final ImmutableInHostPhenomenologicalState withInfectiousnessCutoff(double value)

Copy the current immutable object by setting a value for the infectiousnessCutoff attribute. A value strict bits equality 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

withTime

public final ImmutableInHostPhenomenologicalState withTime(int value)

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

Parameters:

value - A new value for time

Returns:

A modified copy of the this object

equals

public boolean equals(@Nullable
 Object another)

This instance is equal to all instances of ImmutableInHostPhenomenologicalState 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: viralLoadModel, immunityModel, exposures, infectiousnessCutoff, time, viralLoad, immuneActivity.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value InHostPhenomenologicalState with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableInHostPhenomenologicalState copyOf(InHostPhenomenologicalState instance)

Creates an immutable copy of a InHostPhenomenologicalState 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 InHostPhenomenologicalState instance

toBuilder

public ImmutableInHostPhenomenologicalState.Builder toBuilder()

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

Returns:

A new ImmutableInHostPhenomenologicalState builder with attributes of this instance

builder

public static ImmutableInHostPhenomenologicalState.Builder builder()

Creates a builder for ImmutableInHostPhenomenologicalState.

 ImmutableInHostPhenomenologicalState.builder()
    .setViralLoadModel(io.github.ai4ci.abm.inhost.ExposureModel.BiPhasicLogistic) // required viralLoadModel
    .setImmunityModel(io.github.ai4ci.abm.inhost.ExposureModel.BiPhasicLogistic) // required immunityModel
    .addExposure|addAllExposures(io.github.ai4ci.abm.inhost.ExposureModel) // exposures elements
    .setInfectiousnessCutoff(double) // required infectiousnessCutoff
    .setTime(int) // required time
    .build();
 

Returns:

A new ImmutableInHostPhenomenologicalState builder