clibgen.FunctionDefinition Class

Namespace: 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 MATLAB calls addFunction on a clibgen.LibraryDefinition object.

Properties

Description — Help text

string | character vector

Help text for the end user describing the package function, specified as a string or a character vector. The publisher can modify the value of the Description property in the library definition file.

Example: clib.cppSample.charInput Representation of C++ function charInput.

Attributes:

GetAccess	public
SetAccess	public

DetailedDescription — Help text from C++ header file

string | character vector | empty string

Help text from C++ header file for the end user describing details about the package function, specified as a string or a character vector. If the C++ comment does not contain detailed information, then DetailedDescription does not appear in the definition file.

The publisher can modify the value of the DetailedDescription property in the library definition file. If DetailedDescription is not empty, then the MATLAB doc command displays this sentence before displaying the value of DetailedDescription.

This content is from the external library documentation.

Attributes:

GetAccess	public
SetAccess	public

CPPSignature — C++ function signature

string | character vector

C++ function signature, specified as a string or a character vector. MATLAB creates CPPSignature from the function definition in the header file.

Example: void intInput(int * ptr,int len)

Attributes:

GetAccess	public
SetAccess	private

DefiningLibrary — Library containing function

clibgen.LibraryDefinition

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

Attributes:

GetAccess	public
SetAccess	private

MATLABName — C++ function name in MATLAB

string | character vector

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

Attributes:

GetAccess	public
SetAccess	private

MATLABSignature — Function signature in MATLAB

string | character vector

Function signature in MATLAB, specified as a string or a character vector. MATLAB creates this signature.

Attributes:

GetAccess	public
SetAccess	private
Dependent	true

Valid — Definition complete indicator

false (default) | true

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

Attributes:

GetAccess	public
SetAccess	private

TemplateUniqueName — Preferred function name

string | character vector

Preferred function name for functions derived from templates if there are overload functions, specified as a string or a character vector.

Example: "clib.libname.task_int_"

Attributes:

GetAccess	public
SetAccess	private

Methods

Public Methods

defineArgument	Add input argument definition for C++ package function
defineOutput	Add output argument definition for C++ package function
validate	Validate function definition

Version History

Introduced in R2019a