Main Content

clibgen.LibraryDefinition class

Package: clibgen

MATLAB definition for C++ library

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

expand all

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

Properties

expand all

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

Attributes:

GetAccess
public
SetAccess
public

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

Attributes:

GetAccess
public
SetAccess
public

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

Attributes:

GetAccess
public
SetAccess
public

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

Attributes:

GetAccess
public
SetAccess
private

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

Attributes:

GetAccess
public
SetAccess
private

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

Attributes:

GetAccess
public
SetAccess
private

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

Attributes:

GetAccess
public
SetAccess
private

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

Attributes:

GetAccess
public
SetAccess
private

MATLAB package name for the library, specified as a string or a character vector.

Attributes:

GetAccess
public
SetAccess
private

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

Attributes:

GetAccess
public
SetAccess
private

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

Attributes:

GetAccess
public
SetAccess
private

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

Attributes:

GetAccess
public
SetAccess
private

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

Attributes:

GetAccess
public
SetAccess
private

Methods

expand all

Introduced in R2019a