Main Content

hdlget_param

Return value of specified HDL block-level parameter for specified block

Description

p = hdlget_param(block_path,prop) gets the value of a specified HDL property of the block or subsystem and returns the value to the output variable.

Examples

HDL Block Property Value

Open the sfir_fixed model. Set the OutputPipeline parameter for the DUT subsystem symmetric_fir to 3 by using the hdlset_param function. Return the value of the OutputPipeline parameter to the variable p by using the hdlget_param function.

  open sfir_fixed
  hdlset_param("sfir_fixed/symmetric_fir","OutputPipeline",3) 
  p = hdlget_param("sfir_fixed/symmetric_fir","OutputPipeline")
p =

     3

All HDL Block Properties

Return HDL block parameters and values for the product block m1 in the symmetric_fir subsystem that is in the sfir_fixed model to the cell array p.

p = hdlget_param("sfir_fixed/symmetric_fir/m1","all")
p =

  1×18 cell array

  Columns 1 through 8

    {'Architecture'}  {'Linear'}  {'ConstrainedOutp…'}  {[0]}  {'DSPStyle'}  {'none'}  {'HandleDenormals'}  {'inherit'}

  Columns 9 through 16

    {'InputPipeline'}  {[0]}  {'LatencyStrategy'}  {'inherit'}  {'MantissaMultipl…'}  {'inherit'}  {'NFPCustomLatency'}  {[0]}

  Columns 17 through 18

    {'OutputPipeline'}  {[0]}

Input Arguments

collapse all

Path to a block or subsystem in the current model.

Example: "modelname/subsysA/blockName"

A string scalar or character vector that designates one of the following:

  • The name of an HDL block property of the block or subsystem specified by path.

  • "all" : If prop is set to "all", hdlget_param returns Name,Value pairs for HDL properties of the specified block or subsystem.

Example: "OutputPipeline"

Output Arguments

collapse all

p stores the value of the HDL block property specified by prop. The data type and dimensions of p depend on the data type and dimensions of the value returned. If prop is set to "all", p is a cell array.

Tips

  • Use hdlget_param to obtain the value of HDL block parameters. For a list of block implementation parameters, see HDL Block Properties: General.

  • Use hdldispmdlparams to see the values of HDL model parameters. To obtain the value of general model parameters, use the get_param function.

Version History

Introduced in R2010b