org.eclipse.ohf.stem.diseasemodels.standard
Interface StandardDiseaseModelLabelValue

All Superinterfaces:
DiseaseModelLabelValue, org.eclipse.emf.ecore.EObject, LabelValue, org.eclipse.emf.common.notify.Notifier, SanityChecker
All Known Subinterfaces:
SEIRLabelValue, SILabelValue, SIRLabelValue
All Known Implementing Classes:
SEIRLabelValueImpl, SILabelValueImpl, SIRLabelValueImpl, StandardDiseaseModelLabelValueImpl

public interface StandardDiseaseModelLabelValue
extends DiseaseModelLabelValue

This interface defines a class in an EMF model for an Standard disease model label value. In a standard disease model population members can be in a single Susceptible state, which means that they are not exposed or infected by a disease. Sub-classes could introduce additional states in which population members could exist.

See Also:
SIR, SIRLabel, SIRLabelValue, SEIR, SEIRLabel, SEIRLabelValue

Method Summary
 StandardDiseaseModelLabelValue convertToSourceStates()
          Instances of the disease state label value are used in standard disease model computations to represent the state transitions made by the population due to the progress of a disease.
 double getS()
           
 void setS(double value)
          Sets the value of the 'S' attribute.
 
Methods inherited from interface org.eclipse.ohf.stem.diseasemodels.standard.DiseaseModelLabelValue
add, getBirths, getDeaths, getDiseaseDeaths, getPopulationCount, scale, set, setBirths, setDeaths, setDiseaseDeaths, sub, zeroOutPopulationCount
 
Methods inherited from interface org.eclipse.ohf.stem.core.graph.LabelValue
reset
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 
Methods inherited from interface org.eclipse.ohf.stem.core.common.SanityChecker
sane
 

Method Detail

getS

double getS()
Returns:
the number of population members in the Susceptible state.

setS

void setS(double value)
Sets the value of the 'S' attribute.

Parameters:
value - the new value of the 'S' attribute.
See Also:
getS()

convertToSourceStates

StandardDiseaseModelLabelValue convertToSourceStates()
Instances of the disease state label value are used in standard disease model computations to represent the state transitions made by the population due to the progress of a disease. In that case the numbers in each state represent the additional population members to be added to each disease state due to transitions from other states. It is also useful to have a representation of the population members who depart each state (to go to another). This method converts the former to the later. For example, if the instance had 1 population member being added to the "recovered" state, converting it would result in an instance with 1 member leaving the "infectious" state.

In the former case the members could be "added" to an another instance and in the later "subtracted" to account for the movement of population members between states.

Returns:
the disease state label value that has the source of the population members.