Simulink Reference Previous page   Next Page
Simulink.BlockPortData

Describe a block input or output port.

Description

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

Parent

Simulink.BlockData

Children

Simulink.BlockPreCompInputPortData, Simulink.BlockPreCompOutputPortData, Simulink.BlockCompInputPortData, Simulink.BlockCompOutputPortData

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 Specifying Sample Time for more information.

Access:   RW for M-file 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 Signal Processing Blockset 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 M-file S functions, RO for other blocks


Previous page   Simulink.BlockData Simulink.BlockPreCompInputPortData Next page

© 1994-2005 The MathWorks, Inc.