Return sample time information for a block
ts = Simulink.Block.getSampleTimes(block)
blockFull name or handle of a Simulink block
tsThe command returns ts which is a 1xn array
of Simulink.SampleTime objects associated with the model passed to
Simulink.Block.getSampleTimes. Here n is the number
of sample times associated with the block. The format of the returns
is:
1xn Simulink.SampleTime Package: Simulink
value: [1x2 double] Description: [char string] ColorRGBValue: [1x3 double] Annotation: [char string] OwnerBlock: [char string] ComponentSampleTimes: [1x2 struct]
Methods
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
ColorRGBValue — A 1x3 array
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., 'D1')
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.getSampleTimes if
the sample time is an async union or if the sample time is hybrid
and the component sample times are available.
ts = Simulink.Block.getSampleTimes(block)
performs an update diagram and then returns the sample times of the
block connected to the input argument mdl/signal.
This method performs an update diagram to ensure 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.