S-function runtime methods

Functions
void	BaseBlock::start ()
void	BaseBlock::outputs ()
void	BaseBlock::derivatives ()
void	BaseBlock::zeroCrossings ()
void	BaseBlock::update ()
void	BaseBlock::terminate ()

Detailed Description

Function Documentation

derivatives()

void BaseBlock::derivatives ( )

inline

This optional method is called at each time step to compute the derivatives of the S-function's continuous states.

This method should store the derivatives in the S-function's state derivatives array using derivativesArray.

For more information, see: http://www.mathworks.fr/help/simulink/sfg/mdlderivatives.html

Definition at line 352 of file BaseBlock.h.

outputs()

void BaseBlock::outputs ( )

inline

This method is called at each simulation time step.

The method should compute the S-function's outputs at the current time step and store the results using outputArray or using writeOutput.

This method must be overridded in your custom function.

For more information, see: http://www.mathworks.fr/help/simulink/sfg/mdloutputs.html

Definition at line 340 of file BaseBlock.h.

start()

void BaseBlock::start ( )

inline

This method is called at the beginning of a simulation right after contructing the class.

The method should perform initialization activities that this S-function requires only once, such as allocating memory, setting up user data, or initializing states.

For more information, see: http://www.mathworks.fr/help/simulink/sfg/mdlstart.html

Definition at line 327 of file BaseBlock.h.

terminate()

void BaseBlock::terminate ( )

inline

This method is called when the simulation is terminated right before deleting the class.

This method should perform any terminal actions, such as freeing of memory.

For more information, see: http://www.mathworks.fr/help/simulink/sfg/mdlterminate.html

Definition at line 392 of file BaseBlock.h.

update()

void BaseBlock::update ( )

inline

This optional method is called at each major simulation time step.

The method should compute the S-function's states at the current time step and store the states in the S-function's state vector. The method can also perform any other tasks that the S-function needs to perform at each major time step.

Use this code if your S-function has one or more discrete states or does not have direct feedthrough.

For more information, see: http://www.mathworks.fr/help/simulink/sfg/mdlupdate.html

Definition at line 381 of file BaseBlock.h.

zeroCrossings()

void BaseBlock::zeroCrossings ( )

inline

An S-function needs to provide this optional method only if it does zero-crossing detection. Implementing zero-crossing detection typically requires using the zero-crossing and mode work vectors to determine when a zero crossing occurs and how the S-function's outputs should respond to this event. The zeroCrossings method should update the S-function's zero-crossing vector, using nonSampledZCsArray.

For more information, see: http://www.mathworks.fr/help/simulink/sfg/mdlzerocrossings.html

Definition at line 365 of file BaseBlock.h.