Simulink.BlockPortData

Describe block input or output port

Description

This class defines properties that are common to objects that provide run-time information about a block's ports.

Property Summary

Name

Description

IsBus

True if this port is connected to a bus.

IsSampleHit

True if this port produces output or accepts input at the current simulation time step.

SampleTime

Sample time of this port.

SampleTimeIndex

Sample time index of this port.

SamplingMode

Sampling mode of the port.

Properties

IsBus

Description

True if this port is connected to a bus.

Data Type

Boolean

Access

RO

IsSampleHit

Description

True if this port produces output or accepts input at the current simulation time step.

Data Type

Boolean

Access

RO

SampleTime

Description

Sample time of this port.

Data Type

[period offset] where period and offset are values of type double. See Specify Sample Time for more information.

Access

RW for MATLAB® S functions, RO for other blocks

SampleTimeIndex

Description

Sample time index of this port.

Data Type

integer

Access

RO

SamplingMode

Description

Sampling mode of the port. Valid values are:

Value

Description

'frame'

Port accepts or outputs frame-based signals. The use of frame-based signals requires a DSP System Toolbox™ license.

'inherited'

Sampling mode is inherited from the port to which this port is connected.

'sample'

Port accepts or outputs sampled data.

Data Type

string

Access

RW for MATLAB S functions, RO for other blocks

Was this topic helpful?