clibgen.OpaqueTypeDefinition Class

R2026b

Namespace: clibgen

(Not recommended) Definition for MATLAB type corresponding to C++ opaque type

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

Description

Use a OpaqueTypeDefinition object to represent typedef void* in the C++ library.

The clibgen.OpaqueTypeDefinition class is a handle class.

Creation

MATLAB^® constructs a OpaqueTypeDefinition object when MATLAB calls addOpaqueType on a clibgen.LibraryDefinition object.

Properties

Description — Help text

string | character vector

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

Attributes:

GetAccess	public
SetAccess	public

MATLABName — Opaque type name in MATLAB

string | character vector

Opaque type name in MATLAB, specified as a string or a character vector.

Attributes:

GetAccess	public
SetAccess	private

CPPSignature — Opaque type signature

string | character vector

Opaque type signature, specified as a string or a character vector.

Attributes:

GetAccess	public
SetAccess	private

DefiningLibrary — Library defining class

clibgen.LibraryDefinition

Library defining the opaque type, specified as a clibgen.LibraryDefinition object.

Attributes:

GetAccess	public
SetAccess	private

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 opaque type, 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

Version History

Introduced in R2021a

R2026b: Not recommended

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