Main Content

coder.Summary Properties

Summary of code generation from MATLAB code

coder.Summary properties contain a summary of code generation from MATLAB® code. The summary includes information about code generation success, path to the code generation output, toolbox licenses checked out during code generation, toolchain, and build configuration. All coder.Summary properties are read-only. You can use dot notation to query these properties.

You do not directly create a coder.Summary object. When you generate a coder.ReportInfo object that contains code generation report information, a coder.Summary object is automatically created as one of its properties. For more information, see coder.ReportInfo Properties and Access Code Generation Report Information Programmatically.

This property is read-only.

Status of code generation from MATLAB code, specified as one of the values in this table.

ValueDescription
true

Code generation succeeded.

false

Code generation failed.

Data Types: logical

This property is read-only.

Date and time of code generation from MATLAB code, specified as a character vector.

Example: '28-Nov-2018 09:59:54'

Data Types: char

This property is read-only.

Path to the generated files, specified as a character vector.

Example: 'C:\coder\R2019a\Report Info Object\codegen\lib\foo\foo.lib'

Data Types: char

This property is read-only.

Information about processor used for code generation from MATLAB code, specified as a character vector.

Example: 'Generic->MATLAB Host Computer'

Data Types: char

This property is read-only.

Version of MATLAB Coder used for code generation from MATLAB code, specified as a character vector.

Example: 'MATLAB Coder 4.2 (R2019a)'

Data Types: char

This property is read-only.

Toolbox licenses that the code generator checks out during code generation from MATLAB code, specified as a string vector.

Example: ["statistics_toolbox" "wavelet_toolbox"]

Note

If you generate MEX code, these licenses are checked out again when you load the MEX function.

If you generate static library or dynamically linked library, the toolbox licenses are checked out only during code generation. The code generator does not write license checkouts into generated standalone code.

Data Types: string

This property is read-only.

Toolchain used for code generation from MATLAB code, specified as a character vector. This property is present only if you generate standalone code.

Data Types: char

This property is read-only.

Build configuration selected for code generation from MATLAB code, specified as a character vector. This property is present only if you generate standalone code.

Example: 'Faster Builds'

Data Types: char

Introduced in R2019a