Main Content

clibgen.ClassDefinition class

Package: clibgen

Definition for MATLAB class corresponding to C++ class

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

expand all

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.

The publisher 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

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++ 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

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

clib.DefiningLibrary.PackageName.CPPName

Example: clib.cppSample.TestClass

Attributes:

GetAccess
public
SetAccess
private

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

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

Attributes:

GetAccess
public
SetAccess
private

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

Attributes:

GetAccess
public
SetAccess
private

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

Attributes:

GetAccess
public
SetAccess
private

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

Attributes:

GetAccess
public
SetAccess
private

Methods

expand all

Introduced in R2019a