Engee documentation

Out1

Page in progress.

Subsystem output port or data output from the model.

outport1

Description

Unit Out1 Transmits signals from the system to a destination outside the system. It can connect signals from the subsystem to other parts of the model. It can also output output data at the top level of the model.

Port numbers are assigned automatically according to these rules:

  • Blocks Out1 blocks in a higher-level system or subsystem are numbered sequentially starting with 1.

  • If you add a block *Out1*it is assigned the next available number.

  • If you copy a block Out1 into the system, its port number does not change unless its current port number conflicts with an input port that already exists in the system.

Blocks Out1 in a subsystem

Blocks Out1 in a subsystem represent the output signals from the subsystem. A signal entering a block Out1 in a subsystem goes from the corresponding output port in that block Subsystem.

Ports

Input

# Out_1 — input signal
scalar | vector | matrix | bus

Details

An input signal that is fed through Out1 the outside of the subsystem or model.

Data types

Float16, Float32, Float64, Int8, Int16, Int32, Int64, UInt8, UInt16, UInt32, UInt64, Bool, bus.

Complex numbers support

Yes

Parameters

Main

# Sample Time — interval between calculation steps
SampleTime (real number / vector of two real numbers)

Details

The interval between calculation steps (non-negative number). To inherit a calculation step, set this parameter to -1.

Default value

-1

Program usage name

SampleTime

Tunable

No

Evaluatable

Yes

# Initial output — initial output for conditionally executed subsystems
Scalar / array of real and/or complex numbers

Details

For conditionally executed subsystems, specify the block output before the subsystem is executed and while the subsystem is disabled.

Hint

If the conditional subsystem controls a block Merge, you do not need to specify an initial condition (IC) for the block Out1.

Limitations.

  • This block does not allow initial output of inf or NaN.

  • When the input signal is a virtual bus, the value Initial output in [] is treated as double(0).

  • When the input signal contains a non-virtual bus, Initial output does not support non-zero scalar values.

Default value

0.0

Program usage name

InitialOutput

Tunable

No

Evaluatable

Yes

# Output Concatenation — selecting the measurement to be merged
Logical

Details

Select this check box to specify a dimension for merging (only for subsystems For Each). Checking this box adds parameters from the Subsystem For Each section to the block settings menu Out1.

Default value

false (switched off)

Program usage name

OutputConcatenation

Tunable

No

Evaluatable

No

# Concatenation Dimension — specify the measurement
Int64 integer

Details

For each output port, specify the dimension by which the results of the For Each Subsystem block will be combined.

  • 1 - concatenate the results in the direction , i.e. vertically. If the block generates column vectors, the concatenation results in a single column vector. If the block generates row vectors, the concatenation results in a matrix.

  • 2 - stack the results in the direction of , that is, horizontally. If the block generates row vectors, the concatenation results in a single row vector. If the block generates row vectors, the concatenation results in a matrix.

  • n - stacking the results in the direction .

Dependencies

To use this parameters, tick the checkbox Output Concatenation.

Default value

1

Program usage name

OutputConcatenationDimension

Tunable

No

Evaluatable

Yes

# Output when disabled — shutdown output

Details

Output when the subsystem to be activated is switched off.

Default value

false (switched off)

Program usage name

OutputWhenDisabled

Tunable

No

Evaluatable

No

# Enabled State — output settings when the activated subsystem is switched off
held | reset

Details

Specify what happens to the block output when the subsystem is disabled. Select `held`to specify that the output is held when the subsystem is disabled. Select `reset`to specify that the output is reset to the value set by the subsystem when the subsystem is disabled. *Initial output*when the subsystem is disabled.

Dependencies

To use this parameter, select the check box Output when disabled

When connecting the conditional subsystem output to the Merge block, set this parameter to held. Setting it to reset returns an error.

Values

held | reset

Default value

held

Program usage name

EnabledState

Tunable

No

Evaluatable

No

Signal Attributes

# Output data type — output data type
Inherit: auto | Float64 | Float32 | Float16 | Int8 | UInt8 | Int16 | UInt16 | Int32 | UInt32 | Int64 | UInt64 | Int128 | UInt128 | Bool | Fixed-point

Details

Specify the type of output data.

The type can be inherited or specified directly.

Values

Inherit: auto | Float64 | Float32 | Float16 | Int8 | UInt8 | Int16 | UInt16 | Int32 | UInt32 | Int64 | UInt64 | Int128 | UInt128 | Bool | Fixed-point

Default value

Inherit: auto

Program usage name

OutDataTypeStr

Tunable

No

Evaluatable

No

# Output fixed-point type — fixed-point output data type
Data type

Details

Specify the fixed-point output type.

Dependencies

To use this parameter, set parameter Output data type value Fixed-point.

Default value

fixdt(1, 16, 0)

Program usage name

OutDataTypeStrFixed

Tunable

No

Evaluatable

Yes

# Signal type — output signal type
auto | real | complex

Details

Specify the output signal type. To inherit the type of signal connected to its input, select auto. Otherwise, select real or complex signal type.

Values

auto | real | complex

Default value

auto

Program usage name

SignalType

Tunable

No

Evaluatable

No

Additional options

C code generation: Yes

Examples