State Reader

Read a block state

• Library:

• Simulink / Signal Routing

Description

The State Reader block reads the current state of a supported state owner block. When creating a library block with a State Reader block also include the state owner block.

Add a State Reader block to your model from the Simulink^® Library Browser.

State Reader blocks can read state from these state owner blocks:

• Discrete State-Space

• Discrete-Time Integrator

• Delay

• Unit Delay

• Discrete Transfer Fcn

• Discrete Filter

• Discrete FIR Filter

• Integrator

• Second-Order Integrator

• Conditional subsystem blocks such as Enabled Subsystem, Triggered Subsystem, and Function-Call Subsystem.

• S-Function with multiple discrete states.

  To configure an S-Function block as a state owner block, exactly one data type work vector must be declared as discrete state vector using ssSetDWorkUsedAsDState and named using ssSetDWorkName or ssSetDWorkRTWIdentifier in mdlInitializeSizes.

Ports

Output

Out — State value

scalar | vector

State value read from a state owner block.

The dimension of the output is the dimension of the full state vector. Refer to the Initial conditions parameter for specific blocks. For example, for a Delay block with a Delay length of N, the State Reader block returns a state vector of length [1xN].

Data Types: single | double | int8 | int16 | int32 | uint8 | uint16 | uint32 | fixed point

Parameters

State owner block — Show the state owner block

none (default)

Show the state owner block whose state this block is reading. To change the state owner block, select a block from the State Owner Selector Tree.

Programmatic Use

Block Parameter: StateOwnerBlock

Type: character vector

Value: '' | '<model path/block name>'

Default: ''

Model Examples

Working with the Initialize Function, Reset Function, and Terminate Function Blocks

Use the Initialize Function, Reset Function, and Terminate Function blocks to read and write states in a Simulink model.

Open Model

Reading and Writing States with the Initialize Function and Terminate Function Blocks

In this example, the Initialize Function block uses the State Writer block to set the initial condition of a Discrete Integrator block to 10.

Open Model

Block Characteristics

Data Types	Boolean | bus | double | enumerated | fixed point | integer | single
Direct Feedthrough	no
Multidimensional Signals	yes
Variable-Size Signals	no
Zero-Crossing Detection	no

Extended Capabilities

C/C++ Code Generation
Generate C and C++ code using Simulink® Coder™.

Fixed-Point Conversion
Design and simulate fixed-point systems using Fixed-Point Designer™.