Argument Outport

Argument output port for Simulink Function block

expand all in page
  • Library:

  • User-Defined Functions

  • Argument Outport block

Description

This block is an output argument port for a function that you define in the Simulink Function block.

Ports

Input

expand all

Block input signal to this block.

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

Output

expand all

The Argument Outport block accepts real or complex signals of any data type that Simulink® supports. An Argument Outport block can also accept fixed-point and enumerated data types when the block is not a root-level output port. The Argument Outport block also accepts a bus object as a data type.

The complexity and data type of the block input are the same as the argument output. You can specify the signal type and data type of an output argument from an Argument Outport block using the Signal type and Data type parameters. For more information, see Data Types Supported by Simulink.

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

Parameters

expand all

Specify the order in which the port that corresponds to the block appears in the parent subsystem or model block.

1

Specify the first port location for this block.

integer

Specify location of port.

Programmatic Use

Block parameter: Port
Type: character vector
Value: '1' | '<integer>'
Default: '1'

Specify output argument name for the function prototype displayed on the face of the Simulink Function block.

u

Default name of the output argument.

character vector

Name of the output argument.

Programmatic Use

Block parameter: ArgumentName
Type: character vector
Value: 'u' | '<character vector>'
Default: 'u'

Specify the minimum value for the block input signal.

Note

If you specify a bus object as the data type for this block, do not set the minimum value for bus data on the block. Simulink ignores this setting. Instead, set the minimum values for bus elements of the bus object specified as the data type. For information on the Minimum property of a bus element, see Simulink.BusElement.

Simulink uses this value to perform Simulation range checking (see Specify Signal Ranges) and automatic scaling of fixed-point data types.

[]

Minimum value not specified.

number

Finite real double scalar value.

Programmatic Use

Block parameter: OutMin
Type: character vector
Value: '[]' | '<number>'
Default: '[]'

Specify the maximum value for the block input signal.

Note

If you specify a bus object as the data type for this block, do not set the maximum value for bus data on the block. Simulink ignores this setting. Instead, set the maximum values for bus elements of the bus object specified as the data type. For information on the Maximum property of a bus element, see Simulink.BusElement.

Simulink uses this value to perform Simulation range checking (see Specify Signal Ranges) and automatic scaling of fixed-point data types.

[]

Max mum value not specified.

number

Finite real double scalar value.

Programmatic Use

Block parameter: OutMax
Type: character vector
Value: '[]' | '<number>'
Default: '[]'

Specify block input data type. For more information, see

double

Data type is double.

single

Data type is single.

int8

Data type is int8.

uint8

Data type is uint8.

int16

Data type is int16.

uint16

Data type is uint16.

int32

Data type is int32.

uint32

Data type is uint32.

int6a4

Data type is int64.

uint64

Data type is uint64.

boolean

Data type is boolean.

fixdt(1,16,0)

Data type is fixed point fixdt(1,16,0).

fixdt(1,16,2^0,0)

Data type is fixed point fixdt(1,16,2^0,0).

Enum: <class name>

Data type is enumerated, for example, Enum: Basic Colors.

Bus: <object name>

Data type is a Simulink.Bus object.

<data type expression>

The name of a data type object, for example Simulink.NumericType

Tips

You cannot enter the name of a Simulink.Bus object as a data type expression. To specify the Data type for the block using a Bus object, select the Bus: <object name> option and replace <object name> with the name of the Bus object.

Programmatic Use

Block parameter: OutDataTypeStr
Type: character vector
Value: 'double' | 'single' | 'int8' | 'uint8' | 'int16' | 'uint16' | 'int32' | 'uint32' | 'int64' | 'uint64'| 'boolean' | '<fixdt(1,16)' | 'fixdt(1,16,0)' | 'fixdt(1,16,2^0,0)' | '<data type expression>'
Default: 'double'

Control changes to data type settings from the Fixed-Point Tool and the Fixed-Point Advisor. For more information, see Use Lock Output Data Type Setting (Fixed-Point Designer).

On

Locks all data type settings for this block.

Off

Allows the Fixed-Point Tool and the Fixed-Point Advisor to change data type settings for this block.

Programmatic Use

Block parameter: LockScale
Type: character vector
Value: 'off' | 'on'
Default: 'off'

Specify the dimensions of the output argument signal from the block. For more information, see Outport.

1

Inherit port dimensions.

n

Vector signal of width n.

[m n]

Matrix signal having m rows and n columns.

Programmatic Use

Block parameter: PortDimensions
Type: character vector
Value: '1' | 'n' | '[m n]'
Default: '1'

Select real or complex signal. For more information, see Outport.

real

Specify the signal type as a real number.

complex

Specify the signal type as a complex number.

Programmatic Use

Block parameter: SignalType
Type: character vector
Value: 'real' | 'complex'
Default: 'real'

Model Examples

Monitoring Ink Status on a Shared Printer Using Simulink Functions

Monitoring Ink Status on a Shared Printer Using Simulink Functions

How clients, in this case three computers, can send jobs to a server, a printer, and receive status from that server. This example highlights how Simulink Functions can be called from different subsystems and interact both in Simulink® and Stateflow®.

Open Model
Modeling Reusable Components Using Multiply Instanced Simulink Functions

Modeling Reusable Components Using Multiply Instanced Simulink Functions

In this example, the model slexCounterFunctionMdlRef contains a Simulink Function update() which maintains a counter. Multiple instancing provides the ability to reuse this logic as CounterA and CounterB in this application model.

Open Model
Modeling Services and Access from Application Software

Modeling Services and Access from Application Software

This examples shows a typical software modeling pattern involving services and access to those services in an application.

Open Model
Dynamic Priority Scheduling of Functions

Dynamic Priority Scheduling of Functions

A common modeling pattern to dynamically schedule the execution of functions using a Stateflow chart.

Open Model

See Also

| |

Topics

Introduced in R2014b

Simulink Documentation

Support