Return all sample times associated with model
ts = Simulink.BlockDiagram.getSampleTimes('
ts = Simulink.BlockDiagram.getSampleTimes(' performs
an update diagram and then returns the sample times associated with
the block diagram
model. The update diagram
ensures that the sample time information returned is up to date. If
the model is already in the compiled state via a call to the model
API, then an update diagram is not necessary.
Using this method allows you to access all information in the Sample Time Legend programmatically.
Name or handle of a Simulink® model
The command returns a
Simulink.SampleTimeobjects associated with the model passed to
nis the number of sample times associated with the block diagram. The format of the returns is as follows:
1xn Simulink.SampleTime Package: Simulink
value: [1x2 double] Description: [char string] ColorRGBValue: [1x3 double] Annotation: [char string] OwnerBlock: [char string] ComponentSampleTimes: [1x2 struct]
value— A two-element array of doubles that contains the sample time period and offset.
Description— A character vector or string that describes the sample time type.
1x3array of doubles that contains the red, green, and blue (RGB) values of the sample time color.
Annotation— A character vector or string that represents the annotation of a specific sample time (e.g.,
OwnerBlock— For asynchronous and variable sample times, a character vector or string containing the full path to the block that controls the sample time. For all other types of sample times, an empty character vector or string.
ComponentSampleTimes— A structure array of elements of the same type as
Simulink.BlockDiagram.getSampleTimesif the sample time is an async union or if the sample time is hybrid and the component sample times are available.
Introduced in R2009a