Main Content

coder.descriptor.BreakpointDataInterface class

Package: coder.descriptor
Superclasses: coder.descriptor.DataInterface

Return information about tunable breakpoint set data for a lookup table that has tunable parameters

Description

The coder.descriptor.BreakpointDataInterface object describes various properties for breakpoint set data for these Lookup Table blocks that have tunable parameters in the generated code:

  • 1-D Lookup Table

  • 2-D Lookup Table

  • n-D Lookup Table

  • Interpolation Using Prelookup

  • Direct Lookup Table (n-D)

  • Sine

  • Cosine

Creation

params = getDataInterfaces(codeDescObj, dataInterfaceName) creates a coder.descriptor.BreakpointDataInterface object for each dimension in the lookup table. The codeDescObj object is the coder.codedescriptor.CodeDescriptor object created for the model by using the getCodeDescriptor function.

The coder.descriptor.LookupTableDataInterface and coder.descriptor.BreakpointDataInterface objects are created if these conditions are true:

  • Lookup table data is tunable.

  • One of these conditions is true:

    • Breakpoint set data is tunable.

    • Breakpoint set data is nontunable and the block does not use a Simulink.LookupTable object.

    • The block uses a Simulink.LookupTable object.

Input Arguments

expand all

Specify the Parameters data interface type.

Example: Parameters

Properties

expand all

The data type associated with the data such as integer, double, matrix, and its properties.

The Simulink identifier (SID) is a unique number within the model that Simulink assigns to a block.

The name of the associated tunable parameter for the breakpoints.

The variant conditions in the model that interact with the data interface.

Description of how the data in the generated code is implemented. This property describes characteristics such as data type and size. It also describes how the data is accessed or declared in the code. The property describes if the data is declared as a variable or structure member.

The rate at which data is accessed in a run-time environment.

Specified physical units as attributes on signals at the boundaries of model components.

The range of valid values for the block output signals.

To find the input value in the table, the operating point uses relative breakpoint set data.

Option to generate code that enables tunability of the effective size of the table, specified as 0 or 1.

Data Types: logical

Description of breakpoint set data that is either evenly spaced or non-evenly spaced. The coder.descriptor.FixAxisMetadata object is created only if the lookup table data is tunable and the breakpoint set data is not tunable.

Methods

expand all

Examples

collapse all

  1. Build the model.

    slbuild('rtwdemo_asap2')
  2. Create a coder.codedescriptor.CodeDescriptor object for the model.

    codeDescObj = coder.getCodeDescriptor('rtwdemo_asap2')
    
  3. Return properties of the Lookup Table parameters in the model.

    params = getDataInterfaces(codeDescObj, 'Parameters')

    The params variable is an array of coder.descriptor.DataInterface and coder.descriptor.LookupTableDataInterface objects. The model rtwdemo_asap2 contains three Lookup Table blocks. Only two of them have tunable breakpoint set data. The code generator creates only two corresponding coder.descriptor.LookupTableDataInterface objects.

    Obtain the details of the Standard_Axis block by accessing the sixth location in the array.

    params(6)
    The coder.descriptor.LookupTableDataInterface object with properties is returned.
                           Type: [1×1 coder.descriptor.types.Type]
                            SID: 'rtwdemo_asap2:14'
                  GraphicalName: 'tabledata'
                    VariantInfo: [1×0 coder.descriptor.VariantInfo]
                 Implementation: [1×1 coder.descriptor.DataImplementation]
                         Timing: [1×0 coder.descriptor.TimingInterface]
                           Unit: ''
                          Range: [1×0 coder.descriptor.Range]
             SupportTunableSize: 0
        BreakpointSpecification: 'Explicit values'
                         Output: [1×1 coder.descriptor.DataInterface]
                    Breakpoints: [1×2 coder.descriptor.BreakpointDataInterface Sequence]

  4. The Breakpoints property of the coder.descriptor.LookupTableDataInterface object holds a vector of coder.descriptor.BreakpointDataInterface objects. Obtain the details of the breakpoint set attached to the model Lookup Table block by accessing the first location in the array.

    params(6).Breakpoints(1)

    The coder.descriptor.BreakpointDataInterface object with properties is returned.

                      Type: [1×1 coder.descriptor.types.Type]
                       SID: 'rtwdemo_asap2:14'
             GraphicalName: 'tabledata'
               VariantInfo: [1×0 coder.descriptor.VariantInfo]
            Implementation: [1×1 coder.descriptor.DataImplementation]
                    Timing: [1×0 coder.descriptor.TimingInterface]
                      Unit: ''
                     Range: [1×0 coder.descriptor.Range]
            OperatingPoint: [1×1 coder.descriptor.DataInterface]
        SupportTunableSize: 0
           FixAxisMetadata: [1×0 coder.descriptor.FixAxisMetadata]
Introduced in R2020a