MathWorks.MATLAB.NET.Arrays.MWStringArray Class

Namespace: MathWorks.MATLAB.NET.Arrays

Managed representation of MATLAB string array

Description

MWStringArray derives from MWArray and is the managed representation of the MATLAB string array. Like its MATLAB equivalent, MWStringArray provides support for string creation and manipulation.

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

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 MWStringArray

MWStringArray

This property is read-only.

Syntax

public static MWStringArray 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.

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.

Methods

Constructors

These methods specialize standard MATLAB operators and functions for objects in this class.

MWStringArray()	Syntax public MWObjectArray() Creates an empty string array Initializes a new instance of the MWStringArray class
MWStringArray(Int32[])	Syntax public MWStringArray( paramsint[] dimensions ) Parameters dimensions Type: System.Int32[] Creates a MATLAB string array with the specified dimensions. If only one dimension is specified, a 1-by-n string array is created. All elements will be uninitialized with the default missing state. An integer array containing the dimensions for the string array.
MWStringArray(String[])	Syntax public MWStringArray( params string[] strings ) Parameters strings Type: System.String[] A native string array Creates a MATLAB string array from a native string array. A 1-by-n MATLAB string array is created where n is the size of the provided native string array. The passed-in array can have null element(s) to left the corresponding MATLAB string element(s) uninitialized. MATLAB string array constructor.
MWStringArray(SerializationInfo, StreamingContext)	Syntax protected MWStringArray( SerializationInfoserializationInfo, StreamingContextcontext ) Parameters serializationInfo 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. The arguments for this constructor are supplied by the .NET serialization infrastructure. Internal deserialization constructor.

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( Object obj ) Compares two MWArray instances for equality. Returns true if both arrays are equal.
Finalize	Inherited from Object
GetHashCode	Syntax publicoverrideintGetHashCode() Returns the hashcode of the MWArray.
GetObjectData	Syntax public virtual void GetObjectData( SerializationInfo info, StreamingContext context ) 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
MemberwiseClone	Inherited from Object
ToArray	Syntax public virtual Array ToArray() Returns all elements of the MATLAB string mxArray in a native c# string[] array. The returned array is populated in column-majored order. If there is a uninitialized element in the MATLAB string mxArray, the corresponding element in the returned array will be null.
ToString	Syntax public virtual Array ToString() Returns a native c# string representing the MATLAB string array.

Specialized Operators and Functions

These methods specialize standard MATLAB operators and functions for objects in this class.

Explicit(MWStringArray to String)	Syntax public static explicit operator string ( MWStringArray scalar ) Parameters scalar Type: MathWorks.MATLAB.Arrays.MWStringArray A scalar MATLAB string array. Return Value Type: String A native c# string representing the scalar MWStringArray object. Explicit cast from a MWStringArray scalar to a native c# string.
Explicit(MWStringArray to String[])	Syntax public static explicit operator string[] ( MWStringArray array ) Parameters array Type: MathWorks.MATLAB.Arrays.MWStringArray A MATLAB string array. Return Value Type: String[] A native c# string array representing the MWStringArray object. Explicit cast from a MWStringArray object to a native c# string array.
Implicit(String to MWStringArray)	Syntax public static implicit operator MWStringArray ( string value ) Parameters value Type: System.String A native string. Return Value Type: MWStringArray A MWStringArray representing the native c# string. Implicit cast from a native c# string to a one-element MATLAB string array.
Implicit(String[] to MWStringArray)	Syntax public static implicit operator MWStringArray ( string value ) Parameters value Type: System.String A native string. Return Value Type: MWStringArray A MWStringArray representing the native c# string array. Implicit cast from a native c# string array to a MATLAB string array

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