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
returns a deployerObj
= Deployer(deployerName
)Deployer
object, H
,
with the Name
property set to
deployerName
..
Input Arguments
deployerName
— Name of deployer configuration
string
Name of the Deployer
, specified as a
string.
Data Types: char
Output Arguments
Properties
Name
— Name of deployer object
''
(default) | char array
The name of the Deployer
object. The creation function,
Deployer
, sets Name
property.
Example: 'MyDeployer'
Attributes:
- GetAccess
public
- SetAccess
immutable
Data Types: char
Toolchains
— Toolchain objects
{}
(default) | cell array of Toolchain
objects
objects for the hardware, specified as a cell array
of objects. Use the and methods to add or delete
Toolchain
objects.
Example: {'GNU Tools for ARM Embedded
Processors'}
Attributes:
- GetAccess
public
- SetAccess
public
Data Types: cell array
Loaders
— Loader objects
{}
(default) | cell array
objects for the hardware, specified as a cell array of
objects. Use the and methods to add or delete
Loader
objects.
Example: {loaderObj}
Attributes:
- GetAccess
public
- SetAccess
private
Data Types: cell array
MainIncludeFiles
— Include files to include into generated main file
{}
(default) | cell array of char arrays
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
AfterCodeGenFcn
— MATLAB® function to invoke after code is generated
''
(default) | char array
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
BuildEntryFcn
— MATLAB function to invoke at start of build
''
(default) | char array
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
HardwareInitializationFcn
— Source code functions that initialize hardware
{}
(default) | cell array of char arrays
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
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 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
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
See Also
MATLAB Command
You clicked a link that corresponds to this MATLAB command:
Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)