ReportCoordinatorEventRecorder

The coordinator event recorder report (ReportCoordinatorEventRecorder.csv) records coordinator-level events that are broadcast during the simulation. It logs the event name, the time the event occurred, and the name of the coordinator that broadcast it.

Coordinator-level events are typically broadcast by campaign classes such as BroadcastCoordinatorEvent and SurveillanceEventCoordinator.

For recording individual-level events, see ReportEventRecorder. For node-level events, see ReportNodeEventRecorder. For surveillance-specific coordinator events with additional population statistics, see ReportSurveillanceEventRecorder.

Configuration

To generate this report, the following parameters must be configured in the config.json file:

Parameter	Data type	Min	Max	Default	Description
Report_Coordinator_Event_Recorder	boolean	0	1	0	Set to 1 to enable the ReportCoordinatorEventRecorder.csv output report.
Report_Coordinator_Event_Recorder_Events	array of strings	NA	NA	[]	The list of coordinator events to include or exclude in the ReportCoordinatorEventRecorder.csv output report, based on how Report_Coordinator_Event_Recorder_Ignore_Events_In_List is set. Events are sourced from Custom_Coordinator_Events or built-in coordinator events. If the list is empty and Report_Coordinator_Event_Recorder_Ignore_Events_In_List is set to 0, no events will be recorded.
Report_Coordinator_Event_Recorder_Ignore_Events_In_List	boolean	0	1	0	If set to false (0), only the events listed in the Report_Coordinator_Event_Recorder_Events array will be included in the ReportCoordinatorEventRecorder.csv output report. If set to true (1), only the events listed in the array will be excluded, and all other events will be included. To return all events from the simulation, set this value to 1 and leave the Report_Coordinator_Event_Recorder_Events array empty.

{
    "Report_Coordinator_Event_Recorder": 1,
    "Report_Coordinator_Event_Recorder_Events": ["VectorSurveyDone"],
    "Report_Coordinator_Event_Recorder_Ignore_Events_In_List": 0
}

Output file data

The report (ReportCoordinatorEventRecorder.csv) contains one row per coordinator event. The columns are described below.

Data channel	Data type	Description
Time	float	The simulation time (in days) when the coordinator event was broadcast.
Coordinator_Name	string	The name of the event coordinator that broadcast the event, as set by the Coordinator_Name parameter in the campaign definition. Useful for distinguishing between multiple coordinators that broadcast the same event.
Event_Name	string	The coordinator-level event that was broadcast. If Report_Coordinator_Event_Recorder_Ignore_Events_In_List is set to 0, only events listed in Report_Coordinator_Event_Recorder_Events appear.

Example

The following is an example of a ReportCoordinatorEventRecorder.csv report from a malaria simulation using vector surveillance:

Time	Coordinator_Name	Event_Name
200	VectorSurveillance_Coordinator	StartVectorSurveillance
200	VectorSurveillance_Coordinator	VectorSurveyDone
210	VectorSurveillance_Coordinator	VectorSurveyDone
220	VectorSurveillance_Coordinator	VectorSurveyDone