DelayEventCoordinator

Note

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

The DelayEventCoordinator coordinator class insert delays into coordinator event chains. This campaign event is typically used with parameter-campaign-event-broadcastcoordinatorevent to broadcast events after the delays.

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
Coordinator_Name	link	The unique identifying coordinator name, which is useful with the output report, ReportCoordinatorEventRecorder.csv.	string	nan	nan	DelayEventCoordinator
Delay_Complete_Event	link	The delay completion event to be included in the ReportCoordinatorEventRecorder.csv output report, upon completion of the delay period.	string	nan	nan	nan
Delay_Period_Constant	link	The delay period to use for all interventions, in days, when Delay_Period_Distribution is set to CONSTANT_DISTRIBUTION.	float	0	3.40282e+38	-1
Delay_Period_Distribution	link	The distribution type to use for assigning the delay period for distributing interventions. Each assigned value is a random draw from the distribution. Possible values are: NOT_INITIALIZED No distribution set. CONSTANT_DISTRIBUTION Use the same value for each individual. Set Delay_Period_Constant. UNIFORM_DISTRIBUTION Use a uniform distribution with a given minimum and maximum. Set Delay_Period_Max and Delay_Period_Min. GAUSSIAN_DISTRIBUTION The distribution is Gaussian (or normal). Values are resampled to ensure >= 0. Set Delay_Period_Gaussian_Mean and Delay_Period_Gaussian_Std_Dev. EXPONENTIAL_DISTRIBUTION The distribution is exponential with a given mean. Set Delay_Period_Exponential. WEIBULL_DISTRIBUTION Use a Weibull distribution with a given shape and scale. Set Delay_Period_Kappa and Delay_Period_Lambda. LOG_NORMAL_DISTRIBUTION Use a log-normal distribution with a given mean and standard deviation of the natural log. Set Delay_Period_Log_Normal_Mu and Delay_Period_Log_Normal_Sigma. POISSON_DISTRIBUTION Use a Poisson distribution with a given mean. Set Delay_Period_Poisson_Mean. DUAL_CONSTANT_DISTRIBUTION Use a distribution where some individuals are set to a value of zero and the rest to a given value. Set Delay_Period_Proportion_0 and Peak_2_Value. This distribution does not use the parameters set for CONSTANT_DISTRIBUTION. DUAL_EXPONENTIAL_DISTRIBUTION Use two exponential distributions with given means. Set Delay_Period_Mean_1, Delay_Period_Mean_2, and Delay_Period_Proportion_1. This distribution does not use the parameters set for EXPONENTIAL_DISTRIBUTION. .. _Gaussian: https://en.wikipedia.org/wiki/Normal_distribution .. _exponential: https://en.wikipedia.org/wiki/Exponential_distribution .. _Weibull: https://en.wikipedia.org/wiki/Weibull_distribution .. _log-normal: https://en.wikipedia.org/wiki/Log-normal_distribution .. _uniform: https://en.wikipedia.org/wiki/Uniform_distribution(continuous) .. _Poisson: https://en.wikipedia.org/wiki/Poisson_distribution	enum	nan	nan	NOT_INITIALIZED
Delay_Period_Exponential	link	The mean of the delay period, in days, when Delay_Period_Distribution is set to EXPONENTIAL_DISTRIBUTION.	float	0	3.40282e+38	-1
Delay_Period_Gaussian_Mean	link	The mean of the delay period, in days, when Delay_Period_Distribution is set to GAUSSIAN_DISTRIBUTION.	float	0	3.40282e+38	-1
Delay_Period_Gaussian_Std_Dev	link	The standard deviation of the delay period, in days, when Delay_Period_Distribution is set to GAUSSIAN_DISTRIBUTION.	float	1.17549e-38	3.40282e+38	-1
Delay_Period_Kappa	link	The shape value for the delay period, in days, when Delay_Period_Distribution is set to WEIBULL_DISTRIBUTION.	float	1.17549e-38	3.40282e+38	-1
Delay_Period_Lambda	link	The scale value for the delay period, in days, when Delay_Period_Distribution is set to WEIBULL_DISTRIBUTION.	float	1.17549e-38	3.40282e+38	-1
Delay_Period_Log_Normal_Mu	link	The mean of the natural log of the delay period, in days, when Delay_Period_Distribution is set to LOG_NORMAL_DISTRIBUTION.	float	-3.40282e+38	1.70141e+38	3.40282e+38
Delay_Period_Log_Normal_Sigma	link	The standard deviation of the natural log of the delay period, in days, when Delay_Period_Distribution is set to LOG_NORMAL_DISTRIBUTION.	float	-3.40282e+38	1.70141e+38	3.40282E+38
Delay_Period_Max	link	The maximum delay period, in days, when Delay_Period_Distribution is set to UNIFORM_DISTRIBUTION.	float	0	3.40282e+38	-1
Delay_Period_Mean_1	link	The mean of the first exponential distribution, in days, when Delay_Period_Distribution is set to DUAL_EXPONENTIAL_DISTRIBUTION.	float	1.17549e-38	3.40282e+38	-1
Delay_Period_Mean_2	link	The mean of the second exponential distribution, in days, when Delay_Period_Distribution is set to DUAL_EXPONENTIAL_DISTRIBUTION.	float	1.17549e-38	3.40282e+38	-1
Delay_Period_Min	link	The minimum delay period, in days, when Delay_Period_Distribution is set to UNIFORM_DISTRIBUTION.	float	0	3.40282e+38	-1
Delay_Period_Peak_2_Value	link	The delay period value, in days, to assign to the remaining interventions when Delay_Period_Distribution is set to DUAL_CONSTANT_DISTRIBUTION.	float	0	3.40282e+38	-1
Delay_Period_Poisson_Mean	link	The mean of the delay period, in days, when Delay_Period_Distribution is set to POISSON_DISTRIBUTION.	float	0	3.40282e+38	-1
Delay_Period_Proportion_0	link	The proportion of interventions to assign a value of zero delay when Delay_Period_Distribution is set to DUAL_CONSTANT_DISTRIBUTION.	float	0	1	-1
Delay_Period_Proportion_1	link	The proportion of interventions in the first exponential distribution when Delay_Period_Distribution is set to DUAL_EXPONENTIAL_DISTRIBUTION.	float	0	1	-1
Duration	link	The number of days from when the delay event coordinator was created by the campaign event. Once the number of days has passed, the delay event coordinator will unregister for events and expire. The default value of '-1' = never expire.	float	-1	3.40282e+38	-1
Start_Trigger_Condition_List	link	The start trigger event condition list contains events defined in the Custom_Coordinator_Events config parameter that will trigger to start a new delay. If the delay event coordinator has already been triggered and is currently waiting for the duration of a delay, it will then ignore a new delay event. The list cannot be empty.	array of strings	nan	nan	nan
Stop_Trigger_Condition_List	link	The stop trigger event condition list contains events defined in the Custom_Coordinator_Events config parameter that will trigger to stop a delay period, but does not stop the delay event coordinator. The event is not broadcast.	array of strings	nan	nan	nan

link