NLHTIVNode

The NLHTIVNode intervention class distributes node-level interventions to nodes when a specific user-defined node event occurs. For example, NLHTIVNode can be configured to have SurveillanceEventCoordinator set to listen for NewInfectionEvents, and then broadcast a node event when a certain number of events is reached, such as distributing IndoorSpaceSpraying to a node with a high number of new infections.

NLHTIVNode is similar to parameter-campaign-node-nodelevelhealthtriggerediv but NLHTIVNode is focused on node interventions and events while NodeLevelHealthTriggeredIV is focused on individual interventions and events.

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	Type	Min	Max	Default	Description
Actual_NodeIntervention_Config	json object	NA	NA	NA	The configuration of the actual node-level intervention sought. This parameter selects a class for the intervention and configures the parameters specific for that intervention class.
Blackout_Event_Trigger	string	NA	NA	"	The node event to broadcast if an intervention cannot be distributed due to the Blackout_Period. Custom events can be added; currently the only built-in value is SheddingComplete.
Blackout_On_First_Occurrence	boolean	0	1	0	If set to true (1), nodes enter the blackout period after the first occurrence of a node event in the Trigger_Condition_List.
Blackout_Period	float	0	3.40E+38	0	The time in days after the initial intervention distribution to wait before distributing the intervention again. If the intervention is not distributable due to the blackout period, it broadcasts the user-defined Blackout_Event_Trigger.
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). Generally used to stop this intervention immediately based on some other event. See IndividualProperties and NodeProperties parameters for more information.
Dont_Allow_Duplicates	boolean	0	1	0	If a node's container has an intervention, set to true (1) to prevent them from receiving another copy of the intervention. Supported by all intervention classes.
Duration	float	-1	3.40E+38	-1	The number of days to continue this intervention. A value of -1 keeps the intervention running indefinitely.
Intervention_Name	string	NA	NA	NLHTIVNode	The optional name used to refer to this intervention as a means to differentiate it from others that use the same class.
New_Property_Value	string	NA	NA	""	An optional NodeProperty key:value pair that will be assigned when the intervention is first updated or applied. See IndividualProperties and NodeProperties parameters for more information.
Node_Property_Restrictions	json object	NA	NA	NA	A list of the NodeProperty key:value pairs, as defined in the demographics file, that are required for nodes to be targeted by the intevention. See IndividualProperties and NodeProperties parameters for more information. See example.
Trigger_Condition_List	array of strings	NA	NA	[ ]	A list of node events that tigger NLHTIVNode to distribute the intervention defined in Actual_NodeIntervention_Config. Currently the only built-in value is SheddingComplete. Custom events may be defined in Custom_Node_Events in the simulation configuration file.

{
    "Events": [
        {
            "comment": "No infections, Negative_Event_Node",
            "class": "CampaignEvent",
            "Start_Day": 1,
            "Nodeset_Config": {
                "class": "NodeSetAll"
            },
            "Event_Coordinator_Config": {
                "class": "StandardInterventionDistributionEventCoordinator",
                "Intervention_Config": {
                    "class": "NLHTIVNode",
                    "Trigger_Condition_List": ["SheddingComplete"],
                    "Duration": 1000,
                    "Blackout_Event_Trigger": "Blackout",
                    "Blackout_Period": 100.0,
                    "Blackout_On_First_Occurrence": 0,
                    "Actual_NodeIntervention_Config": {
                        "class": "EnvironmentalDiagnostic",
                        "Sample_Threshold": 0.0,
                        "Environment_IP_Key_Value": "Risk:High",
                        "Base_Specificity": 1.0,
                        "Base_Sensitivity": 1.0,
                        "Negative_Diagnostic_Event": "Negative_Event_Node",
                        "Positive_Diagnostic_Event": "Positive_Event_Node"
                    }
                }
            }
        }
    ]
}