OutbreakIndividualTBorHIV

The OutbreakIndividualTBorHIV class extends OutbreakIndividual class and allows for specifying HIV or a specific strain of infection for TB.

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 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
Antigen	integer	0	10	0	The antigenic base strain ID of the outbreak infection. This must not exceed the number specified in the configuration parameter Number_Basestrains.	{ "Intervention_Config": { "Antigen": 0, "Genome": 0, "Infection_Type": "TB", "Outbreak_Source": "PrevalenceIncrease", "class": "OutbreakIndividualTBorHIV" } }
Genome	integer	-1	16777200	0	The genetic substrain ID of the outbreak infection. This must not exceed the number specified in the configuration parameter Number_Substrains.	{ "Intervention_Config": { "Antigen": 0, "Genome": 0, "Infection_Type": "TB", "Outbreak_Source": "PrevalenceIncrease", "class": "OutbreakIndividualTBorHIV" } }
Ignore_Immunity	boolean	0	1	1	Individuals will be force-infected (with a specific strain) regardless of actual immunity level when set to true (1).	{ "Intervention_Config": { "Antigen": 0, "Genome": 0, "Infection_Type": "TB", "Outbreak_Source": "PrevalenceIncrease", "Ignore_Immunity": 0, "class": "OutbreakIndividualTBorHIV" } }
Incubation_Period_Override	integer	-1	2147480000	-1	The incubation period, in days, that infected individuals will go through before becoming infectious. This value overrides the incubation period set in the configuration file. Set to -1 to honor the configuration parameter settings.	{ "Intervention_Config": { "Antigen": 0, "Genome": 0, "Ignore_Immunity": 0, "Incubation_Period_Override": -1, "Infection_Type": "TB", "Outbreak_Source": "PrevalenceIncrease", "class": "OutbreakIndividualTBorHIV" } }
Infection_Type	enum	NA	NA	HIV	Infection type. Possible values are: HIV HIV infection. TB TB infection.	{ "Intervention_Config": { "Antigen": 0, "Genome": 0, "Ignore_Immunity": 0, "Incubation_Period_Override": -1, "Infection_Type": "TB", "Outbreak_Source": "PrevalenceIncrease", "class": "OutbreakIndividualTBorHIV" } }

{
  "Campaign_Name": "Outbreak",
  "Events": [
    {
      "Event_Coordinator_Config": {
        "Demographic_Coverage": 0.2,
        "Intervention_Config": {
          "Infection_Type": "TB",
          "class": "OutbreakIndividualTBorHIV"
        },
        "Target_Group": "Everyone",
        "class": "StandardInterventionDistributionEventCoordinator"
      },
      "Event_Name": "Seeding the TB epidemic at time 2",
      "Nodeset_Config": {
        "class": "NodeSetAll"
      },
      "Start_Day": 2,
      "class": "CampaignEvent"
    }
  ],
  "Use_Defaults": 1
}