simscape.probe.setVariableTable

Attach existing variable table to Probe block

Since R2024b

collapse all in page

    Syntax

    simscape.probe.setVariableTable(probe,VariableTable)

    Description

    simscape.probe.setVariableTable(probe,VariableTable) attaches the variable table object, VariableTable, to the Probe block, probe. The variable table can by empty or it can contain variable names, units, associated port label names, and the probing status for each variable.

    example

    Examples

    collapse all

    This example shows how to configure a simscape.probe.VariableTable object for the Ideal Torque Source block in the Permanent Magnet DC Motor example model and attach the table to a Probe block.

    Open the model.

    openExample('simscape/PermanentMagnetDCMotorExample')

    Add a Probe block to the model.

    add_block('nesl_utility/Probe','PermanentMagnetDCMotor/Probe');

    Bind the Probe block to the Ideal Torque Source block named Load Torque.

    simscape.probe.setBoundBlock('PermanentMagnetDCMotor/Probe','PermanentMagnetDCMotor/Load Torque')

    Get the default variable table for the Load Torque block.

    table1 = simscape.probe.defaultVariableTable('PermanentMagnetDCMotor/Load Torque')
    table1 = 

  VariableTable with 5 variable(s):

                Unit       PortLabel    Probing
              _________    _________    _______

    C.w ⟼    {[rad/s]}      "C.w"       false 
    R.w ⟼    {[rad/s]}      "R.w"       false 
    S   ⟼    {[N*m  ]}      "S"         false 
    t   ⟼    {[N*m  ]}      "t"         false 
    w   ⟼    {[rad/s]}      "w"         false

    The default probing status for all the variables is false.

    Change the probing status of the t variable.

    table1("t").Probing = true
    table1 = 

  VariableTable with 5 variable(s):

                Unit       PortLabel    Probing
              _________    _________    _______

    C.w ⟼    {[rad/s]}      "C.w"       false 
    R.w ⟼    {[rad/s]}      "R.w"       false 
    S   ⟼    {[N*m  ]}      "S"         false 
    t   ⟼    {[N*m  ]}      "t"         true  
    w   ⟼    {[rad/s]}      "w"         false

    Change the port label associated with the t variable.

    table1("t").PortLabel = "Torque"
    table1 = 
  VariableTable with 5 variable(s):

                Unit       PortLabel    Probing
              _________    _________    _______

    C.w ⟼    {[rad/s]}    "C.w"         false 
    R.w ⟼    {[rad/s]}    "R.w"         false 
    S   ⟼    {[N*m  ]}    "S"           false 
    t   ⟼    {[N*m  ]}    "Torque"      true  
    w   ⟼    {[rad/s]}    "w"           false

    Attach table1 as the variable table to the Probe block.

    simscape.probe.setVariableTable('PermanentMagnetDCMotor/Probe',table1)

    The name of the output port of the Probe block in the block diagram changes to Torque.

    To confirm that you properly attached the variable table table1 to the Probe block, enter:

    simscape.probe.getVariableTable('PermanentMagnetDCMotor/Probe')
    ans = 

  VariableTable with 5 variable(s):

                Unit       PortLabel    Probing
              _________    _________    _______

    C.w ⟼    {[rad/s]}    "C.w"         false 
    R.w ⟼    {[rad/s]}    "R.w"         false 
    S   ⟼    {[N*m  ]}    "S"           false 
    t   ⟼    {[N*m  ]}    "Torque"      true  
    w   ⟼    {[rad/s]}    "w"           false

    Input Arguments

    collapse all

    Probe block name, specified as a string scalar or a character vector, or a block handle.

    Data Types: double | char | string

    Variable table to attach to the Probe block, specified as a simscape.probe.VariableTable object.

    Version History

    Introduced in R2024b

    See Also

    | | |