本页对应的英文页面已更新,但尚未翻译。 若要查看最新内容,请点击此处访问英文页面。

Simulink.RunTimeBlock

允许 Level-2 MATLAB S-Function 和其他 MATLAB 程序在仿真运行时获取有关模块的信息

说明

此类允许 Level-2 MATLAB® S-Function 或其他 MATLAB 程序获取有关模块的信息。Simulink® 软件为模型中的每个模块创建此类或派生类的一个实例。Simulink 软件在更新或仿真模型时将对象传递给 Level-2 MATLAB S-Function 的回调方法,从而允许回调方法从 Simulink 软件获取与模块相关的信息并将此信息提供给该软件。有关详细信息,请参阅“编写 S-Function”中的Write Level-2 MATLAB S-Functions。您也可以在 MATLAB 程序中使用此类的实例,以在仿真期间获取有关模块的信息。有关详细信息,请参阅 在仿真期间访问模块数据

注意

Simulink.RunTimeBlock 对象不支持 MATLAB 稀疏矩阵。例如,以下代码行尝试将一个稀疏单位矩阵分配到运行时对象的输出端口数据。此代码行在 Level-2 MATLAB S-Function 中会产生错误:

  block.Outport(1).Data = speye(10);

父类

None

属性摘要

名称

说明

BlockHandle

模块的句柄。

CurrentTime

当前仿真时间。

NumDworks

模块使用的离散工作向量的数量。

NumOutputPorts

模块输出端口的数量。

NumContStates

模块的连续状态的数量。

NumDworkDiscStates

模块的离散状态的数量

NumDialogPrms

可以在 S-Function 模块的对话框上输入的参数的数量。

NumInputPorts

模块的输入端口的数量。

NumRuntimePrms

模块使用的运行时参数的数量。

SampleTimes

模块生成输出时的采样时间。

方法摘要

名称

说明

ContStates

获取模块的连续状态。

DataTypeIsFixedPoint

确定数据类型是否为定点类型。

DatatypeName

获取此模块支持的数据类型的名称。

DatatypeSize

获取此模块支持的数据类型的大小。

Derivatives

获取模块的连续状态导数。

DialogPrm

获取在 S-Function 模块的对话框上输入的参数。

Dwork

获取模块的 DWork 向量之一。

FixedPointNumericType

确定定点数据类型的属性。

InputPort

获取模块的输入端口之一。

OutputPort

获取模块的输出端口之一。

RuntimePrm

获取模块使用的运行时参数之一。

属性

BlockHandle

说明

模块的句柄。

访问权限

RO

CurrentTime

说明

当前仿真时间。

访问权限

RO

NumDworks

说明

数据工作向量的数量。

访问权限

RW

另请参阅

ssGetNumDWork

NumOutputPorts

说明

输出端口的数量。

访问权限

RW

NumContStates

说明

连续状态的数量。

访问权限

RW

另请参阅

ssGetNumContStates

NumDworkDiscStates

说明

离散状态的数量。在 MATLAB S-Function 中,您需要使用 DWorks 设置离散状态。

访问权限

RW

另请参阅

ssGetNumDiscStates

NumDialogPrms

说明

模块的对话框上声明的参数数量。对于 S-Function,它返回在 S-function parameters 对话框字段中以逗号分隔的列表形式列出的参数的数量。

访问权限

RW

另请参阅

ssGetNumSFcnParams

NumInputPorts

说明

输入端口的数量。

访问权限

RW

另请参阅

ssGetNumInputPorts

NumRuntimePrms

说明

此模块使用的运行时参数的数量。有关详细信息,请参阅 Create and Update S-Function Run-Time Parameters

访问权限

RW

另请参阅

ssGetNumSFcnParams

SampleTimes

说明

模块的采样时间。

访问权限

RW 用于 MATLAB S-Function,RO 用于所有其他模块。

方法

ContStates

用途

获取模块的连续状态。

语法

states = ContStates();

说明

获取连续状态的向量。

另请参阅

ssGetContStates

DataTypeIsFixedPoint

用途

确定数据类型是否为定点类型。

语法

bVal = DataTypeIsFixedPoint(dtID);

参数

dtID

整数值,用于指定数据类型的 ID。

说明

如果指定的数据类型是定点数据类型,则返回 true

DatatypeName

用途

获取数据类型的名称。

语法

name = DatatypeName(dtID);

参数

dtID

整数值,用于指定数据类型的 ID。

说明

返回 dtID 指定的数据类型的名称。

另请参阅

DatatypeSize

DatatypeSize

用途

获取数据类型的大小。

语法

size = DatatypeSize(dtID);

参数

dtID

整数值,用于指定数据类型的 ID。

说明

返回 dtID 指定的数据类型的大小。

另请参阅

DatatypeName

Derivatives

用途

获取模块的连续状态的导数。

语法

derivs = Derivatives();

说明

获取状态导数的向量。

另请参阅

ssGetdX

DialogPrm

用途

获取 S-Function 的对话框参数。

语法

param = DialogPrm(pIdx);

参数

pIdx

整数值,用于指定要返回的参数的索引。

说明

获取指定的对话框参数。对于 S-Function,每个 DialogPrm 都对应于 S-function parameters 对话框字段中参数的逗号分隔列表中的一个元素。

Dwork

用途

获取模块的 DWork 向量之一。

语法

dworkObj = Dwork(dwIdx);

参数

dwIdx

整数值,用于指定工作向量的索引。

说明

获取有关 dwIdx 指定的 DWork 向量的信息,其中 dwIdx 是工作向量的索引编号。此方法返回 Simulink.BlockCompDworkData 类型的对象。

另请参阅

ssGetDWork

FixedPointNumericType

用途

获取定点数据类型的属性。

语法

eno = FixedPointNumericType(dtID);

参数

dtID

整数值,用于指定定点数据类型的 ID。

说明

返回 embedded.Numeric 类的对象,其中包含指定的定点数据类型的属性。

注意

embedded.Numeric 也是 Fixed-Point Designer™ 软件创建的 numerictype 对象的类。有关 embedded.Numeric 类定义的属性的信息,请参阅numerictype Object Properties (Fixed-Point Designer)。

InputPort

用途

获取模块的输入端口。

语法

port = InputPort(pIdx);

参数

pIdx

整数值,用于指定输入端口的索引。

说明

获取 pIdx 指定的输入端口,其中 pIdx 是输入端口的索引编号。例如,

port = rto.InputPort(1)

返回运行时对象 rto 表示的模块的第一个输入端口。

此方法返回 Simulink.BlockPreCompInputPortDataSimulink.BlockCompInputPortData 类型的对象,具体取决于包含该端口的模型是否已编译。您可以使用此对象分别获取和设置输入端口的未编译或已编译属性。

OutputPort

用途

获取模块的输出端口。

语法

port = OutputPort(pIdx);

参数

pIdx

整数值,用于指定输出端口的索引。

说明

获取 pIdx 指定的输出端口,其中 pIdx 是输出端口的索引编号。例如,

port = rto.OutputPort(1)

返回运行时对象 rto 表示的模块的第一个输出端口。

此方法返回 Simulink.BlockPreCompOutputPortDataSimulink.BlockCompOutputPortData 类型的对象,具体取决于包含该端口的模型是否已编译。您可以使用此对象分别获取和设置输出端口的未编译或已编译属性。

RuntimePrm

用途

获取 S-Function 的运行时参数。

语法

param = RuntimePrm(pIdx);

参数

pIdx

整数值,用于指定运行时参数的索引。

说明

获取索引为 pIdx 的运行时参数。此运行时参数是 Simulink.BlockRunTimePrmData 类型的 Simulink.BlockData 对象。

在 R2006a 之前推出