Main Content

本页的翻译已过时。点击此处可查看最新英文版本。

通用模块属性

关于通用模块属性

下表列出了所有 Simulink® 模块通用的属性,包括模块回调属性(请参阅针对自定义模型行为的回调)。此表后面提供了用于更改这些属性的命令示例(请参阅设置模块属性的示例)。

通用模块属性

属性说明

AncestorBlock

模块所链接至的模块库模块的名称(适用于带有被禁用链接的模块)。

字符向量

AttributesFormatString

模块注释文本(对应于模块属性)。

字符向量

BackgroundColor

模块的背景色。

颜色值 |'[r,g,b]' | '[r,g,b,a]'

rgb 分别指颜色的红、绿、蓝分量值,这些值介于 0.0 与 1.0 之间。如果指定此属性,将忽略 alpha 值 (a)。

可能的颜色值为 'black''white''red''green''blue''cyan''magenta''yellow''gray''lightBlue''orange''darkGreen'

BlockDescription

显示在模块参数对话框或属性检查器顶部的模块说明。

字符数组

BlockDiagramType

对于打开的 Simulink 模块图,返回 model。对于 Simulink 模块库,返回 library

'model' | 'library'

BlockType

模块类型(只读)。

字符数组

BlockKeywords

将一个或多个关键字与一个自定义库模块相关联。

字符向量 | 字符串标量 | 字符串数组

ClipboardFcn

将模块复制到剪贴板 (Ctrl+C) 或者选择 Copy 菜单项时所调用的函数。

函数 | 字符向量

CloseFcn

在模块上运行 close_system 时所调用的函数。

函数 | 字符向量

Commented从仿真中排除模块。

{'off'} | 'on' | 'through'

CompiledBusType

返回连接到端口的信号是否为总线、是虚拟总线还是非虚拟总线(只读)。

使用 get_param 指定端口或信号线句柄。例如:

ports = get_param(gcb,'PortHandles');
feval(gcs,[],[],[],'compile');
bt = get_param(ports.Outport,'CompiledBusType')

请参阅Display Bus Information

'NOT_BUS' | 'VIRTUAL_BUS' | 'NON_VIRTUAL_BUS'

CompiledIsActive

指定模块状态在编译时是否为活动。

如果在编译时以下任一条件为 true,CompiledIsActive 将返回 off

  • 模块是 Inline Variant 的非活动路径。

  • 模块是 Variant Subsystem 的非活动选择。

  • 模块在已注释掉的 Subsystem 模块内被注释掉。

  • 模块由于从 Variant Subsystem 模块传播的条件而处于非活动状态。

对于 Variant Subsystem 的非激活选择项,CompiledisActive 返回 off,对于激活选择项则返回 on

'off' | 'on'

CompiledPortComplexSignals

更新图后端口信号的复/实性。在查询此属性之前,必须先编译模型。例如:

vdp([],[],[],'compile');
d = get_param(gcb,'CompiledPortComplexSignals');
vdp([],[],[],'term');
结构体数组

CompiledPortDataTypes

更新图后端口信号的数据类型。在查询此属性之前,必须先编译模型。请参阅 CompiledPortComplexSignals

结构体数组

CompiledPortDesignMin

更新图后端口信号的设计最小值。在查询此属性之前,必须先编译模型。例如:

feval(gcs, [],[],[],'compile');
ports = get_param(gcb,'PortHandles');
min = get_param(ports.Outport, 'CompiledPortDesignMin')
feval(model, [],[],[],'term');
结构体数组

CompiledPortDesignMax

编译时端口信号的设计最大值。在查询此属性之前,必须先编译模型。例如:

feval(gcs, [],[],[],'compile');
ports = get_param(gcb,'PortHandles');
max = get_param(ports.Outport, 'CompiledPortDesignMax')
feval(model, [],[],[],'term');
结构体数组

CompiledPortDimensions

更新图后端口信号的维度。在查询此属性之前,必须先编译模型。有关详细信息,请参阅获取编译的端口维度

数值数组

CompiledPortDimensionsMode

指示端口信号是否具有可变大小(在更新图后)。在查询此属性之前,必须先编译模型。请参阅以编程方式确定信号线是否具有可变大小

double 数值。0 指示信号不具有可变大小。1 指示信号具有可变大小。

CompiledPortFrameData

更新图后端口信号的帧模式。在查询此属性之前,必须先编译模型。

结构体数组

CompiledPortWidths

更新图后端口宽度的结构体。在查询此属性之前,必须先编译模型。

结构体数组

CompiledSampleTime

更新图后的模块采样时间。在查询此属性之前,必须先编译模型。

向量 [sample time, offset time]

元胞 {[sample time 1, offset time 1]; [sample time 2, offset time 2];.....[sample time n, offset time n]}

ContinueFcn

(暂停之后)重新启动仿真时所调用的函数。

函数 | 字符向量

CopyFcn

复制模块时所调用的函数。有关详细信息,请参阅模块回调参数

函数 | 字符向量

DataTypeOverrideCompiled

供内部使用。

 

DeleteFcn

删除模块时所调用的函数。有关详细信息,请参阅模块回调参数

MATLAB® 表达式

DestroyFcn

销毁模块时所调用的函数。有关详细信息,请参阅模块回调参数

MATLAB 表达式

Description

模块的说明。通过 Block Properties 对话框中 General 窗格上的 Description 字段来进行设置。

文本和标记

Diagnostics

供内部使用。

 

DialogParameters

未封装模块的模块特定参数的名称/属性列表,或封装模块的封装参数。

结构体

DropShadow

显示阴影。

{'off'} | 'on'

ExtModeLoggingSupported

使模块能够支持在外部模式下上传信号数据(例如,对于 Scope 模块)。

{'off'} | 'on'

ExtModeLoggingTrig

使模块能够充当外部模式信号上传的 Trigger 模块。

{'off'} | 'on'

ExtModeUploadOption允许模块在未选中 External Signal & Triggering 对话框上的 Select all 复选框的情况下,在外部模式下上传信号数据。值为 log 表示模块上传信号。值为 none 表示模块不上传信号。值 monitor 当前未使用。如果选中 External Signal & Triggering 对话框中的 Select all 复选框,它将覆盖此参数设置。{'none'} | 'log' | 'monitor'

FontAngle

字体角度。

'normal' | 'italic' | 'oblique' | {'auto'}

FontName

字体名称。

字符数组

FontSize

字体大小。值为 -1 指示此模块继承由 DefaultBlockFontSize 模型参数指定的字体大小。

实数 {'-1'}

FontWeight

字体粗细。

'light' | 'normal' | 'demi' | 'bold' | {'auto'}

ForegroundColor

模块图标的前景颜色。

颜色值 |'[r,g,b]' | '[r,g,b,a]'

rgb 分别指颜色的红、绿、蓝分量值,这些值介于 0.0 与 1.0 之间。该值如果与画布颜色(ScreenColor 参数)过于相似,则会更改。使用 get_param 可返回实际值。如果指定此属性,将忽略 alpha 值 (a)。

可能的颜色值为 'black''white''red''green''blue''cyan''magenta''yellow''gray''lightBlue''orange''darkGreen'

Handle

模块句柄。

实数

HideAutomaticName

指定模型中是否显示由 Simulink Editor 自动给出的模块名称。要隐藏自动名称,请使用默认设置 'on'。(模型的 HideAutomaticNames 参数也必须设置为 'on'。)要显示名称,请设置为 'off',还要将模块 ShowName 参数设置为 'on'。如果模块的 ShowName 参数为 'off',则无论对此属性作何设置,这些模块都将隐藏。有关参数如何交互作用的详细信息,请参阅隐藏或显示模块名称{'on'} | 'off'

HiliteAncestors

供内部使用。

 

InitFcn

模块的初始化函数。在 Model Properties 对话框的 Callbacks 窗格上创建。有关详细信息,请参阅创建模型回调

对于未封装的模块,更新图或运行仿真时会调用此函数。

MATLAB 表达式

InputSignalNames

输入信号的名称。

元胞数组

IntrinsicDialogParameters

模块特定参数的名称/属性列表(无论模块是否封装)。如果需要封装模块或未封装模块的模块特定参数,请使用此参数代替 DialogParameters

结构体

IOSignalStrings

连接到 Signal & Scope Manager 的对象的模块路径。Simulink 软件会在保存模型时保存这些路径。

列表

IOType

Signal & Scope Manager 的类型。供内部使用。

 

IsStateOwnerBlock

指示该模块是否是可与 State ReaderState Writer 模块(只读)结合使用的受支持状态所有者模块。请参阅 State ReaderState Writer

'off' | 'on'

LibraryVersion

对于链接的模块,此属性的初始值是创建链接时模块库的 ModelVersion。在模块库的模型版本中,此值按增量更新。

字符向量 - {'1.1'}

LineHandles

连接模块的线条控制柄。

结构体

LinkData

包含参数化链接内与库中模块差异细节的数组,其中列出模块名称和参数值。可以使用 [] 重置为非参数化,例如 set_param(gcb,'linkData',[])

元胞数组

LinkStatus

模块的链接状态。使用 get_param 进行查询时更新过期的链接模块。

请参阅以编程方式控制链接模块

'none' | 'resolved' | 'unresolved' | 'implicit' | 'inactive' | 'restore' | 'propagate' | 'propagateHierarchy' | 'restoreHierarchy'

LoadFcn

加载模块时所调用的函数。

MATLAB 表达式

MinMaxOverflowLogging_Compiled

供内部使用。

 

ModelCloseFcn

关闭模型时所调用的函数。如果设置了模块的 DeleteFcn 和/或 DestroyFcn 回调,则会在调用这两个函数之前调用 ModelCloseFcn

MATLAB 表达式

ModelParamTableInfo

供内部使用。

 

MoveFcn

移动模块时所调用的函数。

MATLAB 表达式

Name

模块或信号名称。

要指定信号名称,请使用对应的端口或信号线句柄。

ports = get_param(gcb,'PortHandles');
set_param(ports.Outport(1), 'Name', 'NewName');

或者,要命名模块的输出信号,可以使用 SignalNameFromLabel

字符向量

NameChangeFcn

更改模块名称时所调用的函数。

MATLAB 表达式

NamePlacement

模块名称的位置。

{'normal'} | 'alternate'

ObjectParameters

模块参数的名称/属性。

结构体

OpenFcn

此 Block Parameters 对话框打开时所调用的函数。

MATLAB 表达式

Orientation

模块的朝向。

{'right'} | 'left' | 'up' | 'down'

OutputSignalNames

输出信号的名称。

元胞数组

Parent

模块所属的系统的名称。

字符向量 {'untitled'}

ParentCloseFcn

关闭父级子系统时所调用的函数。关闭模型时,不会调用位于根模型级别的模块的 ParentCloseFcn

MATLAB 表达式

PauseFcn

暂停仿真时所调用的函数。

函数 | 字符向量

PortConnectivity

此属性的值是一个结构体数组,其中每个结构体描述模块的一个输入或输出端口。每个端口结构体包含以下字段:

  • Type

    指定端口的类型和/或编号。此字段的值可以是:

    • n,其中 n 是数据端口的端口编号

    • 'enable'(如果端口是使能端口)

    • 'trigger'(如果端口是触发端口)

    • 'state',用于状态端口

    • 'ifaction',用于动作端口

    • 'LConn#',用于左侧连接端口,其中 # 是端口的编号

    • 'RConn#',用于右侧连接端口,其中 # 是端口的编号

  • Position

    此字段的值是一个二元素向量 [x y],用于指定端口的位置。

  • SrcBlock

    连接到此端口的模块的控制柄。对于输出端口,此字段为空;对于未连接的输入端口,此字段为 -1SrcBlock 属性是 Variant Subsystem 模块的有效源句柄。

  • SrcPort

    连接到此端口的端口的编号,从零开始。对于输出端口和未连接的输入端口,此字段均为空。

  • DstBlock

    此端口连接到的模块的句柄。对于输入端口,此字段为空;对于未连接的输出端口,此字段包含一个 1×0 的空矩阵。

  • DstPort

    此端口连接到的端口的编号,从零开始。对于输入端口,此字段为空;对于未连接的输出端口,此字段包含一个 1×0 的空矩阵。对于 Simscape 模块,该字段包含端口句柄。

结构体数组

PortHandles

此属性的值是一个结构体,用于指定模块端口的句柄。该结构体包含以下字段:

  • Inport

    模块的输入端口的句柄。

  • Outport

    模块的输出端口的句柄。

  • Enable

    模块的使能端口的句柄。

  • Trigger

    模块的触发端口的句柄。

  • State

    模块的状态端口的句柄。

  • LConn

    模块的左侧连接端口的句柄(适用于支持物理建模工具的模块)。

  • RConn

    模块的右侧连接端口的句柄(适用于支持物理建模工具的模块)。

  • Ifaction

    模块的动作端口的句柄。

  • Reset

    模块的重置端口的句柄。

结构体数组

PortRotationType

此模块所使用的端口旋转的类型(只读)。

'default' | 'physical'

Ports

一个向量,用于指定此模块的每一种端口的数量。该向量的元素顺序对应于下列端口类型:

  • Inport

  • Outport

  • Enable

  • Trigger

  • State

  • LConn

  • RConn

  • Ifaction

  • Reset

向量

Position

模块在模型窗口中的位置。

为了帮助对齐模块,您设置的位置可与实际的模块位置相差几个像素。使用 get_param 返回实际位置。

以像素为单位的坐标向量:[left top right bottom]

原点是尚未调整画布大小时 Simulink Editor 画布的左上角位置。支持的坐标在 -1073740824 和 1073740823 之间(包括二者)。位于原点右侧和下方的值为正值。位于原点左侧和上方的值为负值。

PostSaveFcn

保存模块之后所调用的函数。

MATLAB 表达式

PreCopyFcn

复制模块之前所调用的函数。有关详细信息,请参阅模块回调参数MATLAB 表达式

PreDeleteFcn

删除模块之前所调用的函数。有关详细信息,请参阅模块回调参数MATLAB 表达式

PreSaveFcn

保存模块之前所调用的函数。有关详细信息,请参阅模块回调参数

MATLAB 表达式

Priority

指定模块相对于同一模型中的其他模块的执行顺序。通过 Block Properties 对话框中 General 窗格上的 Priority 字段来进行设置。

字符向量 {''}

ReferenceBlock

此模块链接到的模块库模块的名称。

字符向量 {''}

RequirementInfo

供内部使用。

 

RTWData

用户指定的数据,供 Simulink Coder™ 软件使用。仅与用户编写的 S-Function 结合使用。有关详细信息,请参阅 S-Function RTWdata (Simulink Coder) 部分。

 

SampleTime

采样时间参数的值。有关详细信息,请参阅指定采样时间

字符向量

Selected

指示模块是否处于选中状态。

{'on'} | 'off'

ShowName

显示或隐藏模块名称。

要显示由 Simulink Editor 给出的模块名称(自动名称),请将模块的 'HideAutomaticName' 参数设置为 'off',将 ShowName 设置为 'on'。要隐藏 Editor 给出的自动模块名称,请将 ShowName 设置为 'on',将 HideAutomaticName 设置为 'on',并将模块上的 HideAutomaticNames 设置为 'on'。有关参数如何交互作用的详细信息,请参阅隐藏或显示模块名称

{'on'} | 'off'

SignalHierarchy

如果信号是总线,则返回总线中信号的名称和层次结构(只读)。

使用 get_param 指定端口或信号线句柄。例如:

ports = get_param(gcb,'PortHandles');
feval(gcs,[],[],[],'compile');
sh = get_param(ports.Outport,'SignalHierarchy')

请参阅Display Bus Information

反映指定信号的结构的值。

StartFcn

开始仿真时所调用的函数。

MATLAB 表达式

StatePerturbationForJacobian

线性化过程中要使用的状态扰动大小。有关详细信息,请参阅Change Perturbation Level of Blocks Perturbed During Linearization (Simulink Control Design)

字符向量

StaticLinkStatus

模块的链接状态。使用 get_param 进行查询时不更新过期的链接模块。另请参阅 LinkStatus

'none' | 'resolved' | 'unresolved' | 'implicit' | 'inactive' | 'restore' | 'propagate' | 'propagateHierarchy' | 'restoreHierarchy'

StopFcn

终止仿真时所调用的函数。

MATLAB 表达式

Tag

由 Simulink 软件生成的、显示在模块标签上的文本。通过 Block Properties 对话框中 General 窗格上的 Tag 字段来设置。

字符向量 {''}

Type

Simulink 对象类型(只读)。

'block'

UndoDeleteFcn

撤消模块删除操作时所调用的函数。

MATLAB 表达式

UserData

用户指定的数据,可以包含任何 MATLAB 数据类型。

{'[]'}

UserDataPersistent

指示是否将 UserData 保存到模型文件中的状态。

'on' | {'off'}

设置模块属性的示例

以下示例演示如何更改通用模块属性。

以下命令会更改 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])