SetInputPortComplexSignal

Set the numeric types (real, complex, or inherited) of the signals accepted by an input port

Required

No

Language

MATLAB^®

Syntax

SetInputPortComplexSignal(s, port, csig)

Arguments

s

Instance of Simulink.MSFcnRunTimeBlock class representing the Level-2 MATLAB S-Function block.

port

Integer value specifying index of port to be set.

csig

Integer value specifying whether the port accepts real (false or 0) or complex (true or 1) signals.

Description

The Simulink^® engine calls this routine to set the input port numeric type for inputs that have this attribute set to COMPLEX_INHERITED. The input csig is the proposed numeric type for this input port. This method is only valid for simulation.

The S-function must check whether the proposed numeric type is a valid type for the specified port. If it is valid, level-2 MATLAB S-functions set the numeric type of the specified input port using the line:

s.InputPort(port).Complexity = csig;

The S-function can also set the numeric types of other input and output ports with inherited numeric types. The engine reports an error if the S-function changes the numeric type of a port whose numeric type is known.

If the S-function does not implement this routine, the engine assumes that the S-function accepts a real or complex signal and sets the input port numeric type to the specified value.

The engine calls this method until all input ports with inherited numeric types have their numeric types specified.