coder.ExternalDependency.getDescriptiveName

Class: coder.ExternalDependency
Package: coder

Return descriptive name for external dependency

Syntax

extname = coder.ExternalDependency.getDescriptiveName(bldcfg)


Description

extname = coder.ExternalDependency.getDescriptiveName(bldcfg) returns the name that you want to associate with an external dependency. The code generator uses the external dependency name for error messages.

You must implement this method in a subclass of coder.ExternalDependency.

Input Arguments

bldcfg — Build context during code generation

coder.BuildConfig object

Build context during code generation, specified as a coder.BuildConfig object. Use coder.BuildConfig methods to get information about the build context.

Output Arguments

extname — External dependency name

character vector

External dependency name, returned as a character vector.

Data Types: char

Examples

Return external dependency name

Define a method that always returns the same name.

function myextname = getDescriptiveName(~)
   myextname = 'MyLibrary'; 
end

Return external library name based on the code generation target

Define a method that uses the build context to determine the name.

function myextname = getDescriptiveName(context)
    if context.isMatlabHostTarget()
        myextname = 'MyLibary_MatlabHost';
    else
        myextname = 'MyLibrary_Local';
    end
end

More About

external dependency

External code interface represented by a class derived from a coder.ExternalDependency class. The external code can be a library, object files, or C/C++ source.

build context

Information used by the build process including:

• Target language

• Code generation target

• Target hardware

• Build toolchain

Version History

Introduced in R2013b