matlabshared.targetsdk.Deployer Class

Namespace: matlabshared.targetsdk

Application deployment configuration

Description

Add-On Required: This feature requires one of these add-ons.

• Embedded Coder Support Package for ARM Cortex-A Processors
• Embedded Coder Support Package for ARM Cortex-R Processors
• Embedded Coder Support Package for ARM Cortex-M Processors

Use the Deployer class to represent a deployer used to deploy generated code to the Hardware that a Target supports.

Creation

deployerObj = matlabshared.targetsdk.Deployer(deployerName) returns a Deployer object H with the Name property set to deployerName.

Input Arguments

deployerName — Name of deployer configuration

character vector | string scalar

Name of the Deployer, specified as a character vector or string scalar.

This argument sets the Name property as a character vector.

Data Types: char | string

Properties

Name — Name of deployer object

'' (default) | character vector | string scalar

The name of the Deployer object. The creation function Deployer sets the Name property.

Example: 'MyDeployer'

Attributes:

GetAccess	public
SetAccess	immutable

Data Types: char | string

Toolchains — Toolchain names

{} (default) | cell array of Toolchain names

Registered Toolchain names for the hardware, specified as a cell array of names. Use the addNewToolchain and deleteToolchain methods to add or delete Toolchain objects.

Example: {'GNU Tools for ARM Embedded Processors'}

Attributes:

GetAccess	public
SetAccess	public

Data Types: cell

Loaders — Loader names

{} (default) | cell array of Loader names

Loader names for the hardware, specified as a cell array of names. Use the addNewLoader and deleteLoader methods to add or delete Loader objects.

Example: {'loaderName'}

Attributes:

GetAccess	public
SetAccess	private

Data Types: cell

MainIncludeFiles — Include files to include into generated main file

{} (default) | cell array of character vectors

Include files to add into generated main.c or main.cpp file using the #include directive specified as a cell array of character vectors.

Example: {'blapp_support.h'}

Attributes:

GetAccess	public
SetAccess	public

Data Types: cell

AfterCodeGenFcn — MATLAB^® function to invoke after code is generated

'' (default) | character vector | string scalar

MATLAB function to invoke after code is generated. The function must have this signature:

function onAfterCodeGen(hCS, buildInfo)
% Code to be called after code generation
end

Here, buildInfo is the RTW.BuildInfo build information object, and hCS is the configuration object.

Example: 'onAfterCodeGen'

Attributes:

GetAccess	public
SetAccess	public

Data Types: char | string

BuildEntryFcn — MATLAB function to invoke at start of build

'' (default) | character vector | string scalar

Name of a MATLAB function to invoke at the start of a build. The function must have this signature:

function onBuildEntry(hCS, buildInfo)
% Code to be called after code generation
end

Here, buildInfo is the RTW.BuildInfo build information object, and hCS is the configuration object.

Example: 'onBuildEntry'

Attributes:

GetAccess	public
SetAccess	public

Data Types: char | string

HardwareInitializationFcn — Source code functions that initialize hardware

{} (default) | cell array of character vectors

The C/C++ source code functions that initialize hardware. Each function is called from the generated main file. Functions are assumed to take no input arguments.

Example: {'stm32f4xx_init_board()'}

Attributes:

GetAccess	public
SetAccess	public

Data Types: cell

Tokens — Strings replaced by other strings during code generation

{} (default) | cell array of structures

Placeholder values in code to be replaced with specified string value during code generation. Each token structure contains two fields: Name and Value. Name is a string in the form $(SOME_NAME) that gets replaced during code generation by the Value string. Value must have one of these values:

• Empty string — In this case, you must define an environment variable with the corresponding name (that is, SOME_NAME).

• MATLAB function — The build process evaluates the function when the process encounters the token.

• String — The string replaces Name.

deployerObj = matlabshared.targetsdk.Deployer('MyDeployer');
token.Name = 'MY_PI_VALUE';
token.Value = '3.1415926';
deployerObj.Tokens = {token}

deployerObj = 

  Deployer with properties:

                         Name: 'MyDeployer'
                   Toolchains: {}
                      Loaders: {}
             MainIncludeFiles: {}
                       Tokens: {[1×1 struct]}
                BuildEntryFcn: ''
              AfterCodeGenFcn: ''
    HardwareInitializationFcn: {}

Attributes:

GetAccess	public
SetAccess	public

Data Types: cell

Methods

Public Methods

addNewLoader	Add new loader to target
addNewToolchain	Add a registered Toolchain to the Deployer object
deleteLoader	Delete loader from the deployer object
deleteToolchain	Delete toolchain from deployer

Version History

Introduced in R2015a