clibgen.MethodDefinition Class

Namespace: clibgen

Definition for MATLAB function corresponding to C++ class method

Description

The clibgen.MethodDefinition class contains the MATLAB^® definition for a member function defined in the header of a C++ class.

The clibgen.MethodDefinition class is a handle class.

Creation

MATLAB constructs a MethodDefinition object when MATLAB calls addMethod on a clibgen.ClassDefinition object.

Properties

Description — Help text

string | character vector

Help text for the end user describing the method, 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.TestClass.charInput Method of C++ class TestClass.

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 method, 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++ method signature

string | character vector

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

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

Attributes:

GetAccess	public
SetAccess	private

DefiningClass — Class containing method

clibgen.ClassDefinition

Class containing the method, specified as a clibgen.ClassDefinition object.

Attributes:

GetAccess	public
SetAccess	private

MATLABSignature — Method signature in MATLAB

string | character vector

Method 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 method definition is complete, specified as true or false.

Attributes:

GetAccess	public
SetAccess	private

TemplateUniqueName — Preferred function name

string | character vector

Preferred function name for member 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++ method
defineOutput	Add output argument definition for C++ method
validate	Validate method definition

Version History

Introduced in R2019a