MathWorks.MATLAB.NET.Arrays.native.MWStructArray Class

Namespace: MathWorks.MATLAB.NET.Arrays.native

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.

Namespace: MathWorks.MATLAB.NET.Arrays.native

Assembly: MWArray (in MWArray.dll) Version: 2.23.1.0 (2.23.1.0)

Syntax:

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

Properties

Public Properties

ArrayType — Derived type of MWArray

Read-only: MWArrayType

This property is read-only.

Syntax

public MWArrayType ArrayType { get; }

Read only property returning the derived type of the MWArray (Inherited from MWArray.)

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

Read-only: positive integer

This property is read-only.

Syntax

public virtual int[] Dimensions { get; }

Read only property returning a native integer array containing the size of each dimension of the MWArray.(Inherited from MWArray.)

See size.

Empty — Return writeable version of empty MWCellArray

Read-only: positive integer

This property is read-only.

Syntax

public virtual int[] Dimensions { get; }

Read only property returning a native integer array containing the size of each dimension of the MWArray.(Inherited from MWArray.)

See size.

FieldNames — Return field names of MATLAB structure array as native array of strings

Read-only: boolean

This property is read-only.

Syntax

publicstring[] FieldNames { get; }

Returns the field names of the MATLAB structure array as a native array of strings.

IsCellArray — Flag indicating if MWArray is MWCellArray

Read-only: boolean

This property is read-only.

Syntax

public bool IsCellArray { get; }

See iscell.

IsCharArray — Flag indicating if MWArray is MWCharArray

Read-only: boolean

This property is read-only.

Syntax

public bool IsCharArray { get; }

See ischar.

IsEmpty — Flag indicating if MWArray is empty

Read-only: boolean

This property is read-only.

Syntax

public virtual bool IsEmpty { get; }

See isempty.

IsLogicalArray — Flag indicating if MWArray is MWLogicalArray

Read-only: boolean

This property is read-only.

Syntax

public bool IsLogicalArray { get; }

See islogical.

IsNumericArray — Flag indicating if MWArray is MWNumericArray

Read-only: boolean

This property is read-only.

Syntax

public bool IsNumericArray { get; }

See isnumeric.

IsStructArray — Flag indicating if MWArray is MWStructArray

Read-only: 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.

NumberOfDimensions — Number of dimensions in MWArray

Read-only: positive integer

This property is read-only.

Syntax

public int NumberofDimensions { get; }

See ndims.

NumberOfElements — Number of elements in MWArray

Read-only: positive integer

This property is read-only.

Syntax

public int NumberOfElements { get; protected get}

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

NumberOfFields — Number of fields in MATLAB structure array

Read-only: positive integer

This property is read-only.

Syntax

public int NumberOfElements { get; protected get}

Returns the number of fields in the MATLAB structure array.

Methods

Public Methods

Clone	Syntax public virtual Object Clone() Makes a deep copy of an MWArray See the "=" operator in the MATLAB documentation.
createAxisWeightArray	Syntax protected void createAxisWeightArray()
deepCopy	Syntax protected void deepCopy( MWArraytarget ) Parameters target Type: MathWorks.MATLAB.NET.Arrays.native.MWArray
Equals	Syntax public override bool Equals( Objectobj ) Compares two MWArray instances for equality. Parameters obj Type: System.Object An MWArray referenced as an Object type. Return Value Type: Boolean true if the arrays are equal.
Finalize	(Inherited from Object)
get	Syntax protected Object get( int[] index ) Parameters index Type:System.Int32[] Return Value Type: Object
getDimsStr	Inherited from Object
GetField(String)	Syntax publicObjectGetField( stringfieldName ) Parameters fieldName Type: System.String The field name. Return Value Type: Object The contents of the specified field. Returns the contents of the specified field in the structure array.
GetField(String, Int32)	Syntax public Object GetField( stringfieldName, intindex ) Parameters fieldName Type: System.String The field name. index Type: System.Int32 The index for an array of structures. Return Value Type: Object 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() Return Value Type: Int32 The hashcode for the MWArray.
getOneBasedIndexForArray	Syntax protected int getOneBasedIndexForArray( int[] index ) Parameters index Type: System.Int32[] Return Value Type: Int32
GetType	Inherited from Object
initNativeArray	Syntax protected void initNativeArray( intnum ) Parameters num Type: System.Int32
IsField	Syntax public bool IsField( stringfieldName ) Parameters fieldName Type: System.String The field name. Return Value Type: Boolean 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( stringfName ) Parameters fName Type: System.String Return Value Type: MWStructArray The new Structure Array.
resizeFlatArray	Syntax protected void resizeFlatArray( intnewSize ) Parameters newSize Type: System.Int32
set(Int32,Object)	Syntax protected void set( intindex, Objectval ) Parameters index Type: System.Int32 val Type: System.Object
set(Int32[],Object)	Syntax protected void set( int[] index, Objectval ) Parameters index Type:System.Int32[] val Type: System.Object
setDims	Syntax protected void setDims( int[] inDims ) Parameters inDims Type:System.Int32[]
setField	Syntax public void SetField( stringfieldName, ObjectfieldValue ) Parameters fieldName Type: System.String The name of the field. fieldValue Type: System.Object The field value.
setFlatArr	Syntax protected void setFlatArr( Object[] newArr ) Parameters newArr Type:System.Object[]
setNumOfElem	Syntax protected void setFlatArr( Object[] newArr ) Parameters inDims Type:System.Int32[]
ToString	Syntax public override string ToString() Return Value Type: String The formatted MWArray string Returns a formatted string representing the contents of the MWArray(Overrides Object.ToString().)

Constructors

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.

Inheritance Hierarchy

System.Object

• Mathworks.MATLAB.NET.Arrays.native.MWArray

  • Mathworks.MATLAB.NET.Arrays.native.MWCellArray

  • Mathworks.MATLAB.NET.Arrays.native.MWStructArray

Version History

Introduced in R2006a