ssGetDataTypeFxpIsSigned

Determine whether fixed-point registered data type is signed or unsigned

Syntax

extern int ssGetDataTypeFxpIsSigned (SimStruct *S, DTypeId
                                     dataTypeId)

Arguments

S

SimStruct representing an S-function block.

dataTypeId

Data type ID of the registered fixed-point data type for which you want to know whether it is signed.

Description

This function determines whether a registered fixed-point data type is signed:

  • If the fixed-point data type is signed, the function returns TRUE. If the fixed-point data type is unsigned, the function returns FALSE.

  • If the registered data type is ScaledDouble, the function returns TRUE or FALSE according to the signedness of the nonoverridden data type.

  • If the registered data type is single or double, this function errors out.

This function errors out when ssGetDataTypeIsFxpFltApiCompat returns FALSE.

Requirements

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

  • To build an S-function that utilizes this function, you must compile it using the mex function with -lfixedpoint argument. For more information, see Create MEX Files.

Languages

C

TLC Functions

FixPt_DataTypeFxpIsSigned

Version History

Introduced before R2006a