Writing S-Functions    
ssWriteRTWParameters

Write tunable parameter information to the model.rtw file.

Syntax

Arguments

S
   SimStruct representing an S-Function block.

nParams
   Number of tunable parameters.

paramType
   Type of parameter (see Parameter Type-Specific Arguments).

paramName
   Name of the parameter.

stringInfo
   General information about the parameter, such as how it was derived.

...
   Remaining arguments depend on the parameter type (see Parameter Type-Specific Arguments).

Description

Use this function in mdlRTW to write tunable parameter information to this S-function's model.rtw file. Your S-function must write the parameters out in the same order as they are declared at the beginning of the S-function. This function returns true if successful.

Parameter Type-Specific Arguments

This section lists the parameter-specific arguments required by each parameter type.

Specifying Data Type Info

You obtain the data type of the value argument passed to the ssWriteRTW macros using

where dTypeId can be any one of the enum values in BuiltInDTypeID (SS_DOUBLE, SS_SINGLE, SS_INT8, SS_UINT8, SS_INT16, SS_UINT16, SS_INT32, SS_UINT32, SS_BOOLEAN) defined in simstuc_types.h. The isComplex argument is either 0 or 1.

For example, DTINFO(SS_INT32,0) is a noncomplex 32-bit signed integer.

If isComplex==1, the array of values is assumed to have the real and imaginary parts arranged in an interleaved manner (i.e., Simulink format). If you prefer to pass the real and imaginary parts as two separate arrays, you should use the macro ssWriteRTWMxVectParam or ssWriteRTWMx2dMatParam.

Example

See simulink/src/sfun_multiport.c for an example that uses this function.

Languages

C

See Also
mdlRTW


  ssWriteRTWMxVectParam ssWriteRTWParamSettings