MathWorks.MATLAB.NET.Arrays.MWStructArray Class

Namespace: MathWorks.MATLAB.NET.Arrays

Managed representation of MATLAB structure array

Description

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

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.

Properties

expand all

Public Properties

`ArrayType` — Derived type of `MWArray`
`MWArrayType`

This property is read-only.

Syntax

public MWArrayType ArrayType { get; }

The derived type of the array, specified as an MWArrayType object.

`Dimensions` — Return native integer array containing size of each dimension of `MWArray`
positive integer

This property is read-only.

Syntax

public virtual int[] Dimensions { get; }

See size.

`Empty` — Return writeable version of empty `MWStructrray`
`MWStructArray`

This property is read-only.

Syntax

public static MWStructArray Empty { get; }

`IsCellArray` — Flag indicating if `MWArray` is `MWCellArray`
`boolean`

This property is read-only.

Syntax

public bool IsCellArray { get; }

See iscell.

`IsCharArray` — Flag indicating if `MWArray` is `MWCharArray`
`boolean`

This property is read-only.

Syntax

public bool IsCharArray { get; }

See ischar.

`IsDisposed` — Handle status of encapsulated `MWArray`
`boolean`

This property is read-only.

Syntax

public virtual bool IsDisposed { get; }

`IsEmpty` — Flag indicating if `MWArray` is empty
`boolean`

This property is read-only.

Syntax

public virtual bool IsEmpty { get; }

See isempty.

`IsLogicalArray` — Flag indicating if `MWArray` is `MWLogicalArray`
`boolean`

This property is read-only.

Syntax

public bool IsLogicalArray { get; }

See islogical.

`IsNumericArray` — Flag indicating if `MWArray` is `MWNumericArray`
`boolean`

This property is read-only.

Syntax

public bool IsNumericArray { get; }

See isnumeric.

`IsStringArray` — Flag indicating if `MWArray` is `MWStringArray`
`boolean`

This property is read-only.

Syntax

public bool IsStringArray { get; }

See isstring.

`IsStructArray` — Flag indicating if `MWArray` is `MWStructArray`
`boolean`

This property is read-only.

Syntax

public bool IsStructArray { get; }

See isstruct.

`Item` — Generic MATLAB indexer returning result as `MWArray`
`MWArray`

Syntax

public MWArray this[
	params int[] indices
] { get; set; }

An index can be any number of integers corresponding to the array's dimensions. As with MATLAB, a single index will return the nth element in the array. NOTE: The generic array indexer supports numeric, logical, char, and cell array types. For complex numeric arrays, both the real and the imaginary components are returned.

Array indexing in this API, as in MATLAB^®, is one-based rather than zero-based.

`NativeGCBlockSize` — Unmanaged memory block size in bytes
positive integer

This property is read-only.

Syntax

public static long NativeGCBlockSize { get; }

`NativeGCEnabled` — Native array GC enabled flag
`boolean`

Syntax

public static bool NativeGCEnabled { get; set; }

If the native array GC is enabled, a CLR garbage collection will take place transparently as required to remove instances of the MWArray class or one of its derived types that are no longer being referenced. This includes unmanaged memory allocated through explicit creation of MWArray types, as well as implicit instantiation of an MWArray via an implicit cast.

`NumberOfDimensions` — Number of dimensions in `MWArray`
positive integer

This property is read-only.

Syntax

public int NumberofDimensions { get; }

See ndims.

`NumberOfElements` — Number of elements in `MWArray`
positive integer

This property is read-only.

Syntax

public int NumberOfElements { get; }

Equivalent to prod(size(A)) for non-empty arrays. See numel.

`NumberOfFields` — Number of fields in `MWArray`
positive integer

This property is read-only.

Syntax

public int NumberOfFields { get; }

Methods

expand all

Public Methods

`Clone`	Syntax public virtual Object Clone() Makes a deep copy of an `MWArray`. See the "=" operator in the MATLAB documentation.
`Dispose()`	Syntax public void Dispose() Releases resources of the `MWArray` and the native `mxArray` that it encapsulates. This method allows for the explicit lifecycle control of an `MWArray` and its native MATLAB array.
`Dispose(Boolean)`	Syntax protected override void Dispose( bool disposing ) Parameters disposing Type: System.Boolean Client explicit dispose flag Internal dispose function
`DisposeArray`	Syntax public static void DisposeArray( Object_object ) This dispose method recursively frees the resources of the `MWArray` instances contained in the Object argument. If the object implements the `IDisposable` interface, it is freed by calling its Dispose method. If the object represents an array of objects that implement the `IDisposable` interface, each object in the array is freed via the dispose method. Finally, if the object represents a multi-dimensional array, the array is recursively processed to free each object contained in the array.
`Equals`	Syntax public override bool Equals( Objectobj ) Compares two `MWArray` instances for equality. Returns true if both arrays are equal.
`Finalize`	Inherited from `Object`
`GetField(String)`	Syntax public MWArray GetField( string fieldName ) Parameters fieldName Type: System.String The field name. Return Value Type: MWArray The contents of the specified field. Returns the contents of the specified field in the structure array.
`GetField(String, Int32)`	Syntax public MWArray GetField( string fieldName, int index ) Parameters fieldName Type: System.String The field name. index Type: System.Int32 The index for an array of structures. Return Value Type: MWArray The contents of the specified field. Returns the contents of the specified field in the specified structure of an array of structures.
`GetHashCode`	Syntax public override int GetHashCode() Returns the hashcode of the `MWStructArray` (Overrides `MWArray.GetHashCode()`.)
`GetObjectData`	Syntax public virtual void GetObjectData( SerializationInfoinfo, StreamingContextcontext ) Parameters info Type: System.Runtime.Serialization.SerializationInfo Holds the data needed to serialize or deserialize the object. context Type: System.Runtime.Serialization.StreamingContext Describes the source and destination of the serialized stream. Implements ISerializable.GetObjectData(SerializationInfo, StreamingContext) Serialization function. The arguments for this function are supplied by the .NET serialization infrastructure.
`GetType`	Inherited from `Object`
`IsField`	Syntax public virtual Array ToArray() Parameters fieldName Type: System.String The field name. Return Value Type: Boolean true if the field name is the name of a field in the structure array. Returns true if the specified field is the name of a field in the structure array.
`MemberwiseClone`	Inherited from `Object`
`RemoveField`	Syntax public MWStructArray RemoveField( string fieldName ) Parameters fieldName Type: System.String The field name. Return Value Type: MWArray The new structure array. Removes the specified field from the structure array.
`SetField`	Syntax public void SetField( stringfieldName, MWArrayfieldValue ) Parameters fieldName Type: System.String The field name. fieldValue Type: Mathworks.MATLAB.NET.Arrays.MWArray The field value. Sets the contents of the specified field in the structure array.
`ToArray`	Syntax public virtual Array ToArray() Returns a native .NET array containing a copy of data in the underlying MATLAB array. The returned array has the same dimensionality as the underlying MATLAB array. The elements of the returned array are converted according to default conversion rules. If the underlying MATLAB array is a complex numeric type, `toArray` throws an exception. If the underlying array is sparse, a full representation of the array is returned. Care should be taken when calling `toArray` on a sparse array with large row and column dimensions, as this action may exhaust system memory. If the underlying array is a cell or struct array, `toArray` is recursively called on each cell.
`ToString`	Syntax public virtual Array ToArray() Returns a formatted string representing the contents of the `MWArray`

Specialized Operators and Functions

`Implicit(Double to MWArray)`	Implicit cast from native double scalar value to `MWNumericArray`
`Implicit(String to MWArray)`	Implicit cast from native character string to `MWCharArray`

Inheritance Hierarchy

System.Object

Mathworks.MATLAB.NET.Arrays.MWArray
- Mathworks.MATLAB.NET.Arrays.MWCellArray
- Mathworks.MATLAB.NET.Arrays.MWCharArray
- Mathworks.MATLAB.NET.Arrays.MWIndexArray
- Mathworks.MATLAB.NET.Arrays.MWObjectArray
- Mathworks.MATLAB.NET.Arrays.MWStringArray
- Mathworks.MATLAB.NET.Arrays.MWStructArray

Version History

Introduced in R2006a

MathWorks.MATLAB.NET.Arrays.MWStructArray Class

Description

Properties

Public Properties

ArrayType — Derived type of MWArray MWArrayType

Dimensions — Return native integer array containing size of each dimension of MWArray positive integer

Empty — Return writeable version of empty MWStructrray MWStructArray

IsCellArray — Flag indicating if MWArray is MWCellArray boolean

IsCharArray — Flag indicating if MWArray is MWCharArray boolean

IsDisposed — Handle status of encapsulated MWArray boolean

IsEmpty — Flag indicating if MWArray is empty boolean

IsLogicalArray — Flag indicating if MWArray is MWLogicalArray boolean

IsNumericArray — Flag indicating if MWArray is MWNumericArray boolean

IsStringArray — Flag indicating if MWArray is MWStringArray boolean

IsStructArray — Flag indicating if MWArray is MWStructArray boolean

Item — Generic MATLAB indexer returning result as MWArray MWArray

NativeGCBlockSize — Unmanaged memory block size in bytes positive integer

NativeGCEnabled — Native array GC enabled flag boolean

NumberOfDimensions — Number of dimensions in MWArray positive integer

NumberOfElements — Number of elements in MWArray positive integer

NumberOfFields — Number of fields in MWArray positive integer

Methods

Public Methods

Specialized Operators and Functions

Inheritance Hierarchy

Version History

`ArrayType` — Derived type of `MWArray`
`MWArrayType`

`Dimensions` — Return native integer array containing size of each dimension of `MWArray`
positive integer

`Empty` — Return writeable version of empty `MWStructrray`
`MWStructArray`

`IsCellArray` — Flag indicating if `MWArray` is `MWCellArray`
`boolean`

`IsCharArray` — Flag indicating if `MWArray` is `MWCharArray`
`boolean`

`IsDisposed` — Handle status of encapsulated `MWArray`
`boolean`

`IsEmpty` — Flag indicating if `MWArray` is empty
`boolean`

`IsLogicalArray` — Flag indicating if `MWArray` is `MWLogicalArray`
`boolean`

`IsNumericArray` — Flag indicating if `MWArray` is `MWNumericArray`
`boolean`

`IsStringArray` — Flag indicating if `MWArray` is `MWStringArray`
`boolean`

`IsStructArray` — Flag indicating if `MWArray` is `MWStructArray`
`boolean`

`Item` — Generic MATLAB indexer returning result as `MWArray`
`MWArray`

`NativeGCBlockSize` — Unmanaged memory block size in bytes
positive integer

`NativeGCEnabled` — Native array GC enabled flag
`boolean`

`NumberOfDimensions` — Number of dimensions in `MWArray`
positive integer

`NumberOfElements` — Number of elements in `MWArray`
positive integer

`NumberOfFields` — Number of fields in `MWArray`
positive integer