Module: EndCriteria

The EndCriteria module determines whether or not the simulation process should terminate at any given moment. See the source code to see what is defined by the abstract class.

List of Implementations

EndCriteria_FirstTimeTransmissions

• The user can specify both an end time and a number of transmissions as ending criteria, and the first to be reached will end the simulation
• Requirements:
  • None
• Config Parameters:
  • end_time: The time at which to end the transmission simulation
  • end_transmissions: The number of transmissions after which to end the transmission simulation

EndCriteria_GEMF

• For use with a GEMF TransmissionTimeSample module
• Requirements:
  • Must use TransmissionNodeSample_GEMF module
  • Must use a GEMF TransmissionTimeSample module
• Config Parameters:
  • gemf_path: The path to your GEMF executable (or simply "GEMF" if it is in your PATH variable)

EndCriteria_Instant

• Simulations end before any transmissions occur (useful if you want to only simulate a contact network)
• Requirements:
  • Must use NodeEvolution_None module
  • Must use NodeSample_Perfect module
  • Must use SequenceEvolution_NoMutation module
  • Must use Sequencing_Perfect module
  • Must use TransmissionTime_Instant module
• Config Parameters:
  • None

EndCriteria_Time

• The user can specify an end time, and the simulation will end when the time is reached
• Requirements:
  • None
• Config Parameters:
  • end_time: The time at which to end the transmission simulation

EndCriteria_TransmissionFile

• Transmission network is read from file
• Requirements:
  • Must use SeedSelection_TransmissionFile module
  • Must use TransmissionNodeSample_TransmissionFile module
  • Must use TransmissionTimeSample_TransmissionFile module
• Config Parameters:
  • transmission_network_file: The desired transmission network, represented in the FAVITES Transmission Network File Format

EndCriteria_Transmissions

• The user can specify an ending number of transmissions, and the simulation will end when the number of transmissions is reached
• Requirements:
  • None
• Config Parameters:
  • end_transmissions: The number of transmissions after which to end the transmission simulation