Initializing help system before first use

XPRMArray Properties

The XPRMArray type exposes the following members.

Properties
  Name Description
Public property Dim
Array dimensions; number indices required to access an array cell
Public property FirstIndex
Index of the first cell of the array.
Public property FirstTEIndex
Index of the first defined cell of the array. Dynamic arrays do not necessarily have a defined cell for each index.
Public property IndexSets
Sets indexing the array. When indices are given to the array in other functions, we use indexes into the index sets - ie if there are two index sets {2,3,4} and {"a", "b", "c"), then the array position [2,"c"] will be passed to Get(Int32) as an array of two integers: [1,3], because "2" is the first element of the first index set, and "c" is the third element of the second index set.
Public property Indices
A list containing all the index positions in the array - each index position is given as an int[].
Public property IsDynamic
Check whether the array is dynamic.
Public property IsEmpty
Check whether the array is empty.
Public property IsInitialised
Check whether the array has been initialised. Objects are initialised during model execution. Trying to access a Mosel object that has not been created will result on an exception.
(Overrides XPRMValueIsInitialised.)
Public property LastIndex
Index of the last cell of the array.
Public property Model
Used to fetch the XPRM model to which this object belongs, or else 'null' if there is no model anywhere among this Object's ancestors.
(Inherited from XPRMObjectBase.)
Public property Owner
Used to fetch the XPRM object to which this object belongs
(Inherited from XPRMObjectBase.)
Public property Size
The total number of elements in the array
Public property StructCode (Inherited from XPRMTypedObject.)
Public property StructName (Inherited from XPRMTypedObject.)
Public property TEIndices
A list containing the index positions of all the defined cells in the array - each index position is given as an int[].
Public property Type (Inherited from XPRMTypedObject.)
Public property TypeCode (Inherited from XPRMTypedObject.)
Public property TypeName (Inherited from XPRMTypedObject.)
Top
See Also