Hxi_SFunction.h File Reference

Detailed Description

Interface to a Simulink(R) S-function given as binary object.

Several S-function methods are supported that redirect the call to the binary object. Data is communicated through a SimStruct.

(Simulink is a registered trademark of The MathWorks, Inc.)

rf, 01/07/2005

#include "Hxi_SimStruct.h"

Include dependency graph for Hxi_SFunction.h:

base refererrect $Hxi__SimStruct_8h.html 178,83 298,109rect $Hxi__sfun__types_8h.html 372,108 498,135rect $Hxi__SimStruct__methods_8h.html 346,159 524,185

This graph shows which files directly or indirectly include this file:

base refererrect $Prg__SFunction_8h.html 178,32 300,59rect $Prg__SFunctionEst_8h.html 350,7 491,34rect $Prg__SFunctionOpt_8h.html 348,58 492,84


Defines
#define	Hxi_SFunction_H
	Avoid multiple inclusion.
Functions
Supported S-function methods.
void	mdlInitializeSizes (SimStruct *S)
	Initialize sizes of data vectors in SimStruct.
void	mdlStart (SimStruct *S)
	Optional: Allocate local ressources for simulation.
void	mdlInitializeSampleTimes (SimStruct *S)
	Initialize sample times.
void	mdlInitializeConditions (SimStruct *S)
	Optional: Compute initial conditions.
void	mdlOutputs (SimStruct *S, int_T tid)
	Compute model outputs.
void	mdlUpdate (SimStruct *S, int_T tid)
	Optional: Update discrete-time states.
void	mdlDerivatives (SimStruct *S)
	Optional: Compute derivatives for continuous-time states.
void	mdlJacobian (SimStruct *S)
	Optional: Compute Jacobian J = d(dxc,xd,y)/d(xc,xd,u).
void	mdlTerminate (SimStruct *S)
	Release resources allocated for simulation.

Function Documentation

void mdlDerivatives ( SimStruct * S ) [inline]

Optional: Compute derivatives for continuous-time states.

References Hxi_mdlDerivatives().

Referenced by Hxi_SimStruct_init().

void mdlInitializeConditions ( SimStruct * S ) [inline]

Optional: Compute initial conditions.

References Hxi_mdlInitializeConditions().

Referenced by Hxi_SimStruct_init().

void mdlInitializeSampleTimes ( SimStruct * S ) [inline]

Initialize sample times.

References Hxi_mdlInitializeSampleTimes().

Referenced by Hxi_SimStruct_init().

void mdlInitializeSizes ( SimStruct * S ) [inline]

Initialize sizes of data vectors in SimStruct.

This function works with the shared object found under ssGetPath(S), calls the S-function method mdlInitializeSizes and allocates memory required for a level 2 S-function. The model parameters must have been initialized prior to calling this function.

References Hxi_mdlInitializeSizes().

Referenced by Hxi_SimStruct_init().

void mdlJacobian ( SimStruct * S ) [inline]

Optional: Compute Jacobian J = d(dxc,xd,y)/d(xc,xd,u).

References Hxi_mdlJacobian().

Referenced by Hxi_SimStruct_init().