BroadcastCoordinatorEvent

Note

This campaign class and associated parameters are currently in beta release and have not yet been fully tested.

The BroadcastCoordinatorEvent coordinator class broadcasts the event you specify. This can be used with the campaign class, SurveillanceEventCoordinator, that can monitor and listen for events received from BroadcastCoordinatorEvent and then perform an action based on the broadcasted event. You can also use this for the reporting of the broadcasted events by setting the configuraton parameters, Report_Node_Event_Recorder and Report_Surveillance_Event_Recorder, which listen to events to be recorded. You must use this coordinator class 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 name of the event to be broadcast. This event must be set in the Custom_Coordinator_Events configuration parameter. This cannot be assigned an empty string for the event.	{ "class": "CampaignEvent", "Start_Day": 5, "Nodeset_Config": { "class": "NodeSetAll" }, "Event_Coordinator_Config": { "class": "BroadcastCoordinatorEvent", "Coordinator_Name": "Coordnator_1", "Cost_To_Consumer": 10, "Broadcast_Event": "Coordinator_Event_1" } }
Coordinator_Name	string	NA	NA	NA	The unique identifying coordinator name, which is useful with the output report, ReportCoordinatorEventRecorder.csv.	{ "class": "CampaignEvent", "Start_Day": 25, "Nodeset_Config": { "class": "NodeSetAll" }, "Event_Coordinator_Config": { "class": "BroadcastCoordinatorEvent", "Coordinator_Name": "Coordinator_3", "Cost_To_Consumer": 30, "Broadcast_Event": "Coordinator_Event_3" } }
Cost_To_Consumer	float	0	3.40282e+38	0	The unit cost of broadcasting the event.	{ "class": "CampaignEvent", "Start_Day": 15, "Nodeset_Config": { "class": "NodeSetAll" }, "Event_Coordinator_Config": { "class": "BroadcastCoordinatorEvent", "Coordinator_Name": "Coordnator_2", "Cost_To_Consumer": 20, "Broadcast_Event": "Coordinator_Event_2" } }

{
    "Events": [

        {
            "comment": "Broadcast Event to start Surveillance",
            "class": "CampaignEvent",
            "Start_Day": 2,
            "Nodeset_Config": { "class": "NodeSetAll" },
            "Event_Coordinator_Config": {
                "class": "BroadcastCoordinatorEvent",
                "Coordinator_Name" : "Coordnator_1",
                "Cost_To_Consumer" : 10,
                "Broadcast_Event" : "Start_ACF"
            }
        },
        {
            "comment": "Triggered by Broadcast_Event, stops itself by broadcasting Start_SIA_X Event",
            "class": "CampaignEvent",
            "Start_Day": 1,
            "Nodeset_Config": { "class": "NodeSetAll" },
            "Event_Coordinator_Config": {
                "class": "SurveillanceEventCoordinator",
                "Coordinator_Name" : "ACF_Counter",
                "Start_Trigger_Condition_List" : [ "Start_ACF" ],
                "Stop_Trigger_Condition_List" : [ 
                    "Start_SIA_2", 
                    "Start_SIA_4"
                ],
                "Duration" : -1,
                "Incidence_Counter" : {
                    "Counter_Type" : "PERIODIC",
                    "Counter_Period" : 365,
                    "Counter_Event_Type" : "INDIVIDUAL",
                    "Trigger_Condition_List" : ["HappyBirthday"],
                    "Node_Property_Restrictions" : [],
                    "Property_Restrictions_Within_Node" : [],
                    "Target_Demographic": "Everyone",
                    "Demographic_Coverage" : 1.0
                },
                "Responder" : {
                    "Threshold_Type" : "COUNT",
                    "Action_List" :
                    [
                        {
                            "Threshold" : 8,
                            "Event_Type" : "COORDINATOR",
                            "Event_To_Broadcast" : "Ind_Start_SIA_2"
                        },
                        {
                            "Threshold" : 5,
                            "Event_Type" : "COORDINATOR",
                            "Event_To_Broadcast" : "Ind_Start_SIA_4"
                        }
                    ]
                }
            }            
        }
    ],
    "Use_Defaults": 1
}