FixedStringArrayInDS struct

Estimated reading time: 4 minutes

Describes a fixed size array of FixedString contained in a DataStructure.

Namespace: ASNA.QSys.Runtime Assembly: ASNA.QSys.Runtime.dll



Constructors

Name Description
FixedStringArrayInDS(DataStructure, Int32, Int32) Constructs a fixed size array of FixedString in a Data Structure.
FixedStringArrayInDS(MultiDataStructure, Int32, Int32) Constructs a fixed size array of FixedString in a Multiple Occurrence Data Structure.

FixedStringArrayInDS(DataStructure, Int32, Int32)

Constructs a fixed size array of FixedString in a Data Structure.

FixedStringArrayInDS(DataStructure, Int32, Int32)

Parameters

Type Parameter name Description
DataStructure parent The DataStructure containing this array of FixedString.
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.

FixedStringArrayInDS(MultiDataStructure, Int32, Int32)

Constructs a fixed size array of FixedString in a Multiple Occurrence Data Structure.

FixedStringArrayInDS(MultiDataStructure, Int32, Int32)

Parameters

Type Parameter name Description
MultiDataStructure parent The MultiDataStructure containing this array of FixedString.
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
FixedString<TLen> Item Indexer over the array, gets or sets the FixedString 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 blanks.
CopyFrom(String[], Int32) Copies elements from a string[] 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(FixedStringArrayInDS<TDim, TLen>) Casting operator to string[]. Returns a copy of the array as a string[].
op_Implicit(FixedStringArrayInDS<TDim, TLen>) Casting operator to FixedStringArray. Returns a copy of the array as a FixedStringArray.
Sort(Boolean, Int32, Int32) Sorts a range of elements in the array in ascending or descending order.

void Clear()

Sets all array elements to blanks.

void Clear()

void CopyFrom(String[] sourceArray, int targetStartAt)

Copies elements from a string[] into this array.

void CopyFrom(String[] sourceArray, int targetStartAt)

Parameters

Type Parameter name Description
String[] sourceArray The array to copy from.
Int32 targetStartAt The index in this array where the copying should start.

IEnumerator<FixedString> GetEnumerator()

Returns an enumerator that iterates through the array.

IEnumerator<FixedString<TLen>> 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.

String[] op_Explicit(FixedStringArrayInDS<TDim, TLen> array)

Casting operator to string[]. Returns a copy of the array as a string[].

String[] op_Explicit(FixedStringArrayInDS<TDim, TLen> array)

FixedStringArray<TDim, TLen> op_Implicit(FixedStringArrayInDS<TDim, TLen> array)

Casting operator to FixedStringArray. Returns a copy of the array as a FixedStringArray.

FixedStringArray<TDim, TLen> op_Implicit(FixedStringArrayInDS<TDim, TLen> 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.