exponenta event banner

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

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

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

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

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

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

При создании school в примере «Опубликовать интерфейс в библиотеке 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 package, нажмите кнопку 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 

См. также

| |

Связанные темы