clibgen.LibraryDefinition - MATLAB definition for C++ library - MATLAB (original) (raw)
Namespace: 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](#mw%5Fa095cbc4-6c78-46b6-8a48-c3e95c52d009)) creates a library definition object from `dataFile`.xml, the name of the data file created by the clibgen.generateLibraryDefinition command. The constructor validates that thedataFile file is both syntactically and semantically valid. If the file is not valid, then the constructor throws an error.
Input Arguments
Properties
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 |
Since R2024a
MATLAB interface namespace 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
Version History
Introduced in R2019a
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.