ssGetDataTypeFractionLength

Return fraction length of registered data type with power-of-two scaling

Syntax

extern int ssGetDataTypeFractionLength (SimStruct *S, DTypeId
                                        dataTypeId)

Arguments

S

SimStruct representing an S-function block.

dataTypeId

Data type ID of the registered data type for which you want to know the fraction length.

Description

This function returns the fraction length, or the number of bits to the right of the binary point, of the data type designated by dataTypeId.

This function errors out when ssGetDataTypeIsScalingPow2 returns FALSE.

This function also errors out when ssGetDataTypeIsFxpFltApiCompat returns FALSE.

Requirement

To use this function, you must include fixedpoint.h and fixedpoint.c. For more information, see Structure of the S-Function.

Languages

C

TLC Functions

FixPt_DataTypeFractionLength