Recurrence of HSI_Events in RTI module when consumables not available

[tbhallett]

In her analysis of the effects of consumables availability, @sakshimohan has noted that there are large numbers of recurring HSI_Events for the RTI module.

This appears to be due to logic in several of the HSI like this:

# check for availability of consumables 
if consumables_available:
    # do something
else:
   # reschedule this event instance for tomorrow
   return self.make_appt_footprint({})  # return of blank footprint shows that the HSI did not really take up any time

e.g.

TLOmodel/src/tlo/methods/rti.py

Lines 3856 to 3862 in 4e983a5

	if is_cons_available:
	logger.debug(key='rti_general_message',
	data=f"Hypovolemic shock treatment available for person {person_id}")
	df.at[person_id, 'rt_in_shock'] = False
	else:
	self.sim.modules['RTI'].schedule_hsi_event_for_tomorrow(self)
	return self.make_appt_footprint({})

This could be fixed by changing the logic in each place to be of the form:

# in __init__() of the HSI_Event
self._number_of_times_this_event_has_run = 0
self._maximum_number_times_event_should_run = self.module.parameters['Maximum_Number_Of_Times_HSI_Events_Should_Run']  # module declares this parameter (value could be 5)

# at the top of the apply() of the HSI_Event
self._number_of_times_this_event_has_run += 1

# check for availability of consumables 
if consumables_available:
    # do something
else:
   if  self._number_of_times_this_event_has_run < self._maximum_number_times_event_should_run:
       # reschedule this event instance for tomorrow
   return self.make_appt_footprint({})