TriggeredEventCoordinator#

The TriggeredEventCoordinator coordinator class listens for trigger events, begins a series of repetitions of intervention distributions, and then broadcasts an event upon completion. This campaign event is typically used with other classes that broadcast and distribute events, such as BroadcastCoordinatorEvent, DelayEventCoordinator, and SurveillanceEventCoordinator.

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

Completion_Event

array of strings

NA

NA

NA

The completion event list that will be broadcast every time the triggered event coordinator completes a set of repetitions. The events contained in the list are defined in Custom_Coordinator_Events in the simulation configuration file.

 
{
  "Event_Coordinator_Config": {
    "class": "TriggeredEventCoordinator",
    "Coordinator_Name": "1n2_Vaccinator",
    "Start_Trigger_Condition_List": [
      "Start_Vaccinating_1n2"
    ],
    "Stop_Trigger_Condition_List": [],
    "Number_Repetitions": 1,
    "Timesteps_Between_Repetitions": 1,
    "Duration": -1,
    "Target_Demographic": "Everyone",
    "Demographic_Coverage": 0.05,
    "Intervention_Config": {
      "class": "SimpleVaccine",
      "Cost_To_Consumer": 1,
      "Vaccine_Take": 1,
      "Vaccine_Type": "AcquisitionBlocking",
      "Waning_Config": {
        "class": "WaningEffectBox",
        "Initial_Effect": 0.59,
        "Box_Duration": 730
      }
    },
    "Completion_Event": "Done_Vaccinating_1n2"
  }
}

Coordinator_Name

string

NA

NA

TriggeredEventCoordinator

The unique identifying coordinator name used to identify the different coordinators in reports.

 
{
  "Event_Coordinator_Config": {
    "Completion_Event": "Done_Vaccinating_1n2",
    "Coordinator_Name": "1n2_Vaccinator",
    "Demographic_Coverage": 0.05,
    "Duration": -1,
    "Intervention_Config": {
      "Cost_To_Consumer": 1,
      "Vaccine_Take": 1,
      "Vaccine_Type": "AcquisitionBlocking",
      "Waning_Config": {
        "Box_Duration": 730,
        "Initial_Effect": 0.59,
        "class": "WaningEffectBox"
      },
      "class": "SimpleVaccine"
    },
    "Number_Repetitions": 1,
    "Start_Trigger_Condition_List": [
      "Start_Vaccinating_1n2"
    ],
    "Stop_Trigger_Condition_List": [],
    "Target_Demographic": "Everyone",
    "Timesteps_Between_Repetitions": 1,
    "class": "TriggeredEventCoordinator"
  }
}

Demographic_Coverage

float

0

1

1

The fraction of individuals in the target demographic that will receive this intervention.

Duration

float

-1

3.40282e+38

-1

The time period (in days) that the triggered event coordinator is active before it expires. Once the specified duration has been reached the coordinator will expire whether or not it is in the middle of a set of repetitions. The value of -1 (default) equals to never expire.

 
{
  "Event_Coordinator_Config": {
    "Completion_Event": "Done_Vaccinating_1n2",
    "Coordinator_Name": "1n2_Vaccinator",
    "Demographic_Coverage": 0.05,
    "Duration": -1,
    "Intervention_Config": {
      "Cost_To_Consumer": 1,
      "Vaccine_Take": 1,
      "Vaccine_Type": "AcquisitionBlocking",
      "Waning_Config": {
        "Box_Duration": 730,
        "Initial_Effect": 0.59,
        "class": "WaningEffectBox"
      },
      "class": "SimpleVaccine"
    },
    "Number_Repetitions": 1,
    "Start_Trigger_Condition_List": [
      "Start_Vaccinating_1n2"
    ],
    "Stop_Trigger_Condition_List": [],
    "Target_Demographic": "Everyone",
    "Timesteps_Between_Repetitions": 1,
    "class": "TriggeredEventCoordinator"
  }
}

Individual_Selection_Type

enum

NA

NA

DEMOGRAPHIC_COVERAGE

Defines how the people that pass all of the other target restrictions are selected.

Possible values are:

DEMOCGRAPHIC_COVERAGE

When set, the parameter Demographic_Coverage is used to randomly select a certain percentage of the targeted group.

TARGET_NUM_INDIVIDUALS

When set, the parameter Target_Num_Individuals is used to select exactly that number of people out of the targeted group.

Intervention_Config

json object

NA

NA

NA

The nested JSON of the intervention to be distributed by this event coordinator.

 
{
  "Event_Coordinator_Config": {
    "Completion_Event": "Done_Vaccinating_1n2",
    "Coordinator_Name": "1n2_Vaccinator",
    "Demographic_Coverage": 0.05,
    "Duration": -1,
    "Intervention_Config": {
      "Cost_To_Consumer": 1,
      "Vaccine_Take": 1,
      "Vaccine_Type": "AcquisitionBlocking",
      "Waning_Config": {
        "Box_Duration": 730,
        "Initial_Effect": 0.59,
        "class": "WaningEffectBox"
      },
      "class": "SimpleVaccine"
    },
    "Number_Repetitions": 1,
    "Start_Trigger_Condition_List": [
      "Start_Vaccinating_1n2"
    ],
    "Stop_Trigger_Condition_List": [],
    "Target_Demographic": "Everyone",
    "Timesteps_Between_Repetitions": 1,
    "class": "TriggeredEventCoordinator"
  }
}

Node_Property_Restrictions

array of json objects

NA

NA

NA

A list of the NodeProperty key:value pairs, as defined in the demographics file, that nodes must have to be targeted by the intervention. See NodeProperties and IndividualProperties parameters for more information. You can specify AND and OR combinations of key:value pairs with this parameter.

The following configuration restrictions the intervention to nodes that are urban and high risk or have had the first round treatment and are low risk.

{
  "Event_Coordinator_Config": {
    "Completion_Event": "Done_Vaccinating_3n4",
    "Coordinator_Name": "3n4_Vaccinator",
    "Demographic_Coverage": 0.05,
    "Duration": -1,
    "Intervention_Config": {
      "Cost_To_Consumer": 2,
      "Vaccine_Take": 1,
      "Vaccine_Type": "AcquisitionBlocking",
      "Waning_Config": {
        "Box_Duration": 730,
        "Initial_Effect": 0.59,
        "class": "WaningEffectBox"
      },
      "class": "SimpleVaccine"
    },
    "Node_Property_Restrictions": [
      {
        "Place": "Urban",
        "Risk": "High"
      },
      {
        "InterventionStatus": "FirstRound",
        "Risk": "Low"
      }
    ],
    "Number_Repetitions": 3,
    "Property_Restrictions_Within_Node": [],
    "Start_Trigger_Condition_List": [
      "Start_Vaccinating_3n4"
    ],
    "Stop_Trigger_Condition_List": [
      "Stop_Vaccinating_3n4"
    ],
    "Target_Demographic": "Everyone",
    "Timesteps_Between_Repetitions": 10,
    "class": "TriggeredEventCoordinator"
  }
}

Number_Repetitions

integer

-1

10000

1

The number of times an intervention is given, used with Timesteps_Between_Repetitions. A value of -1 implies an infinite number of repetitions.

 
{
  "Event_Coordinator_Config": {
    "Completion_Event": "Done_Vaccinating_3n4",
    "Coordinator_Name": "3n4_Vaccinator",
    "Demographic_Coverage": 0.05,
    "Duration": -1,
    "Intervention_Config": {
      "Cost_To_Consumer": 2,
      "Vaccine_Take": 1,
      "Vaccine_Type": "AcquisitionBlocking",
      "Waning_Config": {
        "Box_Duration": 730,
        "Initial_Effect": 0.59,
        "class": "WaningEffectBox"
      },
      "class": "SimpleVaccine"
    },
    "Number_Repetitions": 3,
    "Start_Trigger_Condition_List": [
      "Start_Vaccinating_3n4"
    ],
    "Stop_Trigger_Condition_List": [
      "Stop_Vaccinating_3n4"
    ],
    "Target_Demographic": "Everyone",
    "Timesteps_Between_Repetitions": 10,
    "class": "TriggeredEventCoordinator"
  }
}

Property_Restrictions

array of json objects

NA

NA

NA

A list of the IndividualProperty key:value pairs, as defined in the demographics file, that individuals must have to be targeted by this intervention. See NodeProperties and IndividualProperties parameters for more information.

To specify AND and OR combinations of key:value pairs, use Property_Restrictions_Within_Node. You cannot use both of these parameters in the same event coordinator.

 
{
  "Property_Restrictions": [
    "Risk:HIGH"
  ]
}

Property_Restrictions_Within_Node

array of json objects

NA

NA

NA

A list of the IndividualProperty key:value pairs, as defined in the demographics file, that individuals must have to be targeted by this intervention. See NodeProperties and IndividualProperties parameters for more information.

This parameter allows you to specify AND and OR combinations of key:value pairs. You may specify individual property restrictions using either this parameter or Property_Restrictions, but not both.

The following example restricts the intervention to individuals who are urban and high risk or urban and medium risk.

{
  "Property_Restrictions_Within_Node": [
    {
      "Geographic": "URBAN",
      "Risk": "HIGH"
    },
    {
      "Geographic": "URBAN",
      "Risk": "MEDIUM"
    }
  ]
}

Start_Trigger_Condition_List

array of strings

NA

NA

NA

The trigger condition event list that when heard will start a new set of repetitions for the triggered event coordinator. The list cannot be empty. The events contained in the list are defined in Custom_Coordinator_Events in the simulation configuration file.

 
{
  "Event_Coordinator_Config": {
    "Completion_Event": "Done_Vaccinating_1n2",
    "Coordinator_Name": "1n2_Vaccinator",
    "Demographic_Coverage": 0.05,
    "Duration": -1,
    "Intervention_Config": {
      "Cost_To_Consumer": 1,
      "Vaccine_Take": 1,
      "Vaccine_Type": "AcquisitionBlocking",
      "Waning_Config": {
        "Box_Duration": 730,
        "Initial_Effect": 0.59,
        "class": "WaningEffectBox"
      },
      "class": "SimpleVaccine"
    },
    "Number_Repetitions": 1,
    "Start_Trigger_Condition_List": [
      "Start_Vaccinating_1n2"
    ],
    "Stop_Trigger_Condition_List": [],
    "Target_Demographic": "Everyone",
    "Timesteps_Between_Repetitions": 1,
    "class": "TriggeredEventCoordinator"
  }
}

Stop_Trigger_Condition_List

array of strings

NA

NA

NA

The trigger condition event list that when heard will stop any repetitions for the triggered event coordinator until a start trigger condition event list is received. The list can be empty. The events contained in the list are defined in Custom_Coordinator_Events in the simulation configuration file.

 
{
  "Event_Coordinator_Config": {
    "Completion_Event": "Done_Vaccinating_1n2",
    "Coordinator_Name": "1n2_Vaccinator",
    "Demographic_Coverage": 0.05,
    "Duration": -1,
    "Intervention_Config": {
      "Cost_To_Consumer": 1,
      "Vaccine_Take": 1,
      "Vaccine_Type": "AcquisitionBlocking",
      "Waning_Config": {
        "Box_Duration": 730,
        "Initial_Effect": 0.59,
        "class": "WaningEffectBox"
      },
      "class": "SimpleVaccine"
    },
    "Number_Repetitions": 1,
    "Start_Trigger_Condition_List": [
      "Start_Vaccinating_1n2"
    ],
    "Stop_Trigger_Condition_List": [],
    "Target_Demographic": "Everyone",
    "Timesteps_Between_Repetitions": 1,
    "class": "TriggeredEventCoordinator"
  }
}

Target_Age_Max

float

0

9.3228e+35

9.3228e+35

The upper end of ages targeted for an intervention, in years. Used when Target_Demographic is set to ExplicitAgeRanges or ExplicitAgeRangesAndGender.

 
{
  "Target_Age_Max": 20,
  "Target_Age_Min": 10,
  "Target_Demographic": "ExplicitAgeRanges"
}

Target_Age_Min

float

0

9.3228e+35

0

The lower end of ages targeted for an intervention, in years. Used when Target_Demographic is set to ExplicitAgeRanges or ExplicitAgeRangesAndGender.

 
{
  "Target_Age_Max": 20,
  "Target_Age_Min": 10,
  "Target_Demographic": "ExplicitAgeRanges"
}

Target_Demographic

enum

NA

NA

Everyone

The target demographic group. Possible values are:

  • Everyone

  • ExplicitAgeRanges

  • ExplicitAgeRangesAndGender

  • ExplicitGender

  • ExplicitDiseaseState

 
{
  "Target_Age_Max": 20,
  "Target_Age_Min": 10,
  "Target_Demographic": "ExplicitAgeRanges"
}

Target_Gender

enum

NA

NA

All

Specifies the gender restriction for the intervention. Possible values are:

  • Male

  • Female

  • All

 
{
  "Target_Gender": "Female"
}

Target_Num_Individuals

integer

0

2147480000.0

1

The exact number of people to select out of the targeted group. Individual_Selection_Type must be set to TARGET_NUM_INDIVIDUALS.

Target_Residents_Only

boolean

0

1

0

When set to true (1), the intervention is only distributed to individuals that began the simulation in the node (i.e. those that claim the node as their residence).

 
{
  "Target_Residents_Only": 1
}

Targeting_Config

json object

NA

NA

NA

Be more selective of individuals by using the Targeting_Config classes.

 
{
  "Targeting_Config": {
    "class": "HasIntervention",
    "Is_Equal_To": 0,
    "Intervention_Name": "MyVaccine"
  }
}

Timesteps_Between_Repetitions

integer

-1

10000

-1

The repetition interval.

 
{
  "Event_Coordinator_Config": {
    "Completion_Event": "Done_Vaccinating_1n2",
    "Coordinator_Name": "1n2_Vaccinator",
    "Demographic_Coverage": 0.05,
    "Duration": -1,
    "Intervention_Config": {
      "Cost_To_Consumer": 1,
      "Vaccine_Take": 1,
      "Vaccine_Type": "AcquisitionBlocking",
      "Waning_Config": {
        "Box_Duration": 730,
        "Initial_Effect": 0.59,
        "class": "WaningEffectBox"
      },
      "class": "SimpleVaccine"
    },
    "Number_Repetitions": 1,
    "Start_Trigger_Condition_List": [
      "Start_Vaccinating_1n2"
    ],
    "Stop_Trigger_Condition_List": [],
    "Target_Demographic": "Everyone",
    "Timesteps_Between_Repetitions": 1,
    "class": "TriggeredEventCoordinator"
  }
}

{    
    "Events": [
        {
            "class": "CampaignEvent",
            "Start_Day": 1,
            "Nodeset_Config": {
                "class": "NodeSetAll"
            },
            "Event_Coordinator_Config": {
                "class": "StandardInterventionDistributionEventCoordinator",
                "Target_Demographic": "Everyone",
                "Demographic_Coverage": 0.25,
                "Intervention_Config": {
                    "class": "OutbreakIndividual",
                    "Incubation_Period_Override": 0,
                    "Antigen": 0,
                    "Genome": 0
                }
            }
        },
        {
            "class": "CampaignEvent",
            "Start_Day": 0,
            "Nodeset_Config": {
                "class": "NodeSetNodeList",
                "Node_List": [ 1, 2 ]
            },
            "Event_Coordinator_Config": {
                "class": "TriggeredEventCoordinator",
                "Coordinator_Name": "1n2_Vaccinator",
                "Start_Trigger_Condition_List": [ "Start_Vaccinating_1n2" ],
                "Stop_Trigger_Condition_List": [],
                "Number_Repetitions": 1,
                "Timesteps_Between_Repetitions": 1,
                "Duration": -1,
                "Target_Demographic": "Everyone",
                "Node_Property_Restrictions": [],
                "Property_Restrictions_Within_Node": [],
                "Demographic_Coverage": 0.05,
                "Intervention_Config": {
                   "class": "SimpleVaccine",
                   "Cost_To_Consumer": 1,
                   "Vaccine_Take": 1,
                   "Vaccine_Type": "AcquisitionBlocking",
                   "Waning_Config": {
                      "class": "WaningEffectBox",
                      "Initial_Effect": 0.59,
                      "Box_Duration": 730
                   }
                },
                "Completion_Event": "Done_Vaccinating_1n2"
            }
        },        
        {
            "class": "CampaignEvent",
            "Start_Day": 0,
            "Nodeset_Config": {
                "class": "NodeSetNodeList",
                "Node_List": [ 1, 2 ]
            },
            "Event_Coordinator_Config": {
                "class": "TriggeredEventCoordinator",
                "Coordinator_Name": "1n2_Party",
                "Start_Trigger_Condition_List": [ "Done_Vaccinating_1n2" ],
                "Stop_Trigger_Condition_List": [],
                "Number_Repetitions": 1,
                "Timesteps_Between_Repetitions": 1,
                "Duration": -1,
                "Target_Demographic": "Everyone",
                "Node_Property_Restrictions": [],
                "Property_Restrictions_Within_Node": [],
                "Demographic_Coverage": 0.05,
                "Intervention_Config": {
                   "class": "BroadcastEvent",
                   "Cost_To_Consumer": 1,
                   "Broadcast_Event" : "Individual_Celebrate_1n2"
                },
                "Completion_Event": "Done_Celebrating_1n2"
            }
        },        
        {
            "class": "CampaignEvent",
            "Start_Day": 0,
            "Nodeset_Config": {
                "class": "NodeSetNodeList",
                "Node_List": [ 3, 4 ]
            },
            "Event_Coordinator_Config": {
                "class": "TriggeredEventCoordinator",
                "Coordinator_Name": "3n4_Party",
                "Start_Trigger_Condition_List": [ "Done_Vaccinating_3n4" ],
                "Stop_Trigger_Condition_List": [],
                "Number_Repetitions": 1,
                "Timesteps_Between_Repetitions": 1,
                "Duration": -1,
                "Target_Demographic": "Everyone",
                "Node_Property_Restrictions": [],
                "Property_Restrictions_Within_Node": [],
                "Demographic_Coverage": 0.05,
                "Intervention_Config": {
                   "class": "BroadcastEvent",
                   "Cost_To_Consumer": 1,
                   "Broadcast_Event" : "Individual_Celebrate_3n4"
                },
                "Completion_Event": "Done_Celebrating_3n4"
            }
        },        
        {
            "class": "CampaignEvent",
            "Start_Day": 0,
            "Nodeset_Config": {
                "class": "NodeSetNodeList",
                "Node_List": [ 3,4 ]
            },
            "Event_Coordinator_Config": {
                "class": "TriggeredEventCoordinator",
                "Coordinator_Name": "3n4_Vaccinator",
                "Start_Trigger_Condition_List": [ "Start_Vaccinating_3n4" ],
                "Stop_Trigger_Condition_List": ["Stop_Vaccinating_3n4"],
                "Number_Repetitions": 1,
                "Timesteps_Between_Repetitions": 11,
                "Duration": -1,
                "Target_Demographic": "Everyone",
                "Node_Property_Restrictions": [],
                "Property_Restrictions_Within_Node": [],
                "Demographic_Coverage": 0.05,
                "Intervention_Config": {
                   "class": "SimpleVaccine",
                   "Cost_To_Consumer": 2,
                   "Vaccine_Take": 1,
                   "Vaccine_Type": "AcquisitionBlocking",
                   "Waning_Config": {
                      "class": "WaningEffectBox",
                      "Initial_Effect": 0.59,
                      "Box_Duration": 730
                   }
                },
                "Completion_Event": "Done_Vaccinating_3n4"
            }
        },        
        {
            "class": "CampaignEvent",
            "Start_Day": 5,
            "Nodeset_Config": {
                "class": "NodeSetNodeList",
                "Node_List": [ 1, 2 ]
            },
            "Event_Coordinator_Config": {
                "class": "BroadcastCoordinatorEvent",
                "Coordinator_Name" : "Start_Coordnator_1n2",
                "Cost_To_Consumer" : 100,
                "Broadcast_Event" : "Start_Vaccinating_1n2"
            }
        },
        {
            "class": "CampaignEvent",
            "Start_Day": 20,
            "Nodeset_Config": {
                "class": "NodeSetNodeList",
                "Node_List": [ 3, 4 ]
            },
            "Event_Coordinator_Config": {
                "class": "BroadcastCoordinatorEvent",
                "Coordinator_Name" : "Start_Coordnator_3n4",
                "Cost_To_Consumer" : 200,
                "Broadcast_Event" : "Start_Vaccinating_3n4"
            }
        }
    ],
    "Use_Defaults": 1
}