Get Fixed-Point Information
- Updated2023-02-17
- 5 minute(s) read
Get Fixed-Point Information
Retrieves fixed-point numeric (FXP) information from a variant that contains a fixed-point numeric data type.
This node returns an error if the variant does not contain a fixed-point numeric.
variant
Variant data from which you want to retrieve data type information.
error in
Error conditions that occur before this node runs.
The node responds to this input according to standard error behavior.
Standard Error Behavior
Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.
| error in does not contain an error | error in contains an error |
|---|---|
| If no error occurred before the node runs, the node begins execution normally.
If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out. | If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out. |
Default: No error
FXP representation
Fixed-point information from the fixed-point data type stored in the variant.
Signed
A Boolean value that indicates whether the fixed-point data type stored in the variant is signed.
| True | The fixed-point data type stored in the variant is signed. |
| False | The fixed-point data type stored in the variant is unsigned. |
Word Length
Number of bits that this node uses to represent all the possible values of the fixed-point data type stored in the variant.
Integer Word Length
Number of integer bits, or the number of bits to shift the binary point to the left to reach the most significant bit, for all possible values of the fixed-point data type stored in the variant.
FXP range
Range this node calculates for the fixed-point number stored in the variant.
Range Min
Minimum value of the range of the fixed-point data type stored in the variant.
Range Max
Maximum value of the range of the fixed-point data type stored in the variant.
Delta
Maximum distance between any two sequential numbers in the range of the fixed-point data type stored in the variant.
overflow status included?
A Boolean value that indicates whether the fixed-point number in the variant includes an overflow status.
| True | The fixed-point number in the variant includes an overflow status. This node allocates additional storage space to track whether the fixed-point number is the result of an operation that overflowed. |
| False | The fixed-point number in the variant does not include an overflow status. |
error out
Error information.
The node produces this output according to standard error behavior.
Standard Error Behavior
Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.
| error in does not contain an error | error in contains an error |
|---|---|
| If no error occurred before the node runs, the node begins execution normally.
If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out. | If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out. |