get_param

获取参数名称和值

全页折叠

语法

ParamValue = get_param(Object,Parameter)

说明

示例

ParamValue = get_param(Object,Parameter) 返回指定模型或模块对象的指定参数的名称或值。首先打开或加载 Simulink^® 模型。

提示

如果您对同一个模块多次调用 get_param，则使用数值句柄指定模块比使用完整的模块路径更高效。使用 getSimulinkBlockHandle 获取模块句柄。

对于参数名称，请参阅：

示例

获取模块参数值和模型参数值

加载 vdp 模型。

load_system('vdp');

获取 Expression 模块参数的值。

BlockParameterValue = get_param('vdp/Mu','Multiplication')

BlockParameterValue =

    'Element-wise(K.*u)'

获取 SolverType 模型参数的值。

SolverType = get_param('vdp','SolverType')

SolverType =
   Variable-step

获取根参数名称和值

通过找出 Simulink 根参数名称与模型参数名称之间的区别，获取全局参数名称的列表。

RootParameterNames = fieldnames(get_param(0,'ObjectParameters'));
load_system('vdp')
ModelParameterNames = fieldnames(get_param('vdp','ObjectParameters'));
GlobalParameterNames = setdiff(RootParameterNames,ModelParameterNames)

GlobalParameterNames =
          'AutoSaveOptions'
          'CacheFolder'
          'CallbackTracing'
          'CharacterEncoding'
                 . . .
          'CurrentSystem'

获取全局参数的值。

GlobalParameterValue = get_param(0,'CurrentSystem')

GlobalParameterValue =
          vdp

获取模型参数名称和值

获取 vdp 模型的模型参数列表。

load_system('vdp')
ModelParameterNames = get_param('vdp','ObjectParameters')

ModelParameterNames =
              Name: [1x1 struct]
               Tag: [1x1 struct]
       Description: [1x1 struct]
              Type: [1x1 struct]
            Parent: [1x1 struct]
            Handle: [1x1 struct]
                       . . .
           Version: [1x1 struct]

获取 vdp 模型的 ModelVersion 模型参数的当前值。

ModelParameterValue = get_param('vdp','ModelVersion')

ModelParameterValue =
          1.6

获取所有模块和一个参数值

获取 vdp 模型的模块路径和名称列表。

load_system('vdp')
BlockPaths = find_system('vdp','Type','Block')

BlockPaths =

  14×1 cell array

    {'vdp/Constant'            }
    {'vdp/More Info'           }
    {'vdp/More Info/Model Info'}
    {'vdp/Mu'                  }
    {'vdp/Mux'                 }
    {'vdp/Product'             }
    {'vdp/Scope'               }
    {'vdp/Square'              }
    {'vdp/Sum'                 }
    {'vdp/Sum1'                }
    {'vdp/x1'                  }
    {'vdp/x2'                  }
    {'vdp/Out1'                }
    {'vdp/Out2'                }

获取 Mu 模块的模块对话框参数列表。

BlockDialogParameters = get_param('vdp/Mu','DialogParameters')

BlockDialogParameters = 

  struct with fields:

                         Gain: [1×1 struct]
               Multiplication: [1×1 struct]
                     ParamMin: [1×1 struct]
                     ParamMax: [1×1 struct]
             ParamDataTypeStr: [1×1 struct]
                       OutMin: [1×1 struct]
                       OutMax: [1×1 struct]
               OutDataTypeStr: [1×1 struct]
                    LockScale: [1×1 struct]
                      RndMeth: [1×1 struct]
    SaturateOnIntegerOverflow: [1×1 struct]
                   SampleTime: [1×1 struct]

获取 Multiplication 模块参数的值。

BlockParameterValue = get_param('vdp/Mu','Multiplication')

BlockParameterValue =
    'Element-wise(K.*u)'

使用模块句柄获取模块参数值

如果您对同一个模块多次调用 get_param，则使用模块句柄比以字符向量形式指定完整模块路径（例如，'vdp/Mu'）更高效。

您可以在对 get_param 或 set_param 的后续调用中使用该模块句柄。如果您检查该句柄，会发现它包含双精度值。不要试图只使用句柄的数值（例如 5.007），因为您通常需要指定的位数远远超过 MATLAB^® 显示的位数。而要将该句柄赋给变量，并使用该变量名称指定模块。

如果需要，可以使用 getSimulinkBlockHandle 来加载 vdp 模型（通过指定 true），并获取 Mu 模块的句柄。

mublockhandle = getSimulinkBlockHandle('vdp/Mu',true);

将模块句柄用于 get_param 以获取 Expr 模块参数的值。

BlockParameterValue = get_param(mublockhandle,'Multiplication')

BlockParameterValue =
    'Element-wise(K.*u)'

显示模型中所有模块的模块类型

获取 vdp 模型的模块路径和名称列表。

load_system('vdp')
BlockPaths = find_system('vdp','Type','Block')

BlockPaths =

  14×1 cell array

    {'vdp/Constant'            }
    {'vdp/More Info'           }
    {'vdp/More Info/Model Info'}
    {'vdp/Mu'                  }
    {'vdp/Mux'                 }
    {'vdp/Product'             }
    {'vdp/Scope'               }
    {'vdp/Square'              }
    {'vdp/Sum'                 }
    {'vdp/Sum1'                }
    {'vdp/x1'                  }
    {'vdp/x2'                  }
    {'vdp/Out1'                }
    {'vdp/Out2'                }

获取 vdp 模型中每个模块的 BlockType 参数值。

BlockTypes = get_param(BlockPaths,'BlockType')

BlockTypes =

  14×1 cell array

    {'Constant'  }
    {'SubSystem' }
    {'SubSystem' }
    {'Gain'      }
    {'Mux'       }
    {'Product'   }
    {'Scope'     }
    {'Math'      }
    {'Sum'       }
    {'Sum'       }
    {'Integrator'}
    {'Integrator'}
    {'Outport'   }
    {'Outport'   }

获取封装参数、Simulink 对象、模块图和注释的选项列表

您可以使用 get_param 和关键字 options 检索参数、Simulink 对象、模块图和注释的选项列表。

获取封装参数的选项列表

假设有如下示例，其中 Gain 模块是封装模块，并具有 popup 和 combo box 参数。

使用以下代码检索选项列表。

get_param('vdp/Mu', 'options@Multiplication')

ans =

  1×4 cell array

    {'Element-wise(K.*u)'}  
  {'Matrix(K*u)'}    {'Matrix(u*K)'}    {'Matrix(K*u) (u vec…'}

获取任何 Simulink 对象、模块图和注释中的选项

以 Subsystem 模块为例。您可以检索该模块中任一对象的选项。

get_param(gcb,'options@showportlabels')

ans =
  1×4 cell array
    {'none'}    {'FromPortIcon'}    {'FromPortBlockName'}    {'SignalName'}

获取封装参数的计算值

您可以使用具有关键字 value 的 get_param 命令来访问封装模块参数的计算值。

假设有如下示例，其中 Gain 模块是封装模块并具有一个编辑参数。

get_param(gcb,'value@edit')

ans =
     4

注意

检索计算值的选项仅限于封装参数

输入参数

全部折叠

`Object` — 模型、模块或根的名称或句柄
句柄 | 字符向量 | 字符向量元胞数组 | 字符串数组 | 0

模型、模块或根的句柄或名称，指定为数值句柄或字符向量；对于多个模块，则为字符向量元胞数组；对于根，则为 0。数值句柄必须为标量。您还可以获取信号线和端口的参数，但必须使用数值句柄指定它们。

提示

如果您对同一个模块多次调用 get_param，则使用数值句柄指定模块比使用完整的模块路径更高效。使用 getSimulinkBlockHandle 获取模块句柄。不要试图只使用句柄的数值（例如 5.007），因为您通常需要指定的位数远远超过 MATLAB 显示的位数。要将句柄赋给变量，并使用该变量名称指定模块。

指定 0 以获取根参数名称，包括当前 Simulink 会话的全局参数和模型参数。

全局参数包括编辑器预设项和 Simulink Coder™ 参数。
模型参数包括配置参数、Simulink Coder 参数和 Simulink Code Inspector™ 参数。

示例： 'vdp/Mu'

`Parameter` — 模型、模块或根的参数
字符向量 | 字符串标量

模型、模块或根的参数，指定为字符向量，对于根，则为 0。下表显示了特殊情况。

指定的参数结果

指定的参数	结果
`'ObjectParameters'`	返回一个结构体数组，指定的对象（模型、模块或根）的参数名称在结构体中为单独的字段。
`'DialogParameters'`	返回一个结构体数组，模块对话框参数名称在结构体中为单独的字段。如果模块有封装，则函数返回封装参数。
参数名称，例如 `'BlockType'`。指定任何模型或模块参数，或模块对话框参数。	返回指定的模型或模块参数的值。如果以元胞数组形式指定了多个模块，将返回一个元胞数组，其中包含所有模块都共有的指定参数的值。该元胞数组中所有指定的模块都必须包含该参数，否则函数将返回错误。

'ObjectParameters'

返回一个结构体数组，指定的对象（模型、模块或根）的参数名称在结构体中为单独的字段。

'DialogParameters'

返回一个结构体数组，模块对话框参数名称在结构体中为单独的字段。如果模块有封装，则函数返回封装参数。

参数名称，例如 'BlockType'。指定任何模型或模块参数，或模块对话框参数。

返回指定的模型或模块参数的值。

如果以元胞数组形式指定了多个模块，将返回一个元胞数组，其中包含所有模块都共有的指定参数的值。该元胞数组中所有指定的模块都必须包含该参数，否则函数将返回错误。

示例： 'ObjectParameters'

数据类型： char

输出参数

全部折叠

`ParamValue` — 指定的模型、模块或根的指定参数的名称或值
任何数据类型，具体取决于参数

指定的模型、模块或根的指定参数的名称或值。如果您指定多个对象，则输出是对象元胞数组。下表显示了特殊情况。

指定的参数	返回的参数值
`'ObjectParameters'`	一个结构体数组，指定的对象（模型、模块或根）的参数名称在结构体中为单独的字段。
`'DialogParameters'`	一个结构体数组，模块对话框参数名称在结构体中显示为单独的字段。如果模块有封装，则函数返回封装参数。
参数名称，例如 `'BlockType'`	指定的模型或模块参数的值。如果以元胞数组形式指定了多个模块，将返回一个元胞数组，其中包含对所有模块都通用的指定参数的值。

如果您通过指定 get_param(0,'ObjectParameters') 来获取根参数，则输出 ParamValue 是一个结构体数组，根参数名称在结构体中为单独的字段。每个参数字段都是一个结构体，其中包含以下字段：

类型 - 参数类型值包括：'boolean'、'string'、'int'、'real'、'point'、'rectangle'、'matrix'、'enum'、'ports' 或 'list'
枚举 - 枚举字符向量值的元胞数组，仅适用于 'enum' 参数类型
属性 - 定义参数属性的字符向量元胞数组。值包括：'read-write'、'read-only'、'read-only-if-compiled'、'write-only'、'dont-eval'、 'always-save'、'never-save'、'nondirty' 或 'simulation'