Generated Code Interfacing

Exchange data between generated code and external application code using C API interface and Code Descriptor interface

Some applications must exchange data between generated code and external application code. Use the MATLAB code descriptor API to obtain the metadata about the generated code. Use the C API to interface with the generated code at runtime and to monitor and tune model elements during the execution of model code on the target platform.

Classes

expand all

Code Descriptor Interface

`coder.codedescriptor.CodeDescriptor`	Return information about generated code
`coder.descriptor.DataInterface`	Return information about different types of data interfaces
`coder.descriptor.FunctionInterface`	Return information about entry-point functions
`coder.descriptor.LookupTableDataInterface`	Return information about Lookup Table blocks that have tunable parameters
`coder.descriptor.BreakpointDataInterface`	Return information about tunable breakpoint set data for a lookup table that has tunable parameters
`coder.descriptor.SignalOfInterest`	Return information about signals of interest in generated code (Since R2025a)

Code Descriptor Data Implementation

`coder.descriptor.DataImplementation`	Return information about implementation of data in generated code (Since R2025a)
`coder.descriptor.TypedRegion`	Return information about implementation of typed data in generated code (Since R2025a)

Code Descriptor Types

`coder.descriptor.types.Aggregate`	Return information about variable of aggregate type (Since R2024a)
`coder.descriptor.types.AggregateElement`	Return information about element of aggregate type (Since R2024a)
`coder.descriptor.types.Argument`	Return information about argument associated with function or method in generated code (Since R2024a)
`coder.descriptor.types.Bool`	Return information about variable of Boolean type (Since R2024a)
`coder.descriptor.types.Char`	Return information about variable of character type (Since R2024a)
`coder.descriptor.types.Complex`	Return information about variable of complex type (Since R2024a)
`coder.descriptor.types.Double`	Return information about variable of double-precision type (Since R2024a)
`coder.descriptor.types.Enum`	Return information about variable of enum type (Since R2024b)
`coder.descriptor.types.Fixed`	Return information about variable of fixed-point type (Since R2024a)
`coder.descriptor.types.Half`	Return information about variable of half-precision type (Since R2024a)
`coder.descriptor.types.Integer`	Return information about variable of integer type (Since R2024a)
`coder.descriptor.types.Matrix`	Return information about variable of matrix type (Since R2024a)
`coder.descriptor.types.Numeric`	Return information about variable of numeric type (Since R2024a)
`coder.descriptor.types.Pointer`	Return information about variable of pointer type (Since R2024a)
`coder.descriptor.types.Prototype`	Return information about function prototype in generated code (Since R2024a)
`coder.descriptor.types.Reference`	Return information about variable of reference type (Since R2024a)
`coder.descriptor.types.Scalar`	Return information about variable of scalar type (Since R2024a)
`coder.descriptor.types.Single`	Return information about variable of single-precision type (Since R2024a)
`coder.descriptor.types.Struct`	Return information about variable of `struct` type (Since R2024a)
`coder.descriptor.types.Type`	Return information about data type of modeling element or corresponding variable in generated code (Since R2024a)
`coder.descriptor.types.Union`	Return information about variable of `union` type (Since R2024a)
`coder.descriptor.types.Void`	Represent base type of void pointer (Since R2024a)

Functions

expand all

Code Descriptor Interface

getCodeDescriptor Create coder.codedescriptor.CodeDescriptor object for model

Topics

C API Interface

Get Started with C API

Learn the principles of using C API to interact with the generated model code.
- STEP 1: Explore Measurable and Tunable Model Elements
- STEP 2: Configure Model to Add C API Signals in Code Generation
- STEP 3: Write Code that Interacts with C API Code
Configure Model to Generate C API Code

Learn how to configure your model to include different types of C API elements in the generated code.
Write External Code to Access Generated C API Code

Learn how to write external code that can access generated C API code elements.
Use C API to Monitor and Tune Generated Model Code

Learn the details about how to use the C API to monitor and tune model elements.
- STEP 1: Explore Measurable and Tunable Model Elements
- STEP 2: Configure Model to Add C API Signals in Code Generation
- STEP 3: Write Code to Interact with Generated C API Signal Code
- STEP 4: Interact with C API Signal Code Throughout Execution
- STEP 5: Write Code to Interact with Generated C API Signal and Parameter Code
- STEP 6: Use Custom Monitor to Measure and Tune Model Elements in Real Time

Code Descriptor Interface

Get Code Description of Generated Code
Obtain metadata about the generated code.
Get Generated Type and Name of Inport Structures
Obtain metadata about the inport structures in generated code.
Get Metadata About Test Points and Logged Signals in Generated Code
Retrieve metadata for test points and logged signals in generated code.

How useful was this information?

Unrated 1 star 2 stars 3 stars 4 stars 5 stars