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

matlab.project.Project

Объект Project

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

Описание

matlab.project.Project объект представляет в настоящее время загруженный проект. Используйте объект проекта программно управлять проектом, взаимодействовать с системой контроля версий и найти зависимости от файла.

Создание

Создать matlab.project.Project объект, используйте currentProject функция, чтобы получить в настоящее время открытый проект. Например:

proj = currentProject;

Если никакой проект не в настоящее время открыт, используйте openProject функционируйте, чтобы загрузить существующий проект. Например:

proj = openProject("C:/workSpace/project1/");

Чтобы создать и открыть пустой проект и получить объект проекта, используйте matlab.project.createProject функция. Например:

proj = matlab.project.createProject;

Свойства

развернуть все

`Name` — Название проекта
скаляр строки

Название проекта в виде строкового скаляра.

`Description` — Описание проекта
скаляр строки

Описание проекта в виде строкового скаляра.

`RootFolder` — Путь корневой папки проекта
скаляр строки

Путь корневой папки проекта в виде строкового скаляра.

`TopLevel` — Высокоуровневое состояние проекта
логический

Это свойство доступно только для чтения.

Состояние верхнего уровня, возвращенное как логический 1 TRUE) если проект является проектом верхнего уровня.

`ReadOnly` — Состояние разрешения проекта
логический

Это свойство доступно только для чтения.

Состояние разрешения проекта, возвращенное как логический 1 TRUE) если проект ограничил полномочия при использовании, добавляют, удаляют и создают объектные функции. Состояние ссылочного проекта всегда только для чтения, чтобы предотвратить модификацию.

`DefinitionFilesType` — Типы файлов определения проекта
массив `DefinitionFilesType` объекты

Типы файлов определения проекта в виде массива DefinitionFilesType объекты. Использование matlab.project.convertDefinitionFiles изменить текущий тип файла определения проекта программно.

`SourceControlMessages` — Информация о системе контроля версий
массив строк

Это свойство доступно только для чтения.

Информация о системе контроля версий в виде массива строк.

Пример: "Branch status: Normal" "No remote tracking branch" "Current branch: master"

`RepositoryLocation` — Местоположение репозитория проекта
скаляр строки

Это свойство доступно только для чтения.

Местоположение репозитория проекта в виде строкового скаляра.

`SourceControlIntegration` — Тип интеграции системы контроля версий
скаляр строки

Это свойство доступно только для чтения.

Тип интеграции системы контроля версий в виде строкового скаляра.

Пример: "Git"

`Files` — Пути файлов проекта
массив `ProjectFile` объекты

Пути файлов проекта в виде массива ProjectFile объекты. Эти изменения свойства, когда вы добавляете или удаляете файлы проекта. Можно использовать addFile, addFolderIncludingChildFiles, или removeFile добавить или удалить файлы проекта.

`Shortcuts` — Файлы ярлыка
массив `Shortcut` объекты

Файлы ярлыка для проекта в виде массива Shortcut объекты. Эти изменения свойства, когда вы добавляете или удаляете файлы ярлыка. Можно использовать addShortcut и removeShortcut создать или удалить файлы ярлыка программно.

`Categories` — Категории меток
массив `Category` объекты

Категории меток для проекта в виде массива Category объекты. Эти изменения свойства, когда вы создаете или удаляете категории меток. Можно использовать createCategory и removeCategory создать и удалить категории меток программно.

`Dependencies` — График зависимостей между файлами проекта
`digraph` объект

График зависимостей между файлами проекта в виде digraph объект.

`StartupFiles` — Файлы запуска проекта
массив строк

Файлы запуска проекта в виде массива строк. Эти изменения свойства, когда вы добавляете или удаляете файлы запуска. Можно использовать addStartupFile и removeStartupFile добавить или удалить файлы запуска программно.

`ShutdownFiles` — Файлы завершения работы проекта
массив строк

Файлы завершения работы проекта в виде массива строк. Эти изменения свойства, когда вы добавляете или удаляете файлы завершения работы. Можно использовать addShutdownFile и removeShutdownFile добавить или удалить файлы завершения работы программно.

`ProjectPath` — Папки пути к проекту
массив `PathFolder` объекты

Папки пути к проекту, которые добавляются к MATLAB^® путь в виде массива PathFolder объекты.

`ProjectReferences` — Пути ссылок на проекты
массив `ProjectReference` объекты

Пути ссылок на проекты в виде массива ProjectReference объекты. Эти изменения свойства, когда вы добавляете или удаляете ссылочные проекты. Можно использовать addReference и removeReference добавить или удалить ссылочные проекты программно.

`ProjectStartupFolder` — Папка запуска проекта
скаляр строки

Путь проекта запускает папку в виде строкового скаляра.

`SimulinkCacheFolder` — Путь папки кэша Simulink
скаляр строки

Путь Simulink^® папка кэша в виде строкового скаляра.

`SimulinkCodeGenFolder` — Путь папки генерации кода Simulink Coder
скаляр строки

Путь папки генерации кода Simulink Coder™ в виде строкового скаляра.

Функции объекта

развернуть все

Создайте и экспортируйте проекты

`currentProject`	Получите текущий проект
`openProject`	Загрузите существующий проект
`isLoaded`	Определите, загружается ли проект
`reload`	Перезагрузите проект
`close`	Закройте проект
`export`	Экспортируйте проект заархивировать
`matlab.project.createProject`	Создайте пустой проект
`matlab.project.convertDefinitionFiles`	Измените тип файла определения проекта
`matlab.project.deleteProject`	Остановите управление папкой и удалите файлы определения проекта
`matlab.project.loadProject`	Загрузите проект
`matlab.project.rootProject`	Получите корневой проект

Настройте проекты

`addFile`	Добавьте файл или папку к проекту
`addFolderIncludingChildFiles`	Добавьте папку и дочерние файлы к проекту
`removeFile`	Удалите файл из проекта
`addPath`	Добавьте папку, чтобы спроектировать путь
`removePath`	Удалите папку из пути к проекту
`addReference`	Добавьте ссылочный проект в проект
`listAllProjectReferences`	Перечислите все проекты в ссылочной иерархии текущего проекта
`removeReference`	Удалите ссылку проекта
`addStartupFile`	Добавьте файл запуска в проект
`addShutdownFile`	Добавьте файл завершения работы в проект
`removeStartupFile`	Удалите файл запуска из списка запусков проекта
`removeShutdownFile`	Удалите файл завершения работы из списка завершений работы проекта
`addShortcut`	Добавьте ярлык проекту
`removeShortcut`	Удалите ярлык от проекта

Управляйте файлами проекта

`addLabel`	Присоедините метку, чтобы спроектировать файл
`createLabel`	Создайте метку проекта
`removeLabel`	Удалите метку из проекта
`findLabel`	Получите метку файла проекта
`createCategory`	Создайте категорию меток проекта
`findCategory`	Найдите категорию проектов меток
`removeCategory`	Удалите категорию проектов меток
`findFile`	Найдите файл проекта по наименованию
`listModifiedFiles`	Перечислите измененные файлы в проекте
`listRequiredFiles`	Потребуйте файлов заданными файлами проекта
`listImpactedFiles`	Повлияйте на файлы изменениями в заданных файлах проекта
`listAllProjectReferences`	Перечислите все проекты в ссылочной иерархии текущего проекта
`refreshSourceControl`	Обновите состояние системы контроля версий файлов проекта
`runChecks`	Осуществите все проверки проекта
`updateDependencies`	Обновите зависимости от проекта

Примеры

свернуть все

Получите табличный проект приложения времен в качестве примера

Откройте Табличный проект Приложения "Таймс" и использование currentProject чтобы получить проект возражают, что можно управлять программно.

matlab.project.example.timesTable
proj = currentProject

proj = 

  Project with properties:

                        Name: "Times Table App"
    SourceControlIntegration: "Git"
          RepositoryLocation: "C:\workSpace\examples\repositories\TimesTableApp"
       SourceControlMessages: [1×3 string]
                    ReadOnly: 0
                    TopLevel: 1
                Dependencies: [1×1 digraph]
                  Categories: [1×1 matlab.project.Category]
                       Files: [1×15 matlab.project.ProjectFile]
                   Shortcuts: [1×4 matlab.project.Shortcut]
                 ProjectPath: [1×3 matlab.project.PathFolder]
           ProjectReferences: [1×0 matlab.project.ProjectReference]
                StartupFiles: [1×0 string]
               ShutdownFiles: [1×0 string]
         DefinitionFilesType: FixedPathMultiFile
                 Description: "This example project contains the source code and tests for a simple educational app. ↵↵Use the "Project Shortcuts" toolstrip tab to find ways of getting started with this project."
                  RootFolder: "C:\workSpace\examples\TimesTableApp"
       SimulinkCodeGenFolder: ""
        ProjectStartupFolder: "C:\workSpace\examples\TimesTableApp"
         SimulinkCacheFolder: ""

Найдите команды проекта

Откройте Табличный проект Приложения "Таймс" и создайте объект проекта.

matlab.project.example.timesTable
proj = currentProject;

Ищите функции, которые можно выполнить на объекте проекта.

methods(proj)

Methods for class matlab.project.Project:

addFile                       export                        removeCategory                
addFolderIncludingChildFiles  findCategory                  removeFile                    
addPath                       findFile                      removePath                    
addReference                  isLoaded                      removeReference               
addShortcut                   listAllProjectReferences      removeShortcut                
addShutdownFile               listImpactedFiles             removeShutdownFile            
addStartupFile                listModifiedFiles             removeStartupFile             
addprop                       listRequiredFiles             runChecks                     
close                         refreshSourceControl          updateDependencies            
createCategory                reload                        

Methods of matlab.project.Project inherited from handle.

Исследуйте свойства проекта

Получите объект проекта и исследуйте его свойства.

Откройте Табличный проект Приложения "Таймс". Использование currentProject чтобы создать проект возражают из в настоящее время загруженного проекта.

matlab.project.example.timesTable
proj = currentProject;

Исследуйте файлы проекта.

files = proj.Files

files = 

  1×14 ProjectFile array with properties:

    Path
    Labels
    Revision
    SourceControlStatus

Исследуйте метки 13-го файла.

proj.Files(13).Labels

ans = 

  Label with properties:

            File: "C:\workSpace\examples\TimesTableApp\utilities\runTheseTests.m"
        DataType: 'none'
            Data: []
            Name: "Design"
    CategoryName: "Classification"

Получите конкретный файл по наименованию.

myfile = findFile(proj,"source/timesTableGame.m")

myfile = 

  ProjectFile with properties:

                   Path: "C:\workSpace\examples\TimesTableApp\source\timesTableGame.m"
                 Labels: [1×1 matlab.project.Label]
               Revision: ""
    SourceControlStatus: Unmodified

Узнайте то, что можно сделать с файлом.

methods(myfile)

Methods for class matlab.project.ProjectFile:

addLabel     findLabel    removeLabel

Смотрите также

currentProject | openProject

Темы

Создайте и отредактируйте проекты программно

Введенный в R2019a

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

Поддержка

Для просмотра документации необходимо авторизоваться на сайте