Layout struct | QSYS API Reference Guide
Estimated reading time: 20 minutes
Defines a layout for a field in a data structure.
Namespace: ASNA.QSys.Runtime
Assembly: ASNA.QSys.Runtime.dll
Properties
Type |
Name |
Description |
Int32 |
ArrayLength |
If the layout describes an array, the number of elements in the array. |
Int32 |
Decimals |
If the layout describes a fixed decimal number, the number of decimal positions. |
Int32 |
Digits |
If the layout describes a fixed decimal number, the number of digits. |
DateTimeFormat |
Format |
For date/time/timestamps, the enum value representing the format of the data. |
Boolean |
IsArray |
True if this layout describes an array, false otherwise. |
Int32 |
ItemLength |
For arrays, the length on an array element. For scalars, this is the same as Length. |
Int32 |
Length |
Gets the length of the field described by the layout. If the layout describes an array, the total length of all elements of the array. |
DateTimeSeparator |
Separator |
For date/time/timestamps, the enum value representing the data separator. |
Int32 |
Skip |
For OVERLAY arrays, the number of positions to skip between array elements. |
LayoutType |
Type |
Gets an enum value that represents the type of the field. |
Methods
Signature |
Description |
Binary(Int32, Int32) |
Creates a layout for a FixedDecimal field with a binary format. |
BinaryArray(Int32, Int32, Int32, Int32) |
Creates a layout for a FixedDecimal array field with binary format. |
Byte() |
Creates a layout for a byte field. |
ByteArray(Int32, Int32) |
Creates a layout for a byte array field. |
Char() |
Creates a layout for a char field. |
CharArray(Int32, Int32) |
Creates a layout for a character array field. |
Date(DateTimeFormat, DateTimeSeparator) |
Creates a layout for a FixedDate field. |
DateArray(Int32, DateTimeFormat, DateTimeSeparator, Int32) |
Creates a layout for a FixedDate array field. |
Equals(Object) |
Equality comparer. |
FixedString(Int32) |
Creates a layout for a FixedString field. |
FixedStringArray(Int32, Int32, Int32) |
Creates a layout for a FixedString array field. |
GetHashCode() |
Get the unique hashcode of this instance. |
Hex(Int32) |
Creates a layout for a Hex (byte[]) field. |
Indicator() |
Creates a layout for an Indicator field. |
IndicatorArray(Int32, Int32) |
Creates a layout for an Indicator array field. |
Integer() |
Creates a layout for an integer field. |
IntegerArray(Int32, Int32) |
Creates a layout for an int array field. |
Long() |
Creates a layout for a long field. |
LongArray(Int32, Int32) |
Creates a layout for a long array field. |
NewLayout(LayoutType, Int32, Int32, Int32, DateTimeFormat, DateTimeSeparator, Int32, Int32) |
Creates a layout with the given values. |
op_Equality(Layout, Layout) |
Equality operator. |
op_Inequality(Layout, Layout) |
Inequality operator. |
Packed(Int32, Int32) |
Creates a layout for a FixedDecimal field with a packed format. |
PackedArray(Int32, Int32, Int32, Int32) |
Creates a layout for a FixedDecimal array field with packed format. |
Short() |
Creates a layout for a short field. |
ShortArray(Int32, Int32) |
Creates a layout for a short array field. |
Time(DateTimeFormat, DateTimeSeparator) |
Creates a layout for a FixedTime field. |
TimeArray(Int32, DateTimeFormat, DateTimeSeparator, Int32) |
Creates a layout for a FixedTime array field. |
Timestamp(DateTimeSeparator) |
Creates a layout for a FixedTimestamp field. |
TimestampArray(Int32, DateTimeSeparator, Int32) |
Creates a layout for a FixedTimestamp array field. |
Zoned(Int32, Int32) |
Creates a layout for a FixedDecimal field with a zoned format. |
ZonedArray(Int32, Int32, Int32, Int32) |
Creates a layout for a FixedDecimal array field with zoned format. |
Creates a layout for a FixedDecimal field with a binary format.
ILayout Binary(int digits, int decimals)
Parameters
Type |
Parameter name |
Description |
Int32 |
digits |
The total number of digits in this FixedDecimal. |
Int32 |
decimals |
The number of decimal positions in this FixedDecimal. |
Returns
Type |
Description |
ILayout |
The layout describing a FixedDecimal field with a binary format. |
Creates a layout for a FixedDecimal array field with binary format.
ILayout BinaryArray(int arrayLength, int digits, int decimals, int skip)
Parameters
Type |
Parameter name |
Description |
Int32 |
arrayLength |
Length (number of elements) of the array. |
Int32 |
digits |
The total number of digits in the FixedDecimal. |
Int32 |
decimals |
The number of decimal positions in the FixedDecimal. |
Int32 |
skip |
Number of positions to skip between elements in a non-contiguous array. |
Returns
Type |
Description |
ILayout |
The layout describing a FixedDecimal array field with binary format. |
ILayout Byte()
Creates a layout for a byte field.
Creates a layout for a byte array field.
ILayout ByteArray(int arrayLength, int skip)
Parameters
Type |
Parameter name |
Description |
Int32 |
arrayLength |
Length (number of elements) of the array. |
Int32 |
skip |
Number of positions to skip between elements in a non-contiguous array. |
Returns
Type |
Description |
ILayout |
The layout describing a byte array field. |
ILayout Char()
Creates a layout for a char field.
Creates a layout for a character array field.
ILayout CharArray(int arrayLength, int skip)
Parameters
Type |
Parameter name |
Description |
Int32 |
arrayLength |
Length (number of elements) of the array. |
Int32 |
skip |
Number of positions to skip between elements in a non-contiguous array. |
Returns
Type |
Description |
ILayout |
The layout describing a character array field. |
Creates a layout for a FixedDate field.
ILayout Date(DateTimeFormat format, DateTimeSeparator separator)
Parameters
Type |
Parameter name |
Description |
DateTimeFormat |
format |
The enum value describing the format of this FixedDate. |
DateTimeSeparator |
separator |
The enum value describing the separator this FixedDate uses. |
Returns
Type |
Description |
ILayout |
The layout describing a FixedDate field with the given format and separator. |
Creates a layout for a FixedDate array field.
ILayout DateArray(int arrayLength, DateTimeFormat format, DateTimeSeparator separator, int skip)
Parameters
Type |
Parameter name |
Description |
Int32 |
arrayLength |
Length (number of elements) of the array. |
DateTimeFormat |
format |
The enum value describing the format of this FixedDate. |
DateTimeSeparator |
separator |
The enum value describing the separator this FixedDate uses. |
Int32 |
skip |
Number of positions to skip between elements in a non-contiguous array. |
Returns
Type |
Description |
ILayout |
The layout describing a FixedDate array field. |
Equality comparer.
Parameters
Type |
Parameter name |
Description |
Object |
obj |
The object against which to compare. |
Returns
Type |
Description |
Boolean |
True if the Layouts are equivalent, i.e. if all of their properties correspondingly have the same values. |
ILayout FixedString(int length)
Creates a layout for a FixedString field.
ILayout FixedString(int length)
Parameters
Type |
Parameter name |
Description |
Int32 |
length |
The length of the FixedString field. |
Returns
Type |
Description |
ILayout |
The layout describing a FixedString field. |
Creates a layout for a FixedString array field.
ILayout FixedStringArray(int arrayLength, int length, int skip)
Parameters
Type |
Parameter name |
Description |
Int32 |
arrayLength |
Length (number of elements) of the array. |
Int32 |
length |
Length of the FixedStrings |
Int32 |
skip |
Number of positions to skip between elements in a non-contiguous array. |
Returns
Type |
Description |
ILayout |
The layout describing a FixedString array field. |
int GetHashCode()
Get the unique hashcode of this instance.
Creates a layout for a Hex (byte[]) field.
Parameters
Type |
Parameter name |
Description |
Int32 |
length |
The length of the Hex field. |
Returns
Type |
Description |
ILayout |
The layout describing a Hex field. |
ILayout Indicator()
Creates a layout for an Indicator field.
Creates a layout for an Indicator array field.
ILayout IndicatorArray(int arrayLength, int skip)
Parameters
Type |
Parameter name |
Description |
Int32 |
arrayLength |
Length (number of elements) of the array. |
Int32 |
skip |
Number of positions to skip between elements in a non-contiguous array. |
Returns
Type |
Description |
ILayout |
The layout describing an Indicator array field. |
ILayout Integer()
Creates a layout for an integer field.
Creates a layout for an int array field.
ILayout IntegerArray(int arrayLength, int skip)
Parameters
Type |
Parameter name |
Description |
Int32 |
arrayLength |
Length (number of elements) of the array. |
Int32 |
skip |
Number of positions to skip between elements in a non-contiguous array. |
Returns
Type |
Description |
ILayout |
The layout describing an int array field. |
ILayout Long()
Creates a layout for a long field.
Creates a layout for a long array field.
ILayout LongArray(int arrayLength, int skip)
Parameters
Type |
Parameter name |
Description |
Int32 |
arrayLength |
Length (number of elements) of the array. |
Int32 |
skip |
Number of positions to skip between elements in a non-contiguous array. |
Returns
Type |
Description |
ILayout |
The layout describing a long array field. |
Creates a layout with the given values.
ILayout NewLayout(LayoutType type, int digits, int decimals, int length, DateTimeFormat format, DateTimeSeparator separator, int arrayLength, int skip)
Parameters
Type |
Parameter name |
Description |
LayoutType |
type |
LayoutType of this layout |
Int32 |
digits |
If the layout is numeric, the number of digits. |
Int32 |
decimals |
If the layout is decimal numeric, the number of decimal positions. |
Int32 |
length |
For FixedString and Hex, length of the field. |
DateTimeFormat |
format |
For Date and Time, the date or time format. |
DateTimeSeparator |
separator |
For Date, Time and Timestamp, the separator. |
Int32 |
arrayLength |
For arrays, the size of the array. |
Int32 |
skip |
For non-contiguous array, the number of positions to skip between elements. |
Returns
Type |
Description |
ILayout |
The new layout. |
Equality operator.
bool op_Equality(Layout first, Layout second)
Parameters
Type |
Parameter name |
Description |
Layout |
first |
The first Layout to compare. |
Layout |
second |
The second Layout to compare. |
Returns
Type |
Description |
Boolean |
True if the Layouts are equivalent, i.e. if all of their properties correspondingly have the same values. |
Inequality operator.
bool op_Inequality(Layout first, Layout second)
Parameters
Type |
Parameter name |
Description |
Layout |
first |
The first Layout to compare. |
Layout |
second |
The second Layout to compare. |
Returns
Type |
Description |
Boolean |
True if the Layouts are different, i.e. if any of their properties correspondingly have different values. |
Creates a layout for a FixedDecimal field with a packed format.
ILayout Packed(int digits, int decimals)
Parameters
Type |
Parameter name |
Description |
Int32 |
digits |
The total number of digits in this FixedDecimal. |
Int32 |
decimals |
The number of decimal positions in this FixedDecimal. |
Returns
Type |
Description |
ILayout |
The layout describing a FixedDecimal field with a packed format. |
Creates a layout for a FixedDecimal array field with packed format.
ILayout PackedArray(int arrayLength, int digits, int decimals, int skip)
Parameters
Type |
Parameter name |
Description |
Int32 |
arrayLength |
Length (number of elements) of the array. |
Int32 |
digits |
The total number of digits in the FixedDecimal. |
Int32 |
decimals |
The number of decimal positions in the FixedDecimal. |
Int32 |
skip |
Number of positions to skip between elements in a non-contiguous array. |
Returns
Type |
Description |
ILayout |
The layout describing a FixedDecimal array field with packed format. |
ILayout Short()
Creates a layout for a short field.
Creates a layout for a short array field.
ILayout ShortArray(int arrayLength, int skip)
Parameters
Type |
Parameter name |
Description |
Int32 |
arrayLength |
Length (number of elements) of the array. |
Int32 |
skip |
Number of positions to skip between elements in a non-contiguous array. |
Returns
Type |
Description |
ILayout |
The layout describing a short array field. |
Creates a layout for a FixedTime field.
ILayout Time(DateTimeFormat format, DateTimeSeparator separator)
Parameters
Type |
Parameter name |
Description |
DateTimeFormat |
format |
The enum value describing the format of this FixedTime. |
DateTimeSeparator |
separator |
The enum value describing the separator this FixedTime uses. |
Returns
Type |
Description |
ILayout |
The layout describing a FixedTime field with the given format and separator. |
Creates a layout for a FixedTime array field.
ILayout TimeArray(int arrayLength, DateTimeFormat format, DateTimeSeparator separator, int skip)
Parameters
Type |
Parameter name |
Description |
Int32 |
arrayLength |
Length (number of elements) of the array. |
DateTimeFormat |
format |
The enum value describing the format of this FixedTime. |
DateTimeSeparator |
separator |
The enum value describing the separator this FixedTime uses. |
Int32 |
skip |
Number of positions to skip between elements in a non-contiguous array. |
Returns
Type |
Description |
ILayout |
The layout describing a FixedTime array field. |
Creates a layout for a FixedTimestamp field.
ILayout Timestamp(DateTimeSeparator separator)
Parameters
Type |
Parameter name |
Description |
DateTimeSeparator |
separator |
The enum value describing the separator this FixedTimestamp uses. |
Returns
Type |
Description |
ILayout |
The layout describing a FixedTimestamp field with the given separator. |
Creates a layout for a FixedTimestamp array field.
ILayout TimestampArray(int arrayLength, DateTimeSeparator separator, int skip)
Parameters
Type |
Parameter name |
Description |
Int32 |
arrayLength |
Length (number of elements) of the array. |
DateTimeSeparator |
separator |
The enum value describing the separator this FixedTimestamp uses. |
Int32 |
skip |
Number of positions to skip between elements in a non-contiguous array. |
Returns
Type |
Description |
ILayout |
The layout describing a FixedTimestamp array field. |
Creates a layout for a FixedDecimal field with a zoned format.
ILayout Zoned(int digits, int decimals)
Parameters
Type |
Parameter name |
Description |
Int32 |
digits |
The total number of digits in this FixedDecimal. |
Int32 |
decimals |
The number of decimal positions in this FixedDecimal. |
Returns
Type |
Description |
ILayout |
The layout describing a FixedDecimal field with a zoned format. |
Creates a layout for a FixedDecimal array field with zoned format.
ILayout ZonedArray(int arrayLength, int digits, int decimals, int skip)
Parameters
Type |
Parameter name |
Description |
Int32 |
arrayLength |
Length (number of elements) of the array. |
Int32 |
digits |
The total number of digits in the FixedDecimal. |
Int32 |
decimals |
The number of decimal positions in the FixedDecimal. |
Int32 |
skip |
Number of positions to skip between elements in a non-contiguous array. |
Returns
Type |
Description |
ILayout |
The layout describing a FixedDecimal array field with zoned format. |