mdlSetOutputPortDimensionInfo - Set the dimensions of the signals accepted by an output port

Required

No

C Syntax

#define MDL_SET_OUTPUT_PORT_DIMENSION_INFO

void mdlSetOutputPortDimensionInfo(SimStruct *S, int_T port,
  const DimsInfo_T *dimsInfo)

C Arguments

S

SimStruct representing an S-Function block.

port

Index of a port.

dimsInfo

Structure that specifies the signal dimensions supported by port.

See ssSetInputPortDimensionInfo for a description of this structure.

MATLAB Syntax

SetOutputPortDimensions(s, port, dimsInfo)

MATLAB Arguments

s

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

port

Integer value specifying the index of the port to be set.

dimsInfo

Array that specifies the signal dimensions supported by the port, e.g., [5] for a 5-element vector signal or [3 3] for a 3-by-3 matrix signal.

Description

The Simulink engine calls this method with candidate dimensions dimsInfo for port. In C MEX S-functions, if the proposed dimensions are acceptable, the method sets the actual port dimensions, using ssSetOutputPortDimensionInfo. If they are unacceptable, the method generates an error via ssSetErrorStatus. This method is only valid for simulation. C MEX S-functions must enclose the method in a #if defined(MATLAB_MEX_FILE) statement.

A Level-2 MATLAB S-function sets the output port dimensions using the line

s.OutputPort(port).Dimensions = dimsInfo;

Note   This method can set the dimensions of any other input or output port whose dimensions derive from the dimensions of port.

By default, the engine calls this method only if it can fully determine the dimensionality of port from the port to which it is connected. In C MEX S-functions, if the engine cannot completely determine the dimensionality from port connectivity, it invokes mdlSetDefaultPortDimensionInfo. If an S-function can fully determine the port dimensionality from partial information, set the option SS_OPTION_ALLOW_PARTIAL_DIMENSIONS_CALL in mdlInitializeSizes, using ssSetOptions. If this option is set, the engine invokes mdlSetOutputPortDimensionInfo even if it can only partially determine the dimensionality of the output port from connectivity.

The engine calls this method until all output ports with inherited dimensions have their dimensions specified.

Example

See sfun_matadd.c for an example of how to use this function.

Languages

C, C++, MATLAB

See Also

ssSetErrorStatus, ssSetOutputPortDimensionInfo

© 1984-2012- The MathWorks, Inc.    -   Site Help   -   Patents   -   Trademarks   -   Privacy Policy   -   Preventing Piracy   -   RSS