MultiNodeInterventionDistributor#
The MultiNodeInterventionDistributor intervention class is a node-level intervention that distributes multiple other node-level interventions when the distributor only allows specifying one intervention. This class can be thought of as an “adapter,” where it can adapt interventions or coordinators that were designed to distribute one intervention to instead distribute many.
Note
Parameters are case-sensitive. For Boolean parameters, set to 1 for true or 0 for false. Minimum, maximum, or default values of “NA” indicate that those values are not applicable for that parameter.
EMOD does not use true defaults; that is, if the dependency relationships indicate that a parameter is required, you must supply a value for it. However, many of the tools used to work with EMOD will use the default values provided below.
JSON format does not permit comments, but you can add “dummy” parameters to add contextual information to your files. Any keys that are not EMOD parameter names will be ignored by the model.
The table below describes all possible parameters with which this class can be configured. The JSON example that follows shows one potential configuration.
Parameter |
Data type |
Minimum |
Maximum |
Default |
Description |
Example |
---|---|---|---|---|---|---|
Disqualifying_Properties |
array of strings |
NA |
NA |
[] |
A list of NodeProperty key:value pairs that cause an intervention to be aborted (persistent interventions will stop being distributed to individuals with these values). See NodeProperties and IndividualProperties parameters for more information. Generally used to control the flow of health care access. For example, to prevent the same individual from accessing health care via two different routes at the same time. |
{
"Disqualifying_Properties": [
"InterventionStatus:LostForever"
]
}
|
Dont_Allow_Duplicates |
boolean |
0 |
1 |
0 |
If an individual’s container has an intervention, set to true (1) to prevent them from receiving another copy of the intervention. Supported by all intervention classes. |
{
"Dont_Allow_Duplicates": 0
}
|
Intervention_Name |
string |
NA |
NA |
MultiNodeInterventionDistributor |
The optional name used to refer to this intervention as a means to differentiate it from others that use the same class. |
{
"Intervention_Config": {
"class": "MultiNodeInterventionDistributor",
"Intervention_Name": "Country-wide vaccination"
}
}
|
New_Property_Value |
string |
NA |
NA |
“” |
An optional NodeProperty key:value pair that will be assigned when the intervention is applied. See NodeProperties and IndividualProperties parameters for more information. |
{
"New_Property_Value": "HasHealthCare:YES"
}
|
Node_Intervention_List |
array of json objects |
NA |
NA |
NA |
A list of nested JSON objects for the multi-node-level interventions to be distributed by this intervention. |
{
"Intervention_Config": {
"Node_Intervention_List": [
{
"Cost_To_Consumer": 1,
"Habitat_Target": "ALL_HABITATS",
"Killing_Config": {
"Decay_Time_Constant": 90,
"Initial_Effect": 1,
"class": "WaningEffectExponential"
},
"class": "SpaceSpraying"
},
{
"Daily_Probability": 1,
"Maximum_Duration": 0,
"Revert": 90,
"Target_NP_Key_Value": "InterventionStatus:RECENT_SPRAY",
"class": "NodePropertyValueChanger"
}
],
"class": "MultiNodeInterventionDistributor"
}
}
|
{
"Intervention_Config": {
"class": "MultiNodeInterventionDistributor",
"Node_Intervention_List": [
{
"class": "SpaceSpraying",
"Cost_To_Consumer": 1.0,
"Habitat_Target": "ALL_HABITATS",
"Spray_Kill_Target": "SpaceSpray_Indoor",
"Killing_Config": {
"class": "WaningEffectExponential",
"Initial_Effect": 1.0,
"Decay_Time_Constant": 90
},
"Reduction_Config": {
"class": "WaningEffectExponential",
"Initial_Effect": 1.0,
"Decay_Time_Constant": 90
}
},
{
"class": "NodePropertyValueChanger",
"Target_NP_Key_Value": "InterventionStatus:RECENT_SPRAY",
"Daily_Probability": 1.0,
"Maximum_Duration": 0,
"Revert": 90
}
]
}
}