clibgen.LibraryDefinition Class

R2026b

Namespace: clibgen

(Not recommended) MATLAB definition for C++ library

The recommended way to generate MATLAB^® definitions for a C/C++ library is to create a clibgen.api.InterfaceConfiguration object. For more information on updating your code, see Version History.

Description

A clibgen.LibraryDefinition object contains information about a C++ library, such as the classes, functions, methods, and properties present in the library. The definitions help MATLAB identify information about parameters, such as pointers.

The clibgen.LibraryDefinition class is a handle class.

Creation

libdef = LibraryDefinition(dataFile) creates a library definition object from dataFile.xml, the name of the data file created by the clibgen.generateLibraryDefinition command. The constructor validates that the dataFile file is both syntactically and semantically valid. If the file is not valid, then the constructor throws an error.

Input Arguments

dataFile — XML filename

string | character vector

XML filename, specified as a string or a character vector, created by clibgen.generateLibraryDefinition. The name includes the extension .xml.

Properties

OutputFolder — Folder for interface files

string | character vector

Folder for interface files, specified as a string or a character vector.

Attributes:

GetAccess	public
SetAccess	public

Libraries — Library names

string | character vector

Library names, specified as a string or a character vector.

Attributes:

GetAccess	public
SetAccess	public

IncludePath — Path for include folders

string | character vector

Path for include folders, specified as a string or a character vector.

Attributes:

GetAccess	public
SetAccess	public

Classes — Class definitions

clibgen.ClassDefinition

Class definitions in the library, specified as one or more clibgen.ClassDefinition objects.

Attributes:

GetAccess	public
SetAccess	private

Enumerations — Enumeration definitions

clibgen.EnumDefinition

Enumeration definitions in the library, specified as one or more clibgen.EnumDefinition objects.

Attributes:

GetAccess	public
SetAccess	private

Functions — Nonmember function definitions

clibgen.FunctionDefinition

Nonmember function definitions in the library, specified as one or more clibgen.FunctionDefinition objects.

Attributes:

GetAccess	public
SetAccess	private

HeaderFiles — Header file names

string | character vector

Header file names to use in the library interface, specified as a string or a character vector.

Attributes:

GetAccess	public
SetAccess	private

SupportingSourceFiles — C++ source file names

string | character vector

C++ source file names, specified as one or more strings or a character vectors..

Attributes:

GetAccess	public
SetAccess	private

InterfaceName — MATLAB interface namespace

string | character vector

Since R2024a

MATLAB interface namespace for the library, specified as a string or a character vector.

Attributes:

GetAccess	public
SetAccess	private

DefinedMacros — Macro definitions

string | character vector

List of macro definitions to use while parsing header files, specified as a string or a character vector.

Attributes:

GetAccess	public
SetAccess	private

UndefinedMacros — Macro cancellations

string | character vector

List of macro cancellations to use while parsing header files, specified as a string or a character vector.

Attributes:

GetAccess	public
SetAccess	private

FunctionTypes — Definition of function types

clibgen.FunctionTypeDefinition

Definition of function types in the library, specified as one or more clibgen.FunctionTypeDefinition objects.

Attributes:

GetAccess	public
SetAccess	private

OpaqueTypes — Definition of typedef void*

clibgen.OpaqueTypeDefinition

Definition of typedef void* in the library, specified as one or more clibgen.OpaqueTypeDefinition objects.

Attributes:

GetAccess	public
SetAccess	private

Methods

Public Methods

addClass	(Not recommended) Add class to library definition
addEnumeration	(Not recommended) Add enumeration to library definition
addFunction	(Not recommended) Add function to library definition
addFunctionType	(Not recommended) Add function type to library definition
addOpaqueType	(Not recommended) Add opaque type to library definition
copyRuntimeDependencies	(Not recommended) Copy run-time libraries to C++ interface library folder
build	(Not recommended) Build library interface
summary	(Not recommended) Display C++ classes, functions and enums in MATLAB interface
validate	(Not recommended) Validate library definition

Version History

Introduced in R2019a

R2026b: Not recommended

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

R2024a: PackageName property renamed to InterfaceName

The name of the PackageName property is now InterfaceName. The behavior of the property remains the same. There are no plans to remove support for existing references to the property.