通用模块属性
下表列出了所有 Simulink® 模块通用的属性,包括模块回调属性(请参阅使用回调自定义模型行为)。此表后面提供了用于更改这些属性的命令示例(请参阅设置模块属性的示例)。
通用模块属性
属性 | 描述 | 值 |
---|---|---|
| 模块所链接至的模块库模块的名称(适用于带有被禁用链接的模块)。 | 字符向量 |
| 模块注释文本(对应于模块属性)。 | 字符向量 |
| 模块的背景色。 | 颜色值 |
可能的颜色值为 |
| 显示在模块参数对话框或属性检查器顶部的模块描述。 | 字符数组 |
| 模块类型(只读)。 | 字符数组 |
BlockKeywords | 将一个或多个关键字与一个自定义库模块相关联。 | 字符向量 | 字符串标量 | 字符串数组 |
BlockMirror | 模块镜像。 |
|
BlockRotation | 模块旋转角度。 | 双精度值 |
| 将模块复制到剪贴板 (Ctrl+C) 或者选择复制菜单项时所调用的函数。 | 函数 |
| 在模块上运行 | 函数 |
Commented | 从仿真中排除模块。 |
|
| 返回连接到端口的信号是否为总线、是虚拟总线还是非虚拟总线(只读)。 使用 ports = get_param(gcb,'PortHandles'); feval(gcs,[],[],[],'compile'); bt = get_param(ports.Outport,'CompiledBusType') |
|
| 指定模块状态在编译时是否为活动。 如果在编译时以下任一条件为 true,
对于可变子系统的非活动选择项, |
|
| 更新图后端口信号的复/实性。在查询此属性之前,必须先编译模型。例如: openExample('simulink_general/VanDerPolOscillatorExample'); vdp([],[],[],'compile'); d = get_param(gcb,'CompiledPortComplexSignals'); vdp([],[],[],'term'); | 结构体数组 |
| 更新图后端口信号的数据类型。在查询此属性之前,必须先编译模型。请参阅 | 结构体数组 |
| 更新图后端口信号的设计最小值。在查询此属性之前,必须先编译模型。例如: feval(gcs, [],[],[],'compile'); ports = get_param(gcb,'PortHandles'); min = get_param(ports.Outport, 'CompiledPortDesignMin') feval(model, [],[],[],'term'); | 结构体数组 |
| 编译时端口信号的设计最大值。在查询此属性之前,必须先编译模型。例如: feval(gcs, [],[],[],'compile'); ports = get_param(gcb,'PortHandles'); max = get_param(ports.Outport, 'CompiledPortDesignMax') feval(model, [],[],[],'term'); | 结构体数组 |
| 更新图后端口信号的维度。在查询此属性之前,必须先编译模型。有关详细信息,请参阅获取编译的端口维度。 | 数值数组 |
| 指示端口信号是否具有可变大小(在更新图后)。在查询此属性之前,必须先编译模型。请参阅以编程方式确定信号线是否具有可变大小。 |
|
| 更新图后端口信号的帧模式。在查询此属性之前,必须先编译模型。 | 结构体数组 |
| 模块端口单位的结构体数组(更新图后)。在查询此属性之前,必须先编译模型。 | 结构体数组 |
| 更新图后端口宽度的结构体。在查询此属性之前,必须先编译模型。 | 结构体数组 |
| 更新图后的模块采样时间。在查询此属性之前,必须先编译模型。 | 向量 [ 或 元胞 {[ |
| (暂停之后)重新启动仿真时所调用的函数。 | 函数 |
| 复制模块时所调用的函数。有关详细信息,请参阅模块回调。 | 函数 |
| 供内部使用。 | |
| 删除模块时所调用的函数。有关详细信息,请参阅模块回调。 | MATLAB® 表达式 |
| 销毁模块时所调用的函数。有关详细信息,请参阅模块回调。 | MATLAB 表达式 |
| 模块描述。通过“模块属性”对话框中常规窗格上的描述字段来进行设置。 | 文本和标记 |
| 供内部使用。 | |
| 未封装模块的模块特定参数的名称/属性列表,或封装模块的封装参数。 | 结构体 |
| 显示阴影。 |
|
| 使模块能够支持在外部模式下上传信号数据(例如,对于 Scope 模块)。 |
|
| 使模块能够充当外部模式信号上传的 Trigger 模块。 |
|
ExtModeUploadOption | 允许模块在未选中“外部信号和触发”对话框上的全选复选框的情况下,在外部模式下上传信号数据。值为 log 表示模块上传信号。值为 none 表示模块不上传信号。值 monitor 当前未使用。如果选中“外部信号和触发”对话框中的全选复选框,它将覆盖此参数设置。 | {'none'} | 'log' | 'monitor' |
| 字体角度。 |
|
| 字体名称。 | 字符数组 |
| 字体大小。值为 -1 指示此模块继承由 | 实数 |
| 字体粗细。 |
|
| 模块图标的前景颜色。 | 颜色值
可能的颜色值为 |
| 模块句柄。 | 实数 |
| 指定模型中是否显示由 Simulink 编辑器自动给出的模块名称。要隐藏自动名称,请使用默认设置 'on' 。(模型的 HideAutomaticNames 参数也必须设置为 'on' 。)要显示名称,请设置为 'off' ,还要将模块 ShowName 参数设置为 'on' 。如果模块的 ShowName 参数为 'off' ,则无论对此属性作何设置,这些模块都将隐藏。有关参数如何交互作用的详细信息,请参阅Hide or Display Block Names。 | {'on'} | 'off' |
| 供内部使用。 | |
| 模块的初始化函数。在“模型属性”对话框的回调窗格上创建。有关详细信息,请参阅创建模型回调。 对于未封装的模块,更新图或运行仿真时会调用此函数。 | MATLAB 表达式 |
| 输入信号的名称。 | 元胞数组 |
| 模块特定参数的名称/属性列表(无论模块是否封装)。如果需要封装模块或未封装模块的模块特定参数,请使用此参数代替 | 结构体 |
| 连接到查看器和生成器管理工具的对象的模块路径。Simulink 软件会在保存模型时保存这些路径。 | 列表 |
| 查看器和生成器管理工具类型。供内部使用。 | |
| 指示该模块是否是可与 State Reader 和 State Writer 模块(只读)结合使用的受支持状态所有者模块。请参阅 State Reader 和 State Writer。 |
|
| 对于链接的模块,此属性的初始值是创建链接时模块库的 ModelVersion 。在模块库的模型版本中,此值按增量更新。 | 字符向量 - { |
| 连接模块的线条控制柄。 | 结构体 |
| 包含参数化链接内与库中模块差异细节的数组,其中列出模块名称和参数值。使用 | 元胞数组 |
| 模块的链接状态。使用 请参阅以编程方式控制链接模块。 |
|
| 加载模块时所调用的函数。 | MATLAB 表达式 |
| 供内部使用。 | |
| 关闭模型时所调用的函数。如果设置了模块 | MATLAB 表达式 |
| 供内部使用。 | |
| 移动模块时所调用的函数。 | MATLAB 表达式 |
| 模块或信号名称。 要指定信号名称,请使用对应的端口或信号线句柄。 ports = get_param(gcb,'PortHandles'); set_param(ports.Outport(1),'Name','NewName'); 要传播信号名称,请编译模型。在 Simulink 工具条的建模选项卡上,点击更新模型。 或者,要命名模块的输出信号,可以使用 | 字符向量 |
| 更改模块名称时所调用的函数。 | MATLAB 表达式 |
| 模块名称的位置。 |
|
| 模块参数的名称/属性。 | 结构体 |
| 此“模块参数”对话框打开时所调用的函数。 | MATLAB 表达式 |
| 模块的朝向。 |
|
| 输出信号的名称。 | 元胞数组 |
| 模块所属的系统的名称。 | 字符向量 |
| 关闭父级子系统时所调用的函数。关闭模型时,不会调用位于根模型级别的模块的 | MATLAB 表达式 |
| 暂停仿真时所调用的函数。 | 函数 |
| 此属性的值是一个结构体数组,其中每个结构体都会描述模块的一个输入或输出端口。每个端口结构体包含以下字段:
| 结构体数组 |
| 此属性的值是一个结构体,用于指定模块端口的句柄。该结构体包含以下字段:
| 结构体数组 |
| 此模块所使用的端口旋转的类型(只读)。 |
|
| 一个向量,用于指定此模块的每一种端口的数量。该向量的元素顺序对应于下列端口类型:
| 向量 |
| 模块在模型窗口中的位置。 为了帮助对齐模块,您设置的位置可与实际的模块位置相差几个像素。使用 | 以像素为单位的坐标向量: 原点是尚未调整画布大小时 Simulink 编辑器画布的左上角位置。支持的坐标在 -1073740824 和 1073740823 之间(包括二者)。位于原点右侧和下方的值为正值。位于原点左侧和上方的值为负值。 |
| 保存模块之后所调用的函数。 | MATLAB 表达式 |
| 复制模块之前所调用的函数。有关详细信息,请参阅模块回调。 | MATLAB 表达式 |
| 删除模块之前所调用的函数。有关详细信息,请参阅模块回调。 | MATLAB 表达式 |
| 保存模块之前所调用的函数。有关详细信息,请参阅模块回调。 | MATLAB 表达式 |
| 指定模块相对于同一模型中的其他模块的执行顺序。通过“模块属性”对话框中常规窗格上的优先级字段来进行设置。 | 字符向量 |
| 此模块链接到的模块库模块的名称。 | 字符向量 |
| 供内部使用。 | |
| 用户指定的数据,供 Simulink Coder™ 软件使用。仅与用户编写的 S-Function 结合使用。有关详细信息,请参阅 S-Function RTWdata (Simulink Coder) 部分。 | |
| 采样时间参数的值。有关详细信息,请参阅指定采样时间。 | 字符向量 |
| 指示模块是否处于选中状态。 |
|
| 显示或隐藏模块名称。 要显示由 Simulink 编辑器给出的模块名称(自动名称),请将模块的 |
|
| 如果信号是总线,则返回总线中信号的名称和层次结构(只读)。 使用 ports = get_param(gcb,'PortHandles'); feval(gcs,[],[],[],'compile'); sh = get_param(ports.Outport,'SignalHierarchy') | 反映指定信号的结构的值。 |
| 开始仿真时所调用的函数。 | MATLAB 表达式 |
| 线性化过程中要使用的状态扰动大小。有关详细信息,请参阅Change Perturbation Level of Blocks Perturbed During Linearization (Simulink Control Design)。 | 字符向量 |
| 模块的链接状态。使用 | 'none' | 'resolved' | 'unresolved' | 'implicit' | 'inactive' | 'restore' | 'propagate' | 'propagateHierarchy' | 'restoreHierarchy' |
| 终止仿真时所调用的函数。 | MATLAB 表达式 |
| 由 Simulink 软件生成的、显示在模块标签上的文本。通过“模块属性”对话框中常规窗格上的标记字段来设置。 | 字符向量 |
| Simulink 对象类型(只读)。 |
|
| 撤消模块删除操作时所调用的函数。 | MATLAB 表达式 |
| 用户指定的数据,可以包含任何 MATLAB 数据类型。 |
|
| 指示是否将 |
|
VariantConfigurationObject | 指定与模型关联的变体配置对象。请参阅Save and Reuse Variant Configurations Using Variant Configuration Data Object。 | {''} 如果没有关联的配置对象,则值为空字符向量;否则,值为 Simulink.VariantConfigurationData 对象的名称。 |
设置模块属性的示例
以下示例演示如何更改通用模块属性。
以下命令会更改 mymodel
系统中 Gain 模块的方向,使其朝向相反的方向(从朝右变为朝左)。
set_param('mymodel/Gain','Orientation','left')
以下命令将 OpenFcn
回调与 mymodel
系统中的 Gain 模块相关联。
set_param('mymodel/Gain','OpenFcn','my_open_cb')
以下命令为 mymodel
系统中的 Gain 模块设置 Position
属性。该模块是 75 像素宽 × 25 像素高。
set_param('mymodel/Gain','Position',[50 250 125 275])