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

All Superinterfaces:
Decorator, DiseaseModel, org.eclipse.emf.ecore.EObject, Identifiable, NodeDecorator, org.eclipse.emf.common.notify.Notifier, SanityChecker
All Known Subinterfaces:
AggregatingSEIRDiseaseModel, AggregatingSIDiseaseModel, AggregatingSIRDiseaseModel, DeterministicSEIRDiseaseModel, DeterministicSIDiseaseModel, DeterministicSIRDiseaseModel, SEIR, SI, SIR, StochasticSEIRDiseaseModel, StochasticSIDiseaseModel, StochasticSIRDiseaseModel
All Known Implementing Classes:
AggregatingSEIRDiseaseModelImpl, AggregatingSIDiseaseModelImpl, AggregatingSIRDiseaseModelImpl, DeterministicSEIRDiseaseModelImpl, DeterministicSIDiseaseModelImpl, DeterministicSIRDiseaseModelImpl, SEIRImpl, SIImpl, SIRImpl, StandardDiseaseModelImpl, StochasticSEIRDiseaseModelImpl, StochasticSIDiseaseModelImpl, StochasticSIRDiseaseModelImpl

public interface StandardDiseaseModel
extends DiseaseModel

This interface defines a class in an EMF model for a Standard disease model.

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

Field Summary
static java.lang.String URI_TYPE_STANDARD_DISEASEMODEL_SEGMENT
          This is the segment of the type URI that prefixes all other segments in a standard disease model type URI.
 
Fields inherited from interface org.eclipse.ohf.stem.diseasemodels.standard.DiseaseModel
URI_TYPE_DISEASEMODEL_SEGMENT
 
Method Summary
 void addToTotalArea(double area)
          Add the area value to the accumlating value for the total area of all Nodes for which this StandardDiseseModel computes StandardDiseaseModelLabel values.
 void addToTotalPopulationCount(double populationCount)
          Add a number of population members to an accumlating value for the total number of population members (in all disease states) for all Nodes for which this StandardDiseseModel computes StandardDiseaseModelLabel values.
 double computeTotalPopulationCountReciprocal()
          Compute and store the reciprocal of the total population count.
 double getTotalArea()
           
 double getTotalPopulationCount()
           
 double getTotalPopulationCountReciprocal()
           
 void setTotalArea(double value)
          Sets the value of the 'Total Area' attribute.
 void setTotalPopulationCount(double value)
          Sets the value of the 'Total Population Count' attribute.
 
Methods inherited from interface org.eclipse.ohf.stem.diseasemodels.standard.DiseaseModel
createDiseaseModelLabel, createDiseaseModelLabelValue, createDiseaseModelState, createInfector, getAdjustedBackgroundMortalityRate, getBackgroundMortalityRate, getDiseaseName, getPopulationIdentifier, getTimePeriod, initializeDiseaseState, initializeDiseaseState, setBackgroundMortalityRate, setDiseaseName, setPopulationIdentifier, setTimePeriod
 
Methods inherited from interface org.eclipse.ohf.stem.core.model.Decorator
decorateGraph, getGraph, getLabelsToUpdate, resetLabels, setGraph, updateLabels
 
Methods inherited from interface org.eclipse.ohf.stem.core.common.Identifiable
getDublinCore, getTypeURI, getURI, sane, setDublinCore, setTypeURI, setURI
 
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
 

Field Detail

URI_TYPE_STANDARD_DISEASEMODEL_SEGMENT

static final java.lang.String URI_TYPE_STANDARD_DISEASEMODEL_SEGMENT
This is the segment of the type URI that prefixes all other segments in a standard disease model type URI.

See Also:
Constant Field Values
Method Detail

addToTotalPopulationCount

void addToTotalPopulationCount(double populationCount)
Add a number of population members to an accumlating value for the total number of population members (in all disease states) for all Nodes for which this StandardDiseseModel computes StandardDiseaseModelLabel values.

Parameters:
populationCount - the number of population members to add to the total
See Also:
getTotalPopulationCount(), setTotalPopulationCount(double)

getTotalPopulationCount

double getTotalPopulationCount()
Returns:
the total number of population members this disease model is processing
See Also:
setTotalPopulationCount(double), addToTotalPopulationCount(double)

setTotalPopulationCount

void setTotalPopulationCount(double value)
Sets the value of the 'Total Population Count' attribute.

Parameters:
value - the new value of the 'Total Population Count' attribute.
See Also:
getTotalPopulationCount()

computeTotalPopulationCountReciprocal

double computeTotalPopulationCountReciprocal()
Compute and store the reciprocal of the total population count. This value only needs to be computed once for each simulation cycle so we store the value so that we don't compute it more than once. This method is called once just before the first cycle, and then again at the end of every cycle when the current total population count has been determined.

Returns:
1/getTotalPopulationCount()
See Also:
getTotalPopulationCountReciprocal()

getTotalPopulationCountReciprocal

double getTotalPopulationCountReciprocal()
Returns:
the reciprocal of the total population count.
See Also:
#computeTotalPopulationReciprocal()

addToTotalArea

void addToTotalArea(double area)
Add the area value to the accumlating value for the total area of all Nodes for which this StandardDiseseModel computes StandardDiseaseModelLabel values.

Parameters:
area - the area to add (km^2)
See Also:
getTotalArea(), setTotalArea(double)

getTotalArea

double getTotalArea()
Returns:
the total area (km^2) occupied by the population whose disease state is processed by this StandardDiseseModel
See Also:
addToTotalArea(double), setTotalArea(double)

setTotalArea

void setTotalArea(double value)
Sets the value of the 'Total Area' attribute.

Parameters:
value - the new value of the 'Total Area' attribute.
See Also:
getTotalArea()