Documentation Center

  • Trial Software
  • Product Updates

Contents

Simulink.RunTimeBlock

Allow Level-2 MATLAB S-function and other MATLAB programs to get information about block while simulation is running

Description

This class allows a Level-2 MATLAB® S-function or other MATLAB program to obtain information about a block. Simulink® software creates an instance of this class or a derived class for each block in a model. Simulink software passes the object to the callback methods of Level-2 MATLAB 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 software. See Write Level-2 MATLAB S-Functions in Writing S-Functions for more information. You can also use instances of this class in MATLAB programs to obtain information about blocks during a simulation. See Access Block Data During Simulation for more information.

    Note   Simulink.RunTimeBlock objects do not support MATLAB sparse matrices. For example, the following line of code attempts to assign a sparse identity matrix to the run-time object's output port data. This line of code in a Level-2 MATLAB S-function produces an error:

      block.Outport(1).Data = speye(10);

Parent Class

None

Property Summary

Name

Description

BlockHandle

Block's handle.

CurrentTime

Current simulation time.

NumDworks

Number of discrete work vectors used by the block.

NumOutputPorts

Number of block output ports.

NumContStates

Number of block's continuous states.

NumDworkDiscStates

Number of block's discrete states

NumDialogPrms

Number of parameters that can be entered on S-function block's dialog box.

NumInputPorts

Number of block's input ports.

NumRuntimePrms

Number of run-time parameters used by block.

SampleTimes

Sample times at which block produces outputs.

Method Summary

Name

Description

ContStates

Get a block's continuous states.

DataTypeIsFixedPoint

Determine whether a data type is fixed point.

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 entered 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 run-time parameters used by a block.

Properties

BlockHandle

Description

Block's handle.

Access

RO

CurrentTime

Description

Current simulation time.

Access

RO

NumDworks

Description

Number of data work vectors.

Access

RW

See Also

ssGetNumDWork

NumOutputPorts

Description

Number of output ports.

Access

RW

See Also

ssGetNumOutputPorts

NumContStates

Description

Number of continuous states.

Access

RW

See Also

ssGetNumContStates

NumDworkDiscStates

Description

Number of discrete states. In a MATLAB S-function, you need to use DWorks to set up discrete states.

Access

RW

See Also

ssGetNumDiscStates

NumDialogPrms

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 the S-function parameters dialog field.

Access

RW

See Also

ssGetNumSFcnParams

NumInputPorts

Description

Number of input ports.

Access

RW

See Also

ssGetNumInputPorts

NumRuntimePrms

Description

Number of run-time parameters used by this block. See Run-Time Parameters for more information.

Access

RW

See Also

ssGetNumSFcnParams

SampleTimes

Description

Block's sample times.

Access

RW for MATLAB S-functions, RO for all other blocks.

Methods

ContStates

Purpose

Get a block's continuous states.

Syntax

states = ContStates();

Description

Get vector of continuous states.

See Also

ssGetContStates

DataTypeIsFixedPoint

Purpose

Determine whether a data type is fixed point.

Syntax

bVal = DataTypeIsFixedPoint(dtID);

Arguments

dtID

Integer value specifying the ID of a data type.

Description

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

DatatypeName

Purpose

Get the name of a data type.

Syntax

name = DatatypeName(dtID);

Arguments

dtID

Integer value specifying ID of a data type.

Description

Returns the name of the data type specified by dtID.

See Also

DatatypeSize

DatatypeSize

Purpose

Get the size of a data type.

Syntax

size = DatatypeSize(dtID);

Arguments

dtID

Integer value specifying the ID of a data type.

Description

Returns the size of the data type specified by dtID.

See Also

DatatypeName

Derivatives

Purpose

Get derivatives of a block's continuous states.

Syntax

derivs = Derivatives();

Description

Get vector of state derivatives.

See Also

ssGetdX

DialogPrm

Purpose

Get an S-function's dialog parameters.

Syntax

param = DialogPrm(pIdx);

Arguments

pIdx

Integer value specifying the index of the parameter to be returned.

Description

Get the 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

Dwork

Purpose

Get one of a block's DWork vectors.

Syntax

dworkObj = Dwork(dwIdx);

Arguments

dwIdx

Integer value specifying the index of a work vector.

Description

Get information about the DWork vector specified by dwIdx where dwIdx is the index number of the work vector. This method returns an object of type Simulink.BlockCompDworkData.

See Also

ssGetDWork

FixedPointNumericType

Purpose

Get the properties of a fixed-point data type.

Syntax

eno = FixedPointNumericType(dtID);

Arguments

dtID

Integer value specifying the 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 Fixed-Point Designer™ software. For information on the properties defined by embedded.Numeric class, see numerictype Object Properties.

InputPort

Purpose

Get an input port of a block.

Syntax

port = InputPort(pIdx);

Arguments

pIdx

Integer value specifying the index of an input port.

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 run-time 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, OutputPort

OutputPort

Purpose

Get an output port of a block.

Syntax

port = OutputPort(pIdx);

Arguments

pIdx

Integer value specifying the index of an output port.

Description

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

port = rto.OutputPort(1)

returns the first output port of the block represented by the run-time 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, respectively. You can use this object to get and set the output port's uncompiled or compiled properties, respectively.

See Also

ssGetInputPortSignalPtrs, Simulink.BlockPreCompOutputPortData, Simulink.BlockCompOutputPortData

RuntimePrm

Purpose

Get an S-function's run-time parameters.

Syntax

param = RuntimePrm(pIdx);

Arguments

pIdx

Integer value specifying the index of a run-time parameter.

Description

Get the run-time parameter whose index is pIdx. This run-time parameter is a Simulink.BlockData object of type Simulink.BlockRunTimePrmData.

See Also

ssGetRunTimeParamInfo

Was this topic helpful?