target.APIImplementation Class

Namespace: target

Describe API implementation details

Description

An API defines a set of entry-point functions for interaction with a software application or service. Use a target.APIImplementation object to provide details about how an API is used and built on target hardware.

To create a target.APIImplementation object, use the target.create function.

Properties

Name — API implementation name

character vector | string

Name of the APIImplementation object, which target.get uses as an identifier in data retrieval.

Attributes:

GetAccess	public
SetAccess	public

API — API description

target.API object

Description of the API implementation definition.

Attributes:

GetAccess	public
SetAccess	public

BuildDependencies — API implementation dependencies

target.Dependencies object

Source files, header files, and other dependencies that are needed for building and running the API on the target hardware.

Attributes:

GetAccess	public
SetAccess	public

MainFunction — main function requirements for API implementation

target.MainFunction object

Capture run-time dependencies such as main function arguments, initialization code, and main function build dependencies.

Attributes:

GetAccess	public
SetAccess	public

Examples

Describe rtiostream C API

This example provides implementation details for the rtiostream C API.

apiImp = target.create('APIImplementation', 'Name', ...
                       'x86 rtiostream Implementation');
apiImp.API = target.create('API', 'Name', 'rtiostream');
apiImp.BuildDependencies = target.create('BuildDependencies');
apiImp.BuildDependencies.SourceFiles = ...
      {fullfile('$(MATLAB_ROOT)', 'toolbox', ...
                'coder', 'rtiostream','src', ...
                'rtiostreamtcpip', 'rtiostream_tcpip.c')};
apiImp.MainFunction = target.create('MainFunction', ...
                      'Name', 'TCP RtIOStream Main');
apiImp.MainFunction.Arguments = {'-blocking', '1', '-port', '0'};

Version History

Introduced in R2020b