TypeDigestor class | QSYS API Reference Guide
Estimated reading time: 5 minutes
Contains methods that aid in the parsing of the generic type arguments of fixed-sized types.
Namespace: ASNA.QSys.Runtime Assembly: ASNA.QSys.Runtime.dll
Inheritance: Object
Methods
| Signature | Description |
|---|---|
| computeCharLength(Type, Int32&) | Given the ILen type that represents the length of a FixedString type, computes the actual value for the length. |
| computeDecimalLength(Type, Type, Int32&, Int32&) | Given the INumber types that represent the digits and decimals of a FixedDecimal type, computes the actual values for digits and decimals. |
| computeDim(Type, Int32&) | Given the IDim type that represents the dimension of a FixedArray type, computes the actual value for the dimension. |
| formatToType(DateTimeFormat) | Returns the type corresponding to a DateTimeFormat. |
| GetDateTimeObject(DateTimeDataKind, DateTimeFormat, DateTimeSeparator) | Constructs a fixed date/time/timestamp object given its kind, format, and separator. |
| parseDateTimeType(DateTimeDataKind, Type, Type, DateTimeFormat&, DateTimeSeparator&, Boolean) | Finds the format and separator enum values of a fixed date/time/timestamp given the kind, IDateTimeFormat, and IDateTimeSeparator. |
| separatorToType(DateTimeSeparator) | Returns the type corresponding to a DateTimeSeparator. |
void computeCharLength(Type tLen, Int32& length)
Given the ILen type that represents the length of a FixedString type, computes the actual value for the length.
void computeCharLength(Type tLen, Int32& length)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| Type | tLen | The ILen type that represents the length. |
| Int32& | length | The numeric value of tLen. |
void computeDecimalLength(Type tDigits, Type tDecimals, Int32& digits, Int32& decimals)
Given the INumber types that represent the digits and decimals of a FixedDecimal type, computes the actual values for digits and decimals.
void computeDecimalLength(Type tDigits, Type tDecimals, Int32& digits, Int32& decimals)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| Type | tDigits | The INumber type that represents the digits. |
| Type | tDecimals | The INumber type that represents the decimal positions. |
| Int32& | digits | The numeric value of tDigits. |
| Int32& | decimals | The numeric value of tDecimals. |
void computeDim(Type tDim, Int32& dim)
Given the IDim type that represents the dimension of a FixedArray type, computes the actual value for the dimension.
void computeDim(Type tDim, Int32& dim)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| Type | tDim | The IDim type that represents the dimension. |
| Int32& | dim | The numeric value of tDim. |
Type formatToType(DateTimeFormat format)
Returns the type corresponding to a DateTimeFormat.
Type formatToType(DateTimeFormat format)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| DateTimeFormat | format | The DateTimeFormat value for which to return the corresponding type. |
Returns
| Type | Description |
|---|---|
| Type | The Type object corresponding to the format parameter value. |
IFixedDateTime GetDateTimeObject(DateTimeDataKind kind, DateTimeFormat format, DateTimeSeparator sep)
Constructs a fixed date/time/timestamp object given its kind, format, and separator.
IFixedDateTime GetDateTimeObject(DateTimeDataKind kind, DateTimeFormat format, DateTimeSeparator sep)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| DateTimeDataKind | kind | The DateTimeDataKind to construct. |
| DateTimeFormat | format | The DateTimeFormat of the date/time/timestamp object. This parameter is ignored when constructing a FixedTimestamp object. |
| DateTimeSeparator | sep | The DateTimeSeparator of the date/time/timestamp object |
Returns
| Type | Description |
|---|---|
| IFixedDateTime | The constructed fixed date/time/timestamp object. |
void parseDateTimeType(DateTimeDataKind kind, Type Tformat, Type Tseparator, DateTimeFormat& format, DateTimeSeparator& separator, bool replaceDefault)
Finds the format and separator enum values of a fixed date/time/timestamp given the kind, IDateTimeFormat, and IDateTimeSeparator.
void parseDateTimeType(DateTimeDataKind kind, Type Tformat, Type Tseparator, DateTimeFormat& format, DateTimeSeparator& separator, bool replaceDefault)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| DateTimeDataKind | kind | The DateTimeDataKind to use to find the separator when the Tseparator parameter is typeof(_Default). |
| Type | Tformat | The IDatetimeFormat type that represents the fixed date/time/timestamp format. |
| Type | Tseparator | The IDateTimeSeparator type that represents the fixed date/time/timestamp separator. |
| DateTimeFormat& | format | Returs the DateTimeFormat enum value correspoding to the given parameteres. |
| DateTimeSeparator& | separator | Returs the DateTimeSeparator enum value correspoding to the given parameteres. |
| Boolean | replaceDefault | True to convert the default separator into the actual separator according to the date/time kind and its format. True is the default. |
Type separatorToType(DateTimeSeparator separator)
Returns the type corresponding to a DateTimeSeparator.
Type separatorToType(DateTimeSeparator separator)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| DateTimeSeparator | separator | The DateTimeSeparator value for which to return the corresponding type. |
Returns
| Type | Description |
|---|---|
| Type | The Type object corresponding to the separator parameter value. |