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

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

public interface DiseaseModelLabelValue
extends LabelValue

This interface defines a class in an EMF model for an disease model label value. The values of this label record the number of population members who have been "born" and who have "died".


Method Summary
 DiseaseModelLabelValue add(DiseaseModelLabelValue value)
          Add the value of this disease model label to the value
 double getBirths()
           
 double getDeaths()
           
 double getDiseaseDeaths()
           
 double getPopulationCount()
           
 DiseaseModelLabelValue scale(double scaleFactor)
          Multiply the values by a scale factor.
 DiseaseModelLabelValue set(DiseaseModelLabelValue value)
          Set the value of this disease model label to be the same as the value
 void setBirths(double value)
          Sets the value of the 'Births' attribute.
 void setDeaths(double value)
          Sets the value of the 'Deaths' attribute.
 void setDiseaseDeaths(double value)
          Sets the value of the 'Disease Deaths' attribute.
 DiseaseModelLabelValue sub(DiseaseModelLabelValue value)
          Subtract the value of the passed disease model label value from this disease model label to the value.
 void zeroOutPopulationCount()
          Set all population values in all states to zero.
 
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

getBirths

double getBirths()
Returns:
the number of population members who have been born

setBirths

void setBirths(double value)
Sets the value of the 'Births' attribute.

Parameters:
value - the new value of the 'Births' attribute.
See Also:
getBirths()

getDeaths

double getDeaths()
Returns:
the number of population members who have died

setDeaths

void setDeaths(double value)
Sets the value of the 'Deaths' attribute.

Parameters:
value - the new value of the 'Deaths' attribute.
See Also:
getDeaths()

getDiseaseDeaths

double getDiseaseDeaths()
Returns:
the number of population members who have died due to the disease being modeled

setDiseaseDeaths

void setDiseaseDeaths(double value)
Sets the value of the 'Disease Deaths' attribute.

Parameters:
value - the new value of the 'Disease Deaths' attribute.
See Also:
getDiseaseDeaths()

set

DiseaseModelLabelValue set(DiseaseModelLabelValue value)
Set the value of this disease model label to be the same as the value

Parameters:
value - the new value for this disease model value
Returns:
this instance with the new values

add

DiseaseModelLabelValue add(DiseaseModelLabelValue value)
Add the value of this disease model label to the value

Parameters:
value - the value to be added to this disease model value
Returns:
this instance with the sum of values

sub

DiseaseModelLabelValue sub(DiseaseModelLabelValue value)
Subtract the value of the passed disease model label value from this disease model label to the value.

Parameters:
value - the value to be added to this disease model value
Returns:
this instance with the difference of values

scale

DiseaseModelLabelValue scale(double scaleFactor)
Multiply the values by a scale factor.

Parameters:
scaleFactor - the mulitplier
Returns:
this instance with the new scaled values

getPopulationCount

double getPopulationCount()
Returns:
the sum of the living population members in all states

zeroOutPopulationCount

void zeroOutPopulationCount()
Set all population values in all states to zero.