mwArray GetA(const char* name, int num_indices, const int* index) :: C++ Utility Library Reference (MATLAB Compiler)

MATLAB Compiler

mwArray GetA(const char* name, int num_indices, const int* index)

Return single element at the specified field name and 1-based index in struct array. The index is passed as an array of 1-based indices.

C++ syntax

#include "mclcppclass.h"
const char* fields[] = {"a", "b", "c"};
int index[2] = {1, 1};
mwArray a(1, 1, 3, fields);
mwArray b = a.Get("a", 1, index); // b=a.a(1)
mwArray b = a.Get("b", 2, index); // b=a.b(1,1)

Arguments

name. NULL-terminated string containing the field name to get.

num_indices. Number of indices passed in.

index. Array of at least size num_indices containing the indices.

Return value

An mwArray containing the value at the specified field name and index.

Description

Use this method to fetch a single element at a specified field name and index. This method may only be called on an array that is of type mxSTRUCT_CLASS. An mwException is thrown if the underlying array is not a struct array. The field name passed must be a valid field name in the struct array. The index is passed by first passing the number of indices followed by an array of 1-based indices. The valid number of indices that can be passed in is either 1 (single subscript indexing), in which case the element at the specified 1-based offset is returned, accessing data in column-wise order, or NumberOfDimensions() (multiple subscript indexing), in which case, the index list is used to access the specified element. The valid range for indices is 1 <= index <= NumberOfElements(), for single subscript indexing. For multiple subscript indexing, the ith index has the valid range: 1 <= index[i] <= GetDimensions().Get(1, i). An mwException is thrown if an invalid number of indices is passed in or if any index is out of bounds.

mwArray GetA(int num_indices, const int* index) mwArray Real()