clibgen.ClassDefinition Class

R2026b

Namespace: clibgen

(Not recommended) Definition for MATLAB class corresponding to C++ class

The recommended way to generate a class definition for a C++ library is to use a clibgen.api.ClassDefinition object. For more information on updating your code, see Version History.

Description

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

The clibgen.ClassDefinition class is a handle class.

Creation

MATLAB constructs a ClassDefinition object when MATLAB calls addClass on a clibgen.LibraryDefinition object.

Properties

Description — MATLAB help text

string | character vector

MATLAB help text for the end user describing the class, specified as a string or a character vector. The default text is:

MATLABName    Representation of C++ class CPPName.

You can modify the value of the Description property in the library definition file.

Example: clib.cppSample.TestClass Representation 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 class, specified as a string or a character vector.

If the C++ file does not contain a comment about the class, then DetailedDescription is empty and does not appear in the definition file.

If DetailedDescription is not empty, then the MATLAB doc command displays the following sentence before displaying the value of DetailedDescription:

This content is from the external library documentation.

Use the DetailedDescription property to provide more information about the interface definition file.

Attributes:

GetAccess	public
SetAccess	public

MATLABName — C++ class name in MATLAB

string | character vector

C++ class name in MATLAB, specified as a string or a character vector. MATLAB creates MATLABName from the InterfaceName and CPPName properties.

clib.DefiningLibrary.InterfaceName.CPPName

Example: clib.cppSample.TestClass

Attributes:

GetAccess	public
SetAccess	private

CPPName — C++ class name

string | character vector

C++ class name, specified as a string or a character vector. MATLAB creates CPPName from the class name in the header file.

Example: TestClass

Attributes:

GetAccess	public
SetAccess	private

Methods — Class methods

clibgen.MethodDefinition

Class methods, specified as one or more clibgen.MethodDefinition objects.

Attributes:

GetAccess	public
SetAccess	private

Constructors — Class constructors

clibgen.ConstructorDefinition

Class constructors, specified as one or more clibgen.ConstructorDefinition objects.

Attributes:

GetAccess	public
SetAccess	private

Properties — Class properties

clibgen.PropertyDefinition

Class properties, specified as one or more clibgen.PropertyDefinition objects.

Attributes:

GetAccess	public
SetAccess	private

DefiningLibrary — Library defining class

clibgen.LibraryDefinition

Library defining the class, specified as a clibgen.LibraryDefinition object.

Attributes:

GetAccess	public
SetAccess	private

Methods

Public Methods

addConstructor	(Not recommended) Add constructor to C++ class definition
addMethod	(Not recommended) Add method to C++ class definition
addProperty	(Not recommended) Add property to C++ class definition

Version History

Introduced in R2019a

R2026b: Not recommended

There are no plans to remove clibgen.ClassDefinition. However, creating a clibgen.api.ClassDefinition object in the clibgen.api namespace is recommended instead.