clibgen.LibraryDefinition class

Пакет: clibgen

Определение MATLAB для библиотеки C++

Описание

A clibgen.LibraryDefinition объект содержит сведения о библиотеке C++, такие как классы, функции, методы и свойства, существующие в библиотеке. Определения помогают MATLAB^® идентифицируйте информацию о параметрах, таких как указатели.

The clibgen.LibraryDefinition класс является handle класс.

Создание

libdef = LibraryDefinition(dataFile) создает объект определения библиотеки из dataFile.xml, имя файла данных, созданного clibgen.generateLibraryDefinition команда. Конструктор проверяет, что dataFile файл является синтаксически и семантически допустимым. Если файл недействителен, конструктор выдает ошибку.

Входные параметры

расширить все

`dataFile` - Имя XML-файла
строка | вектор символов

Имя файла XML, заданное как строка или вектор символов, созданное clibgen.generateLibraryDefinition. Имя включает расширение .xml.

Свойства

расширить все

`OutputFolder` - Папка для файлов интерфейса
строка | вектор символов

Папка для файлов интерфейса, заданная как строка или вектор символов.

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`public`

`Libraries` - Имена библиотек
строка | вектор символов

Имена библиотек, заданные как строка или вектор символов.

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`public`

`IncludePath` - Путь для включения папок
строка | вектор символов

Путь для include папок, заданный как строка или вектор символов.

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`public`

`Classes` - Определения классов
`clibgen.ClassDefinition`

Определения классов в библиотеке, заданные как одно или несколько clibgen.ClassDefinition объекты.

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`private`

`Enumerations` - Определения перечисления
`clibgen.EnumDefinition`

Определения перечислений в библиотеке, заданные как одно или несколько clibgen.EnumDefinition объекты.

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`private`

`Functions` - Определения функций, не являющихся членами
`clibgen.FunctionDefinition`

Определения функций, не являющихся членами библиотеки, задаются как одно или несколько clibgen.FunctionDefinition объекты.

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`private`

`HeaderFiles` - Имена заголовочных файлов
строка | вектор символов

Имена заголовочных файлов для использования в интерфейсе библиотеки, заданные как строка или вектор символов.

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`private`

`SupportingSourceFiles` - Имена исходных файлов C++
строка | вектор символов

Имена исходных файлов C++, заданные как одна или несколько строк или векторов символов..

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`private`

`PackageName` - имя пакета MATLAB
строка | вектор символов

Имя пакета MATLAB для библиотеки, заданное как строка или вектор символов.

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`private`

`DefinedMacros` - Определения макросов
строка | вектор символов

Список определений макросов, используемых при анализе заголовочных файлов, заданный как строка или вектор символов.

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`private`

`UndefinedMacros` - Отмена макросов
строка | вектор символов

Список отмененных макросов, используемых при анализе заголовочных файлов, заданный как строка или вектор символов.

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`private`

`FunctionTypes` - Определение типов функций
`clibgen.FunctionTypeDefinition`

Определение типов функций в библиотеке, заданное как одно или несколько clibgen.FunctionTypeDefinition объекты.

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`private`

`OpaqueTypes` - Определение `typedef void*`
`clibgen.OpaqueTypeDefinition`

Определение typedef void* в библиотеке, заданной как один или несколько clibgen.OpaqueTypeDefinition объекты.

Атрибуты:

`GetAccess`	`public`
`SetAccess`	`private`

Методы

расширить все

Общедоступные методы

`addClass`	Добавьте класс к определению библиотеки
`addEnumeration`	Добавьте перечисление в определение библиотеки
`addFunction`	Добавьте функцию в определение библиотеки
`addFunctionType`	Добавьте тип функции в определение библиотеки
`addOpaqueType`	Добавьте непрозрачный тип к определению библиотеки
`build`	Создайте интерфейс библиотеки
`summary`	Отображение классов, функций и перечислений C++ в интерфейсе MATLAB
`validate`	Проверьте определение библиотеки

См. также

clibgen.generateLibraryDefinition

Введенный в R2019a

Документация

clibgen.LibraryDefinition class

Описание

Создание

Входные параметры

`dataFile` - Имя XML-файла
строка | вектор символов

Свойства

`OutputFolder` - Папка для файлов интерфейса
строка | вектор символов

Атрибуты:

`Libraries` - Имена библиотек
строка | вектор символов

Атрибуты:

`IncludePath` - Путь для включения папок
строка | вектор символов

Атрибуты:

`Classes` - Определения классов
`clibgen.ClassDefinition`

Атрибуты:

`Enumerations` - Определения перечисления
`clibgen.EnumDefinition`

Атрибуты:

`Functions` - Определения функций, не являющихся членами
`clibgen.FunctionDefinition`

Атрибуты:

`HeaderFiles` - Имена заголовочных файлов
строка | вектор символов

Атрибуты:

`SupportingSourceFiles` - Имена исходных файлов C++
строка | вектор символов

Атрибуты:

`PackageName` - имя пакета MATLAB
строка | вектор символов

Атрибуты:

`DefinedMacros` - Определения макросов
строка | вектор символов

Атрибуты:

`UndefinedMacros` - Отмена макросов
строка | вектор символов

Атрибуты:

`FunctionTypes` - Определение типов функций
`clibgen.FunctionTypeDefinition`

Атрибуты:

`OpaqueTypes` - Определение `typedef void*`
`clibgen.OpaqueTypeDefinition`

Атрибуты:

Методы

Общедоступные методы

См. также

Документация MATLAB

Поддержка

Документация

clibgen.LibraryDefinition class

Описание

Создание

Входные параметры

dataFile - Имя XML-файла строка | вектор символов

Свойства

OutputFolder - Папка для файлов интерфейса строка | вектор символов

Атрибуты:

Libraries - Имена библиотек строка | вектор символов

Атрибуты:

IncludePath - Путь для включения папок строка | вектор символов

Атрибуты:

Classes - Определения классов clibgen.ClassDefinition

Атрибуты:

Enumerations - Определения перечисления clibgen.EnumDefinition

Атрибуты:

Functions - Определения функций, не являющихся членами clibgen.FunctionDefinition

Атрибуты:

HeaderFiles - Имена заголовочных файлов строка | вектор символов

Атрибуты:

SupportingSourceFiles - Имена исходных файлов C++ строка | вектор символов

Атрибуты:

PackageName - имя пакета MATLAB строка | вектор символов

Атрибуты:

DefinedMacros - Определения макросов строка | вектор символов

Атрибуты:

UndefinedMacros - Отмена макросов строка | вектор символов

Атрибуты:

FunctionTypes - Определение типов функций clibgen.FunctionTypeDefinition

Атрибуты:

OpaqueTypes - Определение typedef void* clibgen.OpaqueTypeDefinition

Атрибуты:

Методы

Общедоступные методы

См. также

Документация MATLAB

Поддержка

`dataFile` - Имя XML-файла
строка | вектор символов

`OutputFolder` - Папка для файлов интерфейса
строка | вектор символов

`Libraries` - Имена библиотек
строка | вектор символов

`IncludePath` - Путь для включения папок
строка | вектор символов

`Classes` - Определения классов
`clibgen.ClassDefinition`

`Enumerations` - Определения перечисления
`clibgen.EnumDefinition`

`Functions` - Определения функций, не являющихся членами
`clibgen.FunctionDefinition`

`HeaderFiles` - Имена заголовочных файлов
строка | вектор символов

`SupportingSourceFiles` - Имена исходных файлов C++
строка | вектор символов

`PackageName` - имя пакета MATLAB
строка | вектор символов

`DefinedMacros` - Определения макросов
строка | вектор символов

`UndefinedMacros` - Отмена макросов
строка | вектор символов

`FunctionTypes` - Определение типов функций
`clibgen.FunctionTypeDefinition`

`OpaqueTypes` - Определение `typedef void*`
`clibgen.OpaqueTypeDefinition`