Simulink Reference

Simulink.RunTimeBlock

Allow Level-2 M-file S-function and other M-file programs to get information about a block while a simulation running.

Description

This class allows a Level-2 M-file S-function or other M program to obtain information about a block. Simulink creates an instance of this class or a derived class for each block in a model. Simulink passes the object to the callback methods of Level-2 M-file S-functions when it updates or simulates a model, allowing the callback methods to get block-related information from and provide such information to Simulink. See Writing Level-2 M-file S-functions for more information.You can also use instances of this class in M-file programs to obtain information about blocks during a a simulation. See Accessing Block Data During Simulation for more information.

Parent Class

None.

Derived Classes

Simulink.MSFcnRunTimeBlock

Property Summary

Name	Description
BlockHandle	Block's handle.
CurrentTime	Current simulation time.
NumDworks	Number of discrete work vectors used by block.
NumOutputPorts	Number of block output ports.
NumContStates	Number of block's continuous states.
NumDiscStates	Number of block's discrete states
NumDlgParams	Number of parameters that can be entered on S-function block's dialog box.
NumInputPorts	Number of block's input ports.
NumRuntimePrms	Number of runtime parameters used by block.
SampleTimes	Sample times at which block produces outputs.

Method Summary

Name	Description
ContStates	Get a block's continuous states.
DataTypeIsFixedPoint	Get a block's continuous states.
DatatypeName	Get name of a data type supported by this block.
DatatypeSize	Get size of a data type supported by this block.
Derivatives	Get a block's continuous state derivatives.
DialogPrm	Get a parameter ented on an S-function block's dialog box.
Dwork	Get one of a block's Dwork vectors.
FixedPointNumericType	Determine the properties of a fixed-point data type.
InputPort	Get one of a block's input ports.
OutputPort	Get one of a block's output ports..
RuntimePrm	Get one of the runtime parameters used by a block.

Properties

Description:   Block's handle.

Access:   RO

Description:   Current simulation time.

Access:   RO

Description:   Number of data work vectors.

Access:   RW

See Also:   ssGetNumDWork

Description:   Number of output ports.

Access:   RW

See Also:   ssGetNumOutputPorts

Description:   Number of continuous states.

Access:   RW

See Also:   ssGetNumContStates

Description:   Number of discrete states. In an M-file S-function, you need to use Dworks to setup discrete states

Access:   RW

See Also:   ssGetNumDiscStates

Description:   Number of parameters declared on the block's dialog. In the case of the S-function, it returns the number of parameters listed as a comma-separated list in "S-function parameters" dialog field.

Access:   RW

See Also:   ssGetNumSFcnParams

Description:   Number of input ports.

Access:   RW

See Also:   ssGetNumInputPorts

Description:   Number of parameters declared on the block's dialog. In the case of the S-function, it returns the number of parameters listed as a comma-separated list in "S-function parameters" dialog field.

Access:   RW

See Also:   ssGetNumSFcnParams

Description:   Blocls's sample times.

Access:   RW for M-file S-functions, RO for all other blocks.

Methods

Purpose:   Get a block's continuous states

Syntax:   states = ContStates();

Description:   Get vector of continuous states.

See Also:   ssGetContStates

Purpose:   Determine whether a data type is fixed point.

Syntax:   bVal = DataTypeIsFixedPoint(dtID);

Arguments:   
  

• dtID

• Integer value specifying ID of s data type.

Description:   Returns true if the specified data type is a fixed-point data type.

Purpose:   Get the name of a data type.

Syntax:   name = DatatypeName(dtID);

Arguments:   
  

• dtID

• Integer value specifying ID of s data type.

Description:   Returns the name of the data type specified by dtID.

See Also:   DatatypeSize

Purpose:   Get the size of a data type.

Syntax:   size = DatatypeSize(dtID);

Arguments:   
  

• dtID

• Integer value specifying ID of s data type.

Description:   Returns the size of the data type specified by dtID.

See Also:   DatatypeName

Purpose:   Get derivatives of a block's continuous states

Syntax:   states = ContStates();

Description:   Get vector of state derivatives.

See Also:   ssGetdX

Purpose:   Get an S-function's dialog parameters.

Syntax:   param = DialogPrm(pIdx);

Description:   Get specified dialog parameter. In the case of the S-function each DialogPrm corresponds to one of the elements in the comma-separated list of parameters in the S-function parameters dialog field.

See Also:   ssGetSFcnParam, RuntimePrm

Purpose:   Get one of a block's Dwork vectors.

Syntax:   dworkObj = Dwork(pIdx);

Description:   Get information abouth the Dwork vector specified by pIdx where pIdx is the index number of the work vector. This method returns an object of type Simulink.BlockCompDworkData.

See Also:   ssGetDWork

Purpose:   Get the properties of a fixed-point data type.

Syntax:   eno = FixedPointNumericType(dtID);

Arguments:   
  

• dtID

• Integer value specifying ID of a fixed-point data type.

Description:   Returns an object of Embedded.Numeric class that contains the attributes of the specified fixed-point data type.

Note    Embedded.Numeric is also the class of the numerictype objects created by the Fixed-Point Toolbox. For information on the properties defined by Embedded.Numeric class, see "numerictype Object Properties" in the "Property Reference" in the Fixed-Point Toolbox documentation.

Purpose:   Get an input port of a block.

Syntax:   port = InputPort(pIdx);

Description:   Get the input port specified by pIdx, where pIdx is the index number of the input port. For example,

• port = rto.InputPort(1)
  

returns the first input port of the block represented by the runtime object rto.

This method returns an object of type Simulink.BlockPreCompInputPortData or Simulink.BlockCompInputPortData, depending on whether the model that contains the port is uncompiled or compiled. You can use this object to get and set the input port's uncompiled or compiled properties, respectively.

See Also:   ssGetInputPortSignalPtrs, Simulink.BlockPreCompInputPortData, Simulink.BlockCompInputPortData, .html">OutputPort

Purpose:   Get an output port of a block.

Syntax:   port = OutputPort(pIdx);

Description:   Get the output port specified by pIdx, where pIdx is the index number of the output port. For example,

• port = rto.InputPort(1)
  

returns the first output port of the block represented by the runtime object rto.

This method returns an object of type Simulink.BlockPreCompOutputPortData or Simulink.BlockCompOutputPortData, depending on whether the model that contains the port is uncompiled or compiled. You can use this object to get and set the input port's uncompiled or compiled properties, respectively.

See Also:   ssGetInputPortSignalPtrs, .html">Simulink.BlockPreCompOutputPortData, .html">Simulink.BlockCompOutputPortData

Purpose:   Get an S-function's runtime parameters.

Syntax:   param = RuntimePrm(pIdx);

Description:   Get specified runtime parameter.

See Also:   ssGetRunTimeParamInfo

Simulink.ParamRTWInfo

Simulink.ScopeDataLogs

© 1994-2005 The MathWorks, Inc.