MWStructArray Class

MWStructArray Class

MWStructArray is the managed representation of the MATLAB structure array. Like its MATLAB equivalent, it consists of field values associated with field names.

Inheritance Hierarchy

SystemObject
MathWorks.MATLAB.NET.Arrays.nativeMWArray
MathWorks.MATLAB.NET.Arrays.nativeMWStructArray

Namespace: MathWorks.MATLAB.NET.Arrays.native
Assembly: MWArray (in MWArray.dll) Version: 2.24.1.0 (2.24.1.0)

Syntax

Copy

[SerializableAttribute]
public class MWStructArray : MWArray, 
	ICloneable, IEquatable<MWStructArray>

The MWStructArray type exposes the following members.

Constructors

	Name	Description
	MWStructArray	Creates an empty MATLAB structure array.
	MWStructArray(Object)	Creates a MATLAB structure array from the field name values pairs specified in a MATLAB array.
	MWStructArray(Int32, String)	Creates a MATLAB structure array with the specified dimensions and field names.
	MWStructArray(Int32, Int32, String)	Creates a MATLAB structure array with the specified dimensions and field names.

Top

Methods

	Name	Description
	Clone	Makes a deep copy of an MWStructArray (Overrides MWArrayClone.)
	createAxisWeightArray	(Inherited from MWArray.)
	deepCopy	(Inherited from MWArray.)
	Equals(Object)	Compares two MATLAB structure arrays for equality returning a boolean value. (Overrides MWArrayEquals(Object).)
	Equals(MWStructArray)
	Finalize	(Inherited from Object.)
	get	(Inherited from MWArray.)
	getDimsStr	(Inherited from MWArray.)
	GetField(String)	Returns the contents of the specified field in the structure array.
	GetField(String, Int32)	Returns the contents of the specified field in the specified structure of an array of structures.
	GetHashCode	Returns the hashcode for the MWStructArray (Overrides MWArrayGetHashCode.)
	getOneBasedIndexForArray	(Inherited from MWArray.)
	GetType	(Inherited from Object.)
	initNativeArray	(Inherited from MWArray.)
	IsField	Returns true if the specified field is the name of a field in the structure array.
	MemberwiseClone	(Inherited from Object.)
	RemoveField	Removes the specified field from the structure array.
	resizeFlatArray	(Inherited from MWArray.)
	set(Int32, Object)	(Inherited from MWArray.)
	set(Int32, Object)	(Inherited from MWArray.)
	setDims	(Inherited from MWArray.)
	SetField	Sets the contents of the specified field in the structure array.
	setFlatArr	(Inherited from MWArray.)
	setNumOfElem	(Inherited from MWArray.)
	ToString	Returns a string representing the MATLAB structure array (Overrides MWArrayToString.)

Top

Properties

	Name	Description
	ArrayType	Read only property returning the derived type of the MWArray (Inherited from MWArray.)
	Dimensions	Read only property returning a native integer array containing the size of each dimension of the MWArray. (Inherited from MWArray.)
	Empty	Read only property returning a writeable version of an empty MWStructArray.
	FieldNames	Returns the field names of the MATLAB structure array as a native array of strings.
	IsCellArray	Returns "true" for an MWCellArray. (Inherited from MWArray.)
	IsCharArray	Returns true for an MWCharArray. (Inherited from MWArray.)
	IsEmpty	Returns true if the MWArray is empty. (Inherited from MWArray.)
	IsLogicalArray	Returns true for an MWLogicalArray. (Inherited from MWArray.)
	IsNumericArray	Returns true for an MWNumericArray. (Inherited from MWArray.)
	IsStructArray	Returns true for an MWStructArray. (Inherited from MWArray.)
	ItemString	MATLAB structure array field indexer
	ItemString, Int32	The MATLAB structure array indexer
	NumberofDimensions	Read only property returning the number of dimensions in the MWArray. (Inherited from MWArray.)
	NumberOfElements	Read only property returning the number of elements in the MWArray. (Inherited from MWArray.)
	NumberOfFields	Returns the number of fields in the MATLAB structure array.

Top

Remarks

See STRUCTURE FUNCTIONS in the MATLAB documentation for a full description of this array type.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Reference

MathWorks.MATLAB.NET.Arrays.native Namespace