EventMode
Determine how events that change dose parameters affect in-progress dosing
Description
EventMode
is a property of RepeatDose
and
ScheduleDose
objects. This property determines whether to
continue the ongoing dose, that is, a dose with a nondefault infusion rate or dose
duration, to completion when an event changes a parameter that is referenced by a dose
property. Dose properties that you can parameterize are: Amount
, Rate
, Interval
, StartTime
, RepeatCount
, LagParameterName
, and DurationParameterName
.
If EventMode
is set to 'continue'
, the ongoing
dose continues to completion when the event changes dose parameters, and updated
parameters affect only subsequent doses. If EventMode
is set to
'stop'
, the ongoing dose stops immediately when dose parameters
change, and subsequent doses use the updated parameters.
To decide whether a parameter has been changed, SimBiology compares the old value of a
parameter to the new value. For instance, the following event does not change the
doseStartTime
parameter value: addevent(model,'time >=
5','doseStartTime = doseStartTime * 1')
.
Any change in dose parameters affects the schedule of doses generated. If the
simulation reaches a time point for a scheduled dose, the dose is applied. If an event
changes dose parameters, SimBiology updates the dose schedule, ignores any doses
scheduled before the current simulation time, and applies only the subsequent doses.
Suppose that you have parameterized
the StartTime
property of a dose. Updating the parameter with an
event causes to regenerate the dose schedule. If there are any previously-scheduled
doses before the current simulation time, they are ignored.
By default, SimBiology® uses the following MATLAB® expression to generate a list of dose times (dose schedule) whenever an event changes any dose parameter, using the updated parameter values:
,
where StartTime, RepeatCount, and
Interval are properties of the dose object.
Lag is the time lag parameter for a dose, referenced by the
LagParameterName
property.
Characteristics
Applies to | Objects: RepeatDose ,
ScheduleDose |
Data type | Character vector |
Data values |
|
Access | Read/write |