Main Content

matlabshared.targetsdk.Deployer Class

Namespace: matlabshared.targetsdk

Application deployment configuration

Description

A Deployer object represents a deployer used to deploy generated code to the Hardware that a Target supports.

Creation

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

Input Arguments

expand all

Name of the Deployer, specified as a string.

Data Types: char

Output Arguments

expand all

The Deployer object representing the deployment configuration in the Target under development.

Properties

expand all

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

Example: 'MyDeployer'

Attributes:

GetAccess

public

SetAccess

immutable

Data Types: char

Toolchain objects for the hardware, specified as a cell array of objects. 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 array

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

Example: {loaderObj}

Attributes:

GetAccess

public

SetAccess

private

Data Types: cell array

Include files to add into generated main.c or main.cpp file using the #include directive.

Example: {'blapp_support.h'}

Attributes:

GetAccess

public

SetAccess

public

Data Types: cell

The MATLAB function to invoke after code is generated. The function requires the following signature:

function onAfterCodeGen(hCS, buildInfo)
% Add here code to be called after code generation.
end

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

Example: 'onAfterCodeGen'

Attributes:

GetAccess

public

SetAccess

public

Data Types: char

Name of a MATLAB function to invoke at start of build. The function requires the following signature:

function onBuildEntry(hCS, buildInfo)
% Add here code to be called after code generation.
end

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

Example: 'onBuildEntry'

Attributes:

GetAccess

public

SetAccess

public

Data Types: char

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 array

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 be set in one of the following ways:

  • 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

addNewLoaderAdd new loader to target
addNewToolchainAdd a registered Toolchain to the Deployer object
deleteLoaderDelete loader from the deployer object
deleteToolchainDelete toolchain from deployer

Version History

Introduced in R2015a