IncidenceEventCoordinator

The IncidenceEventCoordinator coordinator class distributes interventions based on the number of events counted over a period of time.

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
Action_List	link	List (array) of JSON objects, including the values specified in the following parameters: Threshold, Event_Type, Event_To_Broadcast.	array of JSON objects	nan	nan	nan
Count_Events_For_Num_Timesteps	link	If set to true (1), then the waning effect values, as specified in the Effect_List list of objects for the WaningEffectCombo classes, are added together. If set to false (0), the waning effect values are multiplied. The resulting waning effect value cannot be greater than 1.	integer	1	2.15	1
Event_To_Broadcast	link	The action event to occur when the specified trigger value in the Threshold parameter is met. At least one action must be defined for Event_To_Broadcast. The events contained in the list can be built-in events (see Event list for possible events).	string	nan	nan	nan
Event_Type	link	The type of event to be broadcast. Possible values are: COORDINATOR INDIVIDUAL * NODE	enum	nan	nan	INDIVIDUAL
Incidence_Counter	link	List of JSON objects for specifying the conditions and parameters that must be met for an incidence to be counted. Some of the values are specified in the following parameters: Count_Events_For_Num_Timesteps, Trigger_Condition_List, Node_Property_Restrictions.	array of JSON objects	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
Responder	link	List of JSON objects for specifying the threshold type, values, and the actions to take when the specified conditions and parameters have been met, as configured in the Incidence_Counter parameter. Some of the values are specified in the following parameters: Threshold_Type Action_List Threshold Event_To_Broadcast	array of JSON objects	nan	nan	nan
Threshold	link	The threshold value that triggers the specified action for the Event_To_Broadcast parameter. When you use the Threshold parameter you must also use the Event_To_Broadcast parameter.	float	0	3400	0
Threshold_Type	link	Threshold type. Possible values are: COUNT PERCENTAGE.	enum	nan	nan	COUNT
Timesteps_Between_Repetitions	link	The repetition interval.	integer	-1	1000	-1
Trigger_Condition_List	link	A list of events that will trigger an intervention.	array of strings	nan	nan	nan

link