clibgen.FunctionDefinition class

Package: clibgen

Definition for MATLAB function corresponding to C++ package function

Description

The clibgen.FunctionDefinition class contains the MATLAB® definition for a function defined in the C++ header.

The clibgen.FunctionDefinition class is a handle class.

Creation

MATLAB constructs a FunctionDefinition object when you call addFunction on a clibgen.LibraryDefinition object.

Properties

expand all

Help text for the end user describing the package function, specified as a string or a character vector. The default text is

help clib.packageName.fullMLFuncName
C++ Function clib.packageName.fullMLFuncName

Attributes:

GetAccess
public
SetAccess
public

C++ function signature, specified as a string or a character vector.

Attributes:

GetAccess
public
SetAccess
private

Library containing the function, specified as a clibgen.LibraryDefinition object.

Attributes:

GetAccess
public
SetAccess
private

C++ function name in MATLAB, specified as a string or a character vector.

Attributes:

GetAccess
public
SetAccess
private

Function signature in MATLAB, specified as a string or a character vector. MATLAB displays this signature when you load the library.

Attributes:

GetAccess
public
SetAccess
private
Dependent
true

Indicate if function definition is complete, specified as true or false.

Attributes:

GetAccess
public
SetAccess
private

Methods

expand all

Introduced in R2019a