CampaignEvent

The CampaignEvent event class determines when to distribute the intervention based on the first day of the simulation. See the following JSON example and table, which shows all available parameters for this campaign event.

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
Event_Coordinator_Config	link	An object that specifies how the event is handled by the simulation. It specifies which Event Coordinator class will handle the event, and then configures the coordinator. This description starts with specifying class, and then the other fields depend on the class.	JSON object	nan	nan	nan
Event_Name	link	The optional name used to refer to this event as a means to differentiate it from others that use the same class.	string	nan	nan	nan
Nodeset_Config	link	An object that specifies in which nodes the interventions will be distributed. Set to one of the .	JSON object	nan	nan	nan
Start_Day	link	The day of the simulation to activate the event's event coordinator. Depending on the event coordinator and intervention, this may indicate when to distribute an intervention or when to begin listening for a trigger.	float	-1	3.40282e+38	1

link

Nodeset_Config classes

The following classes determine in which nodes the event will occur.

NodeSetAll

The event will occur in all nodes in the simulation. This class has no associated parameters. For example,

    {
        "Nodeset_Config": {
            "class": "NodeSetAll"
        }
    }

NodeSetNodeList

The event will occur in the nodes listed by Node ID.

Parameter	Example	Description	Type	Min	Max	Default
Node_List	link	A comma-separated list of node IDs in which this event will occur.	array of integers	nan	nan	nan

NodeSetPolygon

The event will occur in the nodes that fall within a given polygon.

Parameter	Example	Description	Type	Min	Max	Default
Polygon_Format	link	The type of polygon to create. Currently, SHAPE is the only supported value.	enum	nan	nan	SHAPE
Vertices	link	Comma-separated list of latitude/longitude points that bound a polygon.	string	nan	nan	UNINTIALIZED STRING