SimBiology.export.ScheduleDose class
Superclasses: SimBiology.export.Dose
Schedule dose for exported SimBiology model
Description
SimBiology.export.ScheduleDose
is the class
for export schedule doses.
Construction
Export schedule dose objects are created by the export
method for SimBiology® models.
By default, all active schedule doses are export schedule doses, but
you can specify which schedule doses to export using the optional editdoses
input
argument to export
.
export (model) | Export SimBiology models for deployment and standalone applications |
Properties
|
Amount of dose, a nonnegative scalar value. |
|
Dose amount units. This property is read-only. |
|
Parameter specifying length of time to administer a dose. This property is read-only. |
|
Determine how events that change dose parameters affect in-progress dosing. This property is read-only. |
|
Parameter specifying time lag for the dose. This property is read-only. |
|
Name of dose object. This property is read-only. |
|
Text describing dose object. This property is read-only. |
|
Name of the parent export model. This property is read-only. |
|
Rate of dose, a nonnegative scalar value. Default is |
|
Units for dose rate. This property is read-only. |
|
Species receiving dose. This property is read-only. |
|
Schedule dose times, a vector of nonnegative values. |
|
Time units for dosing. This property is read-only. |
Note
You cannot change the Rate
property of ScheduleDose
for
exported SimBiology model if all of the following
conditions are true:
The
UnitConversion
property of the model is already set totrue
.The
Rate
property is empty or set to zero.The
RateUnits
is set to empty.
To change the Rate
, do one of
the following:
Set
theUnitConversion
property of the original model tofalse
. Thenexport
the model again.Set the
RateUnits
appropriately.
Copy Semantics
Handle. To learn how handle classes affect copy operations, see Copying Objects.
See Also
SimBiology.export.Dose
| SimBiology.export.RepeatDose
| export