UA Bundle SDK .NET  2.2.1.258
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events Groups Pages
UnifiedAutomation.UaBase.Matrix Class Reference

Wraps a multi-dimensional array for use within a Variant. More...

Inherits IFormattable, and ICloneable.

Public Member Functions

 Matrix (Array value, BuiltInType builtInType)
 Initializes the matrix with a multidimensional array. More...
 
 Matrix (Array elements, BuiltInType builtInType, params int[] dimensions)
 Initializes the matrix with a one dimensional array and a list of dimensions. More...
 
Array ToArray ()
 Returns the flattened array as a multi-dimensional array. More...
 
string ToString (string format, IFormatProvider formatProvider)
 Returns the string representation of the object. More...
 
object Clone ()
 Makes a deep copy of the object. More...
 

Static Public Member Functions

static Array FlattenArray (Array array)
 Converts a multidimension array to a flat array. More...
 

Properties

Array Elements [get]
 The elements of the matrix. More...
 
int[] Dimensions [get]
 The dimensions of the matrix. More...
 
TypeInfo TypeInfo [get]
 The type information for the matrix. More...
 

Detailed Description

Wraps a multi-dimensional array for use within a Variant.

Constructor & Destructor Documentation

UnifiedAutomation.UaBase.Matrix.Matrix ( Array  value,
BuiltInType  builtInType 
)
inline

Initializes the matrix with a multidimensional array.

UnifiedAutomation.UaBase.Matrix.Matrix ( Array  elements,
BuiltInType  builtInType,
params int[]  dimensions 
)
inline

Initializes the matrix with a one dimensional array and a list of dimensions.

Member Function Documentation

object UnifiedAutomation.UaBase.Matrix.Clone ( )
inline

Makes a deep copy of the object.

Returns
A new object that is a copy of this instance.
static Array UnifiedAutomation.UaBase.Matrix.FlattenArray ( Array  array)
inlinestatic

Converts a multidimension array to a flat array.

The higher rank dimensions are written first. e.g. a array with dimensions [2,2,2] is written in this order: [0,0,0], [0,0,1], [0,1,0], [0,1,1], [1,0,0], [1,0,1], [1,1,0], [1,1,1]

Array UnifiedAutomation.UaBase.Matrix.ToArray ( )
inline

Returns the flattened array as a multi-dimensional array.

string UnifiedAutomation.UaBase.Matrix.ToString ( string  format,
IFormatProvider  formatProvider 
)
inline

Returns the string representation of the object.

Parameters
format(Unused) Always pass a NULL value
formatProviderThe format-provider to use. If unsure, pass an empty string or null
Returns
A T:System.String containing the value of the current instance in the specified format.

Returns the string representation of the object.

Exceptions
FormatExceptionThrown when the 'format' argument is NOT null.

Property Documentation

int [] UnifiedAutomation.UaBase.Matrix.Dimensions
get

The dimensions of the matrix.

The dimensions of the array.

Array UnifiedAutomation.UaBase.Matrix.Elements
get

The elements of the matrix.

An array of elements.

TypeInfo UnifiedAutomation.UaBase.Matrix.TypeInfo
get

The type information for the matrix.

The type information.


The documentation for this class was generated from the following file: