FixedTimeArrayInDS struct
Estimated reading time: 5 minutes
Describes a fixed size array of FixedTime contained in a DataStructure.
Namespace: ASNA.QSys.Runtime Assembly: ASNA.QSys.Runtime.dll
Constructors
Name | Description |
---|---|
FixedTimeArrayInDS(DataStructure, Int32, Int32) | Constructs a fixed size array of FixedTime in a Data Structure. |
FixedTimeArrayInDS(MultiDataStructure, Int32, Int32) | Constructs a fixed size array of FixedTime in a Multiple Occurrence Data Structure. |
FixedTimeArrayInDS(DataStructure, Int32, Int32)
Constructs a fixed size array of FixedTime in a Data Structure.
FixedTimeArrayInDS(DataStructure, Int32, Int32)
Parameters
Type | Parameter name | Description |
---|---|---|
DataStructure | parent | The DataStructure containing this array of FixedTime. |
Int32 | startPos | The starting position of the array within the DataStructure buffer. |
Int32 | skipPositions | For non-contiguous arrays, the number of position between two consecutive array elements. |
FixedTimeArrayInDS(MultiDataStructure, Int32, Int32)
Constructs a fixed size array of FixedTime in a Multiple Occurrence Data Structure.
FixedTimeArrayInDS(MultiDataStructure, Int32, Int32)
Parameters
Type | Parameter name | Description |
---|---|---|
MultiDataStructure | parent | The MultiDataStructure containing this array of FixedTime. |
Int32 | startPos | The starting position of the array within the DataStructure buffer. |
Int32 | skipPositions | For non-contiguous arrays, the number of position between two consecutive array elements. |
Properties
Type | Name | Description |
---|---|---|
FixedTime<TFormat, TSeparator> | Item | Indexer over the array, gets or sets the FixedTime element at that position. |
Int32 | Length | Gets the total number of elements in the array. |
DataStructure | ParentDS | Gets the Data Structure to which this field belongs. |
Int32 | SkipPositions | For non-contiguous arrays, gets the number of buffer positions between consecutive array elements. 0 otherwise. |
Int32 | StartPosition | Gets the Data Structure buffer position where this array starts. |
Methods
Signature | Description |
---|---|
Clear() | Sets all array elements to the Time default value. |
CopyFrom(DateTime[], Int32) | Copies elements from a DateTime[] into this array. |
GetEnumerator() | Returns an enumerator that iterates through the array. |
GetStartingPosition(Int32) | Gets the starting position in the DataStructure buffer of the element indicated by the index parameter. |
op_Explicit(FixedTimeArrayInDS<TDim, TFormat, TSeparator>) | Casting operator to DateTime[]. Returns a copy of the array as a DateTime[]. |
op_Implicit(FixedTimeArrayInDS<TDim, TFormat, TSeparator>) | Casting operator to FixedTimeArray. Returns a copy of the array as a FixedTimeArray. |
Sort(Boolean, Int32, Int32) | Sorts a range of elements in the array in ascending or descending order. |
void Clear()
Sets all array elements to the Time default value.
void Clear()
void CopyFrom(DateTime[] sourceArray, int targetStartAt)
Copies elements from a DateTime[] into this array.
void CopyFrom(DateTime[] sourceArray, int targetStartAt)
Parameters
Type | Parameter name | Description |
---|---|---|
DateTime[] | sourceArray | The array to copy from. |
Int32 | targetStartAt | The index in this array where the copying should start. |
IEnumerator<FixedTime<TFormat, TSeparator» GetEnumerator()
Returns an enumerator that iterates through the array.
IEnumerator<FixedTime<TFormat, TSeparator>> GetEnumerator()
int GetStartingPosition(int index)
Gets the starting position in the DataStructure buffer of the element indicated by the index parameter.
int GetStartingPosition(int index)
Parameters
Type | Parameter name | Description |
---|---|---|
Int32 | index | The index of the desired element. |
Returns
Type | Description |
---|---|
Int32 | The position in the buffer of the element at the given index. |
DateTime[] op_Explicit(FixedTimeArrayInDS<TDim, TFormat, TSeparator> array)
Casting operator to DateTime[]. Returns a copy of the array as a DateTime[].
DateTime[] op_Explicit(FixedTimeArrayInDS<TDim, TFormat, TSeparator> array)
FixedTimeArray<TDim, TFormat, TSeparator> op_Implicit(FixedTimeArrayInDS<TDim, TFormat, TSeparator> array)
Casting operator to FixedTimeArray. Returns a copy of the array as a FixedTimeArray.
FixedTimeArray<TDim, TFormat, TSeparator> op_Implicit(FixedTimeArrayInDS<TDim, TFormat, TSeparator> array)
void Sort(bool ascending, int start, int length)
Sorts a range of elements in the array in ascending or descending order.
void Sort(bool ascending, int start, int length)
Parameters
Type | Parameter name | Description |
---|---|---|
Boolean | ascending | True (default) for ascending. |
Int32 | start | The starting index of the range to sort. Default is 0. |
Int32 | length | The number of elements in the range to sort. Default is -1, which means sort all elements. |