NodePropertyValueChanger

The NodePropertyValueChanger intervention class sets a given node property to a new value. You can also define a duration in days before the node property reverts back to its original value, the probability that a node will change its node property to the target value, and the number of days over which nodes will attempt to change their individual properties to the target value. This node-level intervention functions in a similar manner as the individual-level intervention, PropertyValueChanger.

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
Daily_Probability	float	0	1	1	The daily probability that the node’s property value changes to the Target_NP_Key_Value.	{ "Intervention_Config": { "class": "NodePropertyValueChanger", "Target_NP_Key_Value": "InterventionStatus:STOP_VACCINATING", "Daily_Probability": 1, "Maximum_Duration": 0, "Revert": 0 } }
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 nodes 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": [ "HasHealthCare:YES" ] }
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	NodePropertyValueChanger	The optional name used to refer to this intervention as a means to differentiate it from others that use the same class.	{ "Intervention_Name": "Diagnostic_Sample" }
Maximum_Duration	float	-1	3.40E+38	3.40E+38	The maximum amount of time in days nodes have to update the property value. This timing works in conjunction with Daily_Probability.	{ "Intervention_Config": { "class": "NodePropertyValueChanger", "Target_NP_Key_Value": "InterventionStatus:STOP_VACCINATING", "Daily_Probability": 1, "Maximum_Duration": 0, "Revert": 0 } }
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" }
Revert	float	0	10000	0	The number of days before the node’s property value reverts back to the initial node property value.	{ "Intervention_Config": { "class": "NodePropertyValueChanger", "Target_NP_Key_Value": "InterventionStatus:STOP_VACCINATING", "Daily_Probability": 1, "Maximum_Duration": 0, "Revert": 0 } }
Target_NP_Key_Value	string	NA	NA	“”	The NodeProperty key:value pair, as defined in the demographics file, to assign to the node.	{ "Target_NP_Key_Value": "InterventionStatus:NONE" }

{
    "Use_Defaults": 1,
    "Events": [{
        "class": "CampaignEvent",
        "Start_Day": 40,
        "Nodeset_Config": {
            "class": "NodeSetAll"
        },
        "Event_Coordinator_Config": {
            "class": "StandardInterventionDistributionEventCoordinator",
            "Node_Property_Restrictions": [{
                "InterventionStatus": "VACCINATING"
            }],
            "Intervention_Config": {
                "class": "NodePropertyValueChanger",
                "Target_NP_Key_Value": "InterventionStatus:STOP_VACCINATING",
                "Daily_Probability": 1.0,
                "Maximum_Duration": 0,
                "Revert": 0
            }
        }
    }]
}