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. JSON does not permit comments, but you can add “dummy” parameters to add contextual information to your files.

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
Event_Coordinator_Config JSON object NA NA NA 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.
{
    "Event_Coordinator_Config": {
        "class": "StandardInterventionDistributionEventCoordinator",
        "Demographic_Coverage": 1.0
    }
}
Nodeset_Config JSON object NA NA NA

An object that specifies in which nodes the interventions will be distributed. For example, if running a single location simulation, or an event that is active in all nodes, then specify class NodeSetAll within the Nodeset_Config brackets.

Possible classes are:

NodeSetAll
Distribute to all nodes in the simulation.
NodeSetNodeList
Distribute to the nodes in the comma-separated list of node IDs specified by the Node_List parameter.
NodeSetPolygon
Distribute to the nodes that fall within a polygon specified by the comma-separated list of polygon points in the Vertices parameter (set Polygon_Format to SHAPE).
{
    "Nodeset_Config": {
        "class": "NodeSetAll"
    }
}
Start_Day float 0 3.40E+3 1 The day of the simulation to activate the event’s event coordinator.
{
    "Start_Day": 0,
    "End_Day": 100
}
{
    "Events": [{
        "class": "CampaignEvent",
        "Event_Name": "Individual outbreak",
        "Start_Day": 1,
        "Nodeset_Config": {
            "class": "NodeSetAll"
        },
        "Event_Coordinator_Config": {
            "class": "StandardInterventionDistributionEventCoordinator",
            "Target_Demographic": "Everyone",
            "Demographic_Coverage": 1.0,
            "Intervention_Config": {
                "class": "OutbreakIndividual"
            }
        }
    }]
}