exponenta event banner

getfield

Поле массива структуры

Описание

пример

value = getfield(S,field) возвращает значение в указанном поле структуры S. Например, если S.a = 1, то getfield(S,'a') прибыль 1.

В качестве альтернативы getfield, использовать точечную нотацию, value = S.field. Точечная нотация обычно более эффективна.

Если S является нескалярным, то getfield возвращает значение в первом элементе массива, эквивалентное S(1).field.

пример

value = getfield(S,field1,...,fieldN) возвращает значение, сохраненное во вложенной структуре. Например, если S.a.b.c = 1, то getfield(S,'a','b','c') прибыль 1.

пример

value = getfield(S,idx,field1,...,fieldN) задает элемент массива структуры. Например, если S(3,4).a = 1, то getfield(S,{3,4},'a') прибыль 1.

пример

value = getfield(S,idx,field1,idx1,...,fieldN,idxN) задает элементы полей. Например, если S.a(2) = 1, то getfield(S,'a',{2}) прибыль 1. Аналогично, если S(3,4).a(2).b = 1, то getfield(S,{3,4},'a',{2},'b') прибыль 1.

Примеры

свернуть все

Получение значения поля из структуры, возвращаемой what функция. what возвращает скалярную структуру с полями, содержащими путь к указанной папке и имена различных типов файлов в папке.

S = what('C:\Temp')
S = struct with fields:
        path: 'C:\Temp'
           m: {'testFunc1.m'}
       mlapp: {0×1 cell}
         mlx: {'testFunc2.mlx'}
         mat: {2×1 cell}
         mex: {0×1 cell}
         mdl: {0×1 cell}
         slx: {0×1 cell}
           p: {0×1 cell}
     classes: {0×1 cell}
    packages: {0×1 cell}

Возврат имен всех сценариев Live Scripts, перечисленных в mlx поле. При использовании getfield можно получить доступ к полю структуры, возвращаемому функцией, без использования временной переменной для хранения этой структуры.

value = getfield(what('C:\Temp'),'mlx')
value = 1×1 cell array
    {'testFunc2.mlx'}

Также можно получить доступ к полю с помощью точечной нотации.

value = S.mlx
value = 1×1 cell array
    {'testFunc2.mlx'}

Доступ к полю вложенной структуры. Во вложенной структуре структура на любом уровне может иметь поля, которые являются структурами, и другие поля, которые не являются структурами.

Сначала создайте вложенную структуру.

S.a.b.c = 1;
S.a.b.d = 'two';
S.a.b.e = struct('f',[3 4],'g','five');
S.h = 50
S = struct with fields:
    a: [1x1 struct]
    h: 50

В то время как S - структура, поля S.a, S.a.b, и S.a.b.e являются также структурами.

S.a
ans = struct with fields:
    b: [1x1 struct]

S.a.b
ans = struct with fields:
    c: 1
    d: 'two'
    e: [1x1 struct]

S.a.b.e
ans = struct with fields:
    f: [3 4]
    g: 'five'

Возвращает значение S.a.b.d с использованием getfield функция. При указании разделенного запятыми списка имен вложенных структур необходимо включать структуры на каждом уровне между структурой вверху и указанным именем поля. В этом случае список имен структур, разделенных запятыми, равен 'a','b' и имя поля: 'd'.

value = getfield(S,'a','b','d')
value = 
'two'

Для доступа к тому же полю можно также использовать точечную нотацию.

value = S.a.b.d
value = 
'two'

Получение значения поля из элемента массива структуры, возвращаемого dir функция. dir возвращает массив структуры, каждый элемент которого содержит информацию о файле в указанной папке.

Возврат информации о файлах в папке C:\Temp. В папке 5 файлов.

S = dir('C:\Temp')
S = 5×1 struct array with fields:
    name
    folder
    date
    bytes
    isdir
    datenum

Для отображения информации о 5-м файле выполните индексирование в S.

S(5)
ans = struct with fields:
       name: 'testFunc2.mlx'
     folder: 'C:\Temp'
       date: '19-Jul-2018 09:43:53'
      bytes: 2385
      isdir: 0
    datenum: 7.3726e+05

Возвращает имя файла, описанного 5-м элементом S с использованием getfield функция. При использовании getfield, укажите индексы в массиве ячеек.

value = getfield(S,{5},'name')
value = 
'testFunc2.mlx'

В качестве альтернативы, проиндексировать в структурный массив, а затем использовать точечную нотацию для указания поля.

value = S(5).name
value = 
'testFunc2.mlx'

Доступ к полю вложенной структуры, в котором структуры на некоторых уровнях представляют собой массивы структур. В этом примере: S является массивом структуры «1 на 2». Второй элемент, S(2), имеет вложенную структуру a.b, где b является массивом структуры «1 на 3».

Сначала создайте вложенную структуру. После создания структуры с помощью точечной нотации создайте другой нескалярный структурный массив с помощью struct и добавьте его в качестве поля.

S.a = 1;
S(2).a.b = struct('d',{5,10,20});
S
S=1×2 struct array with fields:
    a

S(2).a.b
ans=1×3 struct array with fields:
    d

Возвращает значение d от третьего элемента b с использованием getfield функция. Необходимо указать индексы обоих S и b использование массивов ячеек.

value = getfield(S,{2},'a','b',{3},'d')
value = 20

Для доступа к тому же полю можно также использовать точечную нотацию.

value = S(2).a.b(3).d
value = 20

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

S.a = [5 10 15 20 25]
S = struct with fields:
    a: [5 10 15 20 25]

Возвращает элементы массива с помощью getfield функция. Чтобы вернуть подмассив, укажите индексы после имени поля. Необходимо указать индексы в массиве ячеек.

value = getfield(S,'a',{[2:4]})
value = 1×3

    10    15    20

Для доступа к тем же элементам можно также использовать точечную нотацию и индексацию массива.

value = S.a(2:4)
value = 1×3

    10    15    20

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

свернуть все

Структурный массив. Если S является нескалярным, то каждый элемент S является структурой, и все элементы имеют одинаковые поля с одинаковыми именами.

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

Индексы, заданные как массив ячеек с числовыми или логическими значениями. Индексы для S и поля с 1 по N-1 определяют элементы массивов структур. Индексы для поля N определяют элементы массива в этом поле, которые могут быть любого типа.

Пример: getfield(S,{1,2},'a') эквивалентно S(1,2).a.

Пример: Если S.a = [5 10 20], то getfield(S,'a',{[2,3]}) прибыль [10 20].

Представлен до R2006a