target.APIImplementation - Describe API implementation details - MATLAB (original) (raw)

• Documentation
• Examples
• Functions
• Blocks
• Model Settings
• Apps
• Videos
• Answers

Main Content

Namespace: target

Describe API implementation details

Since R2020b

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

expand all

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

Attributes:

Description of the API implementation definition.

Attributes:

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

Attributes:

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

Attributes:

Examples

collapse all

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