TriggeredEventCoordinator

Note

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

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 parameter-campaign-event-broadcastcoordinatorevent, parameter-campaign-event-delayeventcoordinator, and parameter-campaign-event-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	Example	Description	Type	Min	Max	Default
Completion_Event	link	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.	array of strings	nan	nan	nan
Coordinator_Name	link	The unique identifying coordinator name used to identify the different coordinators in reports.	string	nan	nan	TriggeredEventCoordinator
Duration	link	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.	float	-1	3.40282e+38	-1
Intervention_Config	link	The nested JSON of the intervention to be distributed by this event coordinator.	JSON object	nan	nan	nan
Node_Property_Restrictions	link	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 parameters for more information. You can specify AND and OR combinations of key:value pairs with this parameter.	array of JSON objects	nan	nan	nan
Number_Repetitions	link	The number of times an intervention is given, used with Timesteps_Between_Repetitions.	integer	-1	1000	1
Property_Restrictions	link	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 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.	array of JSON objects	nan	nan	nan
Property_Restrictions_Within_Node	link	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 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.	array of JSON objects	nan	nan	nan
Start_Trigger_Condition_List	link	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.	array of strings	nan	nan	nan
Stop_Trigger_Condition_List	link	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.	array of strings	nan	nan	nan
Target_Age_Max	link	The upper end of ages targeted for an intervention, in years. Used when Target_Demographic is set to ExplicitAgeRanges or ExplicitAgeRangesAndGender.	float	0	9.3228e+35	9.3228e+35
Target_Age_Min	link	The lower end of ages targeted for an intervention, in years. Used when Target_Demographic is set to ExplicitAgeRanges or ExplicitAgeRangesAndGender.	float	0	3.4e+38	0
Target_Demographic	link	The target demographic group. Possible values are: Everyone ExplicitAgeRanges ExplicitAgeRangesAndGender ExplicitGender * ExplicitDiseaseState	enum	nan	nan	Everyone
Target_Gender	link	Specifies the gender restriction for the intervention. Possible values are: Male Female * All	enum	nan	nan	All
Target_Residents_Only	link	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).	boolean	0	1	0
Timesteps_Between_Repetitions	link	The repetition interval.	integer	-1	10000	-1

link