findLabel

Получите метку файла проекта

Синтаксис

label = findLabel(file,categoryName,labelName)
label = findLabel(file,labelDefinition)
label = findLabel(category,labelName)

Описание

пример

label = findLabel(file,categoryName,labelName) получает заданную метку, в заданной категории, из заданного файла. Это возвращает определение метки и его присоединенные данные. Используйте этот синтаксис, когда вы будете знать имя метки и категорию. Если метка не найдена, findLabel возвращает пустой массив.

пример

label = findLabel(file,labelDefinition)задали метку заданным объектом определения метки. Используйте этот синтаксис, если вы ранее получили labelDefinition путем доступа к свойству Labels, например, при помощи выражения как myfile.Labels(1).

пример

label = findLabel(category,labelName) получает метку с помощью объекта категории, а не имени файла и названия категории. Используйте этот синтаксис, если вам получили объект категории от свойства proj.Categories или при помощи функции findCategory.

Примеры

свернуть все

Найдите все файлы проекта с меткой "Utility"

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

matlab.project.example.timesTable
proj = currentProject;

Получите список файлов проекта.

files = proj.Files;

Цикл через файлы. Получите расширение каждого файла путем взятия последнего элемента, возвращенного функцией fileparts. Если файл имеет дополнительный .m, присоедините метку "Utility".

for fileIndex = 1:numel(files)
   file = files(fileIndex);
   [~,~,fileExtension] = fileparts(file.Path);
   if strcmp(fileExtension,".m")
      addLabel(file,"Classification","Utility");
   end
end

Используйте функцию findLabel, чтобы найти все файлы с меткой "Utility" и добавить их в массив utilityFilesToReview.

utilityFilesToReview = {};
for jj=1:numel(files)
   thisFile = files(jj);   
   label = findLabel(thisFile,"Classification","Utility");
   if (~isempty(label))
      % This is a file labeled "Utility". Add to the 
      % list of utility files.
      utilityFilesToReview = [utilityFilesToReview; thisFile];
   end
end

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

matlab.project.example.timesTable
proj = currentProject;

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

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

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

label = findLabel(myfile,"Classification","Design");
label = 

  Label with properties:

            File: "C:\myProjects\examples\TimesTableApp\source\timesTableGame.m"
        DataType: 'none'
            Data: []
            Name: "Design"
    CategoryName: "Classification"

Исследуйте свойство Labels файла получить массив объектов Label, один для каждой метки, присоединенной к файлу. Индексируйте в свойство Labels присоединить определение метки к конкретному файлу.

labels = myfile.Labels
labeldefinition = myfile.Labels(1)

Получите метку из определения метки.

label = findLabel(myfile,labeldefinition);

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

matlab.project.example.timesTable
proj = currentProject;

Получите категорию.

category = proj.Categories(1)
category = 

  Category with properties:

                Name: "Classification"
        SingleValued: 1
            DataType: "none"
    LabelDefinitions: [1×7 matlab.project.LabelDefinition]

Получите определение метки от той категории.

ld = findLabel(category,"Design")
ld = 

  LabelDefinition with properties:

            Name: "Design"
    CategoryName: "Classification"

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

свернуть все

Файл, чтобы искать в, заданный как объект ProjectFile или массив объектов файла. Можно получить объект файла путем исследования свойства Files проекта (использующий синтаксис proj.Files) или использовать findFile, чтобы получить файл по наименованию. Файл должен быть в заданном проекте.

Имя категории для метки, заданной как вектор символов или скаляр строки.

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

Маркируйте определение, заданное как объект LabelDefinition полученным от свойства file.Label.

Объект Category. Получите объект категории от свойства proj.Categories или при помощи функции findCategory.

Выходные аргументы

свернуть все

Маркируйте, возвращенный как объект Label.

Введенный в R2019a

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