ShortArrayInDS struct | QSYS API Reference Guide

Estimated reading time: 4 minutes

Describes a fixed size array of short numbers contained in a DataStructure.

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

Constructors

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

Constructs a fixed size array of short numbers in a Data Structure.

ShortArrayInDS(DataStructure, Int32, Int32)

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

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

ShortArrayInDS(MultiDataStructure, Int32, Int32)

Type	Parameter name	Description
MultiDataStructure	parent	The MultiDataStructure containing this array of short numbers.
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.

Type	Name	Description
Int16	Item	Indexer over the array, gets or sets the short 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.

Signature	Description
Clear()	Sets all array elements to 0.
CopyFrom(Int16[], Int32)	Copies elements from a short[] 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(ShortArrayInDS<TDim>)	Casting operator to short[]. Returns a copy of the array as an short[].
Sort(Boolean, Int32, Int32)	Sorts a range of elements in the array in ascending or descending order.

Sets all array elements to 0.

void Clear()

Copies elements from a short[] into this array.

void CopyFrom(Int16[] sourceArray, int targetStartAt)

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

Returns an enumerator that iterates through the array.

IEnumerator<short> GetEnumerator()

Gets the starting position in the DataStructure buffer of the element indicated by the index parameter.

int GetStartingPosition(int index)

Type	Parameter name	Description
Int32	index	The index of the desired element.

Type	Description
Int32	The position in the buffer of the element at the given index.

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

Int16[] op_Explicit(ShortArrayInDS<TDim> array)

Type	Parameter name	Description
ShortArrayInDS<TDim>	array	The array to copy.

Type	Description
Int16[]

Sorts a range of elements in the array in ascending or descending order.

void Sort(bool ascending, int start, int length)

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.