Exponenta Banner

Отображение справки по интерфейсу MATLAB к библиотеке C++

Используйте эти MATLAB® функции для просмотра информации о представителях интерфейса:

  • doc и help - Просмотр классов и функций в пакете. При публикации интерфейса можно добавить описательный текст. Для получения дополнительной информации см. раздел «Публикация текста справки для интерфейса MATLAB в библиотеке C++».

  • methods - Просмотрите имена конструкторов, методов и пакетов функций для класса.

  • methods с '-full' опция - Просмотр сигнатур конструктора, метода и функции пакета.

  • methodsview - Табличное представление сигнатур метода. Вы можете найти methodsview окно легче использовать в качестве руководства по ссылке, потому что вам не нужно прокручивать Командное окно, чтобы найти информацию.

Если вы создали school интерфейс в примере Публикация интерфейса в библиотеке Header-Only C++, затем его можно использовать в этом примере. С schoolInterface.dll файл в текущей папке, введите:

addpath('.')

Отображение классов и функций пакета.

doc clib.school.

затем нажмите Tab. Эта команда загружает пакет. MATLAB отображает список представителей. Чтобы просмотреть пакет, нажмите клавишу Backspace, чтобы удалить период, а затем нажмите Enter. MATLAB отображает:

Classes contained in clib.school:
Person            - clib.school.Person    Representation of C++ class Person
Teacher           - clib.school.Teacher    Representation of C++ class Teacher
Student           - clib.school.Student    Representation of C++ class Student

Functions contained in clib.school:
getName           - clib.school.getName    Representation of C++ function getName

Отображение входных и выходных параметров для getName упаковать функцию, кликнуть getName ссылка.

clib.school.getName    Representation of C++ function getName
  inputs
    p              clib.school.Person
  outputs
    RetVal         string

Чтобы отобразить методы класса, вызовите methods функция для каждого класса. Для примера введите:

methods clib.school.Person
Methods for class clib.school.Person:

Person   eq       ge       getAge   getName  gt       le       lt       ne       setAge   setName  

Methods of clib.school.Person inherited from handle.

Чтобы отобразить сигнатуры функции, вызовите methodsview функция для каждого класса. Для примера введите:

methodsview clib.school.Person

Функция открывает окно, в котором отображаются методы и информация об аргументах и возвращенных значениях. Для примера сигнатуры для конструкторов:

ИмяТип возвратаАргументы
Personclib.school.Person obj(clib.school.Person input1)
Personclib.school.Person obj(name, uint64 scalar age)
Personclib.school.Person obj 

См. также

| |

Похожие темы

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

Поддержка