|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DiseaseModel
This interface defines a class in an EMF model for an STEM Disease model. It is the top-level disease model, all other disease models derive from this class.
Field Summary | |
---|---|
static java.lang.String |
URI_TYPE_DISEASEMODEL_SEGMENT
This is the segment of the type URI that prefixes all other segments in a disease model type URI. |
Method Summary | |
---|---|
DiseaseModelLabel |
createDiseaseModelLabel()
|
DiseaseModelLabelValue |
createDiseaseModelLabelValue()
|
DiseaseModelState |
createDiseaseModelState()
|
Infector |
createInfector()
|
double |
getAdjustedBackgroundMortalityRate(long timeDelta)
Compute the background mortality rate adjusted for a time delta potentially different from the time period specified for the rate. |
double |
getBackgroundMortalityRate()
This is the "background" rate (i.e., in the abscence of disease) at which population members (on average) transition from all of the other states (except Pre-Born and including Infectious) to the state Dead, per time period. |
java.lang.String |
getDiseaseName()
This is the name of the disease |
java.lang.String |
getPopulationIdentifier()
This is the identifier of the population being infected by a Disease. |
long |
getTimePeriod()
The time period for the specified rates. |
void |
initializeDiseaseState(DiseaseModelLabel diseaseModelLabel)
|
DiseaseModelState |
initializeDiseaseState(DiseaseModelState diseaseModelState,
DiseaseModelLabel diseaseModelLabel)
|
void |
setBackgroundMortalityRate(double value)
Sets the value of the ' Background Mortality Rate ' attribute. |
void |
setDiseaseName(java.lang.String value)
Sets the value of the ' Disease Name ' attribute. |
void |
setPopulationIdentifier(java.lang.String value)
Sets the value of the ' Population Identifier ' attribute. |
void |
setTimePeriod(long value)
Sets the value of the ' Time Period ' attribute. |
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 |
---|
static final java.lang.String URI_TYPE_DISEASEMODEL_SEGMENT
Method Detail |
---|
double getBackgroundMortalityRate()
#getInfectiousMortality()
.
1/mortalityRate is the average life span in time periods, on average,
that is takes for a population member to die from any state.
In typical models, the background mortality rate is specified to be the
same as the "birth rate" to keep the population fixed.
void setBackgroundMortalityRate(double value)
Background Mortality Rate
' attribute.
value
- the new value of the 'Background Mortality Rate' attribute.getBackgroundMortalityRate()
double getAdjustedBackgroundMortalityRate(long timeDelta)
timeDelta
- the time period (milliseconds) to which the rate is to be
adjusted.
java.lang.String getDiseaseName()
void setDiseaseName(java.lang.String value)
Disease Name
' attribute.
value
- the new value of the 'Disease Name' attribute.getDiseaseName()
java.lang.String getPopulationIdentifier()
void setPopulationIdentifier(java.lang.String value)
Population Identifier
' attribute.
value
- the new value of the 'Population Identifier' attribute.getPopulationIdentifier()
long getTimePeriod()
void setTimePeriod(long value)
Time Period
' attribute.
value
- the new value of the 'Time Period' attribute.getTimePeriod()
DiseaseModelLabel createDiseaseModelLabel()
DiseaseModelLabelValue createDiseaseModelLabelValue()
DiseaseModelState createDiseaseModelState()
DiseaseModelState initializeDiseaseState(DiseaseModelState diseaseModelState, DiseaseModelLabel diseaseModelLabel)
diseaseModelState
- the state information to be initializeddiseaseModelLabel
- the label to use to initialize the state information
void initializeDiseaseState(DiseaseModelLabel diseaseModelLabel)
diseaseModelLabel
- the label to use to initialize the state informationInfector createInfector()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |