S-function initialization methods

Functions
static void	BaseBlock::checkParametersSizes ()
static void	BaseBlock::initializeInputPortSizes ()
static void	BaseBlock::initializeOutputPortSizes ()
static void	BaseBlock::setContinuousStatesWidth (int num)
static void	BaseBlock::setDiscreteStatesWidth (int num)
static void	BaseBlock::initializeStatePortSizes ()
static void	BaseBlock::initializeNumberSampleTimes ()
static void	BaseBlock::initializeOptions ()
static void	BaseBlock::checkInputPortFinalSizes (int port, int nRows, int nCols)
static void	BaseBlock::checkOutputPortFinalSizes (int port, int nRows, int nCols)
static void	BaseBlock::initializeSampleTimes ()

Detailed Description

Function Documentation

checkInputPortFinalSizes()

static void BaseBlock::checkInputPortFinalSizes ( int  port, int  nRows, int  nCols  )

inlinestatic

This static method is called with candidate dimensions for input port.

If the proposed dimensions are unacceptable for the port, the method must throw an exception.

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

Definition at line 273 of file BaseBlock.h.

checkOutputPortFinalSizes()

static void BaseBlock::checkOutputPortFinalSizes ( int  port, int  nRows, int  nCols  )

inlinestatic

This static method is called with candidate dimensions for output port.

If the proposed dimensions are unacceptable for the port, the method must throw an exception.

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

Definition at line 301 of file BaseBlock.h.

checkParametersSizes()

static void BaseBlock::checkParametersSizes ( )

inlinestatic

This is the first static method called before the simulation starts.

This static method is called with candidate parameter values.

This method must: 1) check the number of parameters using assertParameterPortCount 2) check the dimensions and the type of each parameter using assertParameterPort

This method must be overridded in your custom function.

For more information, see: https://fr.mathworks.com/help/simulink/sfg/mdlcheckparameters.html

Definition at line 97 of file BaseBlock.h.

initializeInputPortSizes()

static void BaseBlock::initializeInputPortSizes ( )

inlinestatic

This is the second static method called before the simulation starts.

This method must: 1) specify the number of input ports 2) specify the dimensions and the type of each input port

This method must be overridded in your custom function.

All input ports require contiguous data.

Use -1 to specify dynamically dimensioned input signals.

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

Definition at line 145 of file BaseBlock.h.

initializeNumberSampleTimes()

static void BaseBlock::initializeNumberSampleTimes ( )

inlinestatic

This is the fifth static method called before the simulation starts.

This method must set the number of sample time (i.e., sample rates) at which the block operates.

The default method specifies is a smaple time value of 1.

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

Definition at line 233 of file BaseBlock.h.

initializeOptions()

static void BaseBlock::initializeOptions ( )

inlinestatic

This is the sixth and last static method called before the simulation starts.

This method specifies the simulation options that this block implements, using ssSetOptions.

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

Definition at line 245 of file BaseBlock.h.

initializeOutputPortSizes()

static void BaseBlock::initializeOutputPortSizes ( )

inlinestatic

This is the third static method called before the simulation starts.

This method must: 1) specify the number of output ports 2) specify the dimensions and the type of each output port

This method must be overridded in your custom function.

Use -1 to specify dynamically dimensioned output signals.

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

Definition at line 189 of file BaseBlock.h.

initializeSampleTimes()

static void BaseBlock::initializeSampleTimes ( )

inlinestatic

This static method specifies the sample time and offset time for each sample rate at which this S-function operates.

The default values are INHERITED_SAMPLE_TIME and FIXED_IN_MINOR_STEP_OFFSET

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

Definition at line 312 of file BaseBlock.h.

initializeStatePortSizes()

static void BaseBlock::initializeStatePortSizes ( )

inlinestatic

This is the fourth static method called before the simulation starts.

This method must set the number of continuous and discrete states.

The default method specifies zero continuous states and zero discrete states.

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

Definition at line 218 of file BaseBlock.h.

setContinuousStatesWidth()

static void BaseBlock::setContinuousStatesWidth ( int  num )

inlinestatic

Sets the number of continuous states.

Definition at line 197 of file BaseBlock.h.

setDiscreteStatesWidth()

static void BaseBlock::setDiscreteStatesWidth ( int  num )

inlinestatic

Sets the number of discrete states.

Definition at line 205 of file BaseBlock.h.