BroadcastCoordinatorEventFromNode

The BroadcastCoordinatorEventFromNode is node-level intervention that broadcasts an event for coordinators. For example, if a death occurs in a node, an event can be broadcasted that will trigger some sort of response by the healthcare system. NodeLevelHealthTriggeredIV could be used to listen for the death of an individual and distribute this intervention to the node. The node intervention could then broadcast its event that a TriggeredEventCoordinator is listening for. One can use the Report_Coordinator_Event_Recorder to report on the events broadcasted by this intervention. Note, this coordinator class must be used with listeners that are operating on the same core. For more information, see Simulation core components.

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
Broadcast_Event	string	NA	NA	“”	The Coordinator Event to be broadcasted by this node. An event coordinator like TriggeredEventCoordinator could be activated from this event. Custom events may be defined in Custom_Coordinator_Events in the simulation configuration file.	{ "Broadcast_Event": "My_Event" }
Disqualifying_Properties	array of strings	NA	NA	[]	A list of NodeProperty key:value pairs that causes the intervention not to be distributed to the node or aborted (stopped before it could be applied). See NodeProperties and IndividualProperties parameters for more information.	{ "Disqualifying_Properties": [ "HasHealthCare:WILL_NEVER_HAVE" ] }
Dont_Allow_Duplicates	boolean	0	1	0	If a node’s container has an intervention, set to true (1) to prevent it from receiving another copy of the intervention. Supported by all intervention classes.	{ "Dont_Allow_Duplicates": 0 }
Intervention_Name	string	NA	NA	BroadcastCoordinatorEventFromNode	The optional name used to refer to this intervention as a means to differentiate it from others that use the same class.	{ "Intervention_Config": { "Intervention_Name": "Coordinator Event 1", "class": "BroadcastCoordinatorEventFromNode" } }
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" }

{
    "Events": [
        {
            "class": "CampaignEventByYear",
            "Start_Year": 1990.0,
            "Nodeset_Config": {
                "class": "NodeSetAll"
            },
            "Event_Coordinator_Config": {
                "class": "StandardInterventionDistributionEventCoordinator",
                "Intervention_Config": {
                    "class": "NodeLevelHealthTriggeredIV",
                    "Trigger_Condition_List": [
                        "NonDiseaseDeaths",
                        "DiseaseDeaths"
                    ],
                    "Demographic_Coverage": 1.0,
                    "Actual_NodeIntervention_Config": {
                        "class": "BroadcastCoordinatorEventFromNode",
                        "Broadcast_Event" : "Distribute_Vaccine"
                    }
                }
            }
        },
        {
            "class": "CampaignEventByYear",
            "Start_Year": 1990.0,
            "Nodeset_Config": {
                "class": "NodeSetAll"
            },
            "Event_Coordinator_Config": {
                "class": "TriggeredEventCoordinator",
                "Coordinator_Name": "VaccineDistributor",
                "Start_Trigger_Condition_List": [ "Distribute_Vaccine" ],
                "Stop_Trigger_Condition_List": [],
                "Number_Repetitions": 1,
                "Target_Demographic": "Everyone",
                "Demographic_Coverage": 0.5,
                "Intervention_Config": {
                    "class": "SimpleVaccine",
                    "Cost_To_Consumer": 2,
                    "Vaccine_Take": 1,
                    "Vaccine_Type": "AcquisitionBlocking",
                    "Waning_Config": {
                        "class": "WaningEffectBox",
                        "Initial_Effect": 1.0,
                        "Box_Duration": 100
                    }
                },
                "Completion_Event": "Vaccine_Was_Distributed"
            }
        }
    ],
    "Use_Defaults": 1
}