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

`dataFile` — XML file name
string | character vector

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

Properties

expand all

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

`PackageName` — MATLAB package name
string | character vector

MATLAB package name 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`

Methods

expand all

Public Methods

`addClass`	Add class to library definition
`addEnumeration`	Add enumeration to library definition
`addFunction`	Add function to library definition
`build`	Build library interface
`summary`	Display C++ classes, functions and enums in MATLAB interface
`validate`	Validate library definition

Documentation

clibgen.LibraryDefinition class

Description

Creation

Input Arguments

`dataFile` — XML file name
string | character vector

Properties

`OutputFolder` — Folder for interface files
string | character vector

Attributes:

`Libraries` — Library names
string | character vector

Attributes:

`IncludePath` — Path for include folders
string | character vector

Attributes:

`Classes` — Class definitions
`clibgen.ClassDefinition`

Attributes:

`Enumerations` — Enumeration definitions
`clibgen.EnumDefinition`

Attributes:

`Functions` — Nonmember function definitions
`clibgen.FunctionDefinition`

Attributes:

`HeaderFiles` — Header file names
string | character vector

Attributes:

`PackageName` — MATLAB package name
string | character vector

Attributes:

`DefinedMacros` — Macro definitions
string | character vector

Attributes:

`UndefinedMacros` — Macro cancellations
string | character vector

Attributes:

Methods

Public Methods

See Also

MATLAB Documentation

Support

Documentation

clibgen.LibraryDefinition class

Description

Creation

Input Arguments

dataFile — XML file name string | character vector

Properties

OutputFolder — Folder for interface files string | character vector

Attributes:

Libraries — Library names string | character vector

Attributes:

IncludePath — Path for include folders string | character vector

Attributes:

Classes — Class definitions clibgen.ClassDefinition

Attributes:

Enumerations — Enumeration definitions clibgen.EnumDefinition

Attributes:

Functions — Nonmember function definitions clibgen.FunctionDefinition

Attributes:

HeaderFiles — Header file names string | character vector

Attributes:

PackageName — MATLAB package name string | character vector

Attributes:

DefinedMacros — Macro definitions string | character vector

Attributes:

UndefinedMacros — Macro cancellations string | character vector

Attributes:

Methods

Public Methods

See Also

MATLAB Documentation

Support

`dataFile` — XML file name
string | character vector

`OutputFolder` — Folder for interface files
string | character vector

`Libraries` — Library names
string | character vector

`IncludePath` — Path for include folders
string | character vector

`Classes` — Class definitions
`clibgen.ClassDefinition`

`Enumerations` — Enumeration definitions
`clibgen.EnumDefinition`

`Functions` — Nonmember function definitions
`clibgen.FunctionDefinition`

`HeaderFiles` — Header file names
string | character vector

`PackageName` — MATLAB package name
string | character vector

`DefinedMacros` — Macro definitions
string | character vector

`UndefinedMacros` — Macro cancellations
string | character vector