Engee documentation

In1

The input port of a subsystem or external input.

blockType: Inport

inport1

Path in the library:

/Basic/Ports & Subsystems/In1

Description

The In1 block links signals outside the system to the system.

The software assigns port numbers to the In1 block according to these rules:

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

  • If you add a In1 block, it is added with the next available number.

  • If you copy a In1 block to the system, its port number is not renumbered unless its current number conflicts with an input port already existing on the system.

Input port blocks in subsystems

The In1 blocks in a subsystem represent inputs to the subsystem. A signal arriving at an input port in the Subsystem block exits from the linked In1 block in that subsystem.

Bus connections to root level input port blocks

If you want the In1 block of the root level of the model to create a bus, set the Data type parameters to BusSignal and in the Output bus type parameters specify the name of the bus object that defines the bus created by the In1 block.

Ports

Output

# OUT_1 — output signal
scalar | vector | matrix | bus

Details

A signal that enters the system through the input port.

You can use the In1 block in a subsystem to provide fixed-point data in a structure or any other format.

Data types

Float16, Float32, Float64, Int8, Int16, Int32, Int64, UInt8, UInt16, UInt32, UInt64, Bool, Fixed, BusSignal.
Complex numbers support

Yes

Parameters

Main

# Interpolate — possibility of linear interpolation of output data
Logical

Details

When loading data from the workspace into the Root Level Input Unit, specify whether the unit performs linear interpolation and extrapolation of output data at time steps for which no corresponding data exists.

To load individual data from the workspace, in the block dialogue box In1:

  1. Uncheck the parameters Interpolate, if active.

  2. Set the Sample time parameters to a discrete value, e.g. 2.

Specifying a discrete sample time causes the simulation to have hit times exactly when the data is sampled. You specify data values, not time values.

Disabling interpolation avoids unexpected data values at other times in the simulation as a result of double precision arithmetic.

The software uses the following interpolation and extrapolation methods:

  • For time steps between the first specified data point and the last specified data point, zero-order retention.

  • For time steps before the first specified data point and after the last specified data point, prime.

  • For variable size signals for time steps up to the first specified data point - `NaN' value is registered for single or double data types and grounded for other data types. For time steps after the last specified data point, the software uses the basic values.

Default value

false (switched off)
Program usage name

Interpolate
Tunable

No
Evaluatable

No

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

Details

Specify the interval between calculation steps as a non-negative number. To inherit a calculation step, set this parameter to -1.

Default value

-1
Program usage name

SampleTime
Tunable

No
Evaluatable

Yes

# Partition — selecting the input port signal to be split
Logical

Details

Select this check box if you want to split the signal (only for subsystems For Each). Checking this box adds parameters from For Each to the settings menu of In1.

If the checkbox is selected:

  • Select the signals of the input ports connected to the For Each block to be split into subarrays or elements.

  • For each port listed in the Port column, select the corresponding check box to split that signal.

Default value

false (switched off)
Program usage name

InputPartition
Tunable

No
Evaluatable

No

# Partition Dimension — input signal array slicing measurement
Int64 integer

Details

Specify the dimension along which the selected input signal array will be sliced. The resulting slices are perpendicular to the specified dimension. The slices divide the array into subarrays or items as appropriate:

  • Situation 1 - slicing the input array by columns.

  • Situation 2 - slicing the input array by rows.

  • Situation 3 - input array slicing by dimension.

Dependencies

To use this parameter, select the check box Partition.

Default value

1
Program usage name

InputPartitionDimension
Tunable

No
Evaluatable

Yes

# Partition Width — signal width
Int64 integer

Details

Specify the width of each section slice of the selected input signal.

Dependencies

To use this parameter, select the Partition check box.

Default value

1
Program usage name

InputPartitionWidth
Tunable

No
Evaluatable

Yes

# Partition Offset — partition offset
Int64 integer

Details

Set the offset for each partition slice of the selected input signal:

  • 0 - no offset between the partitions, i.e. the partitions have no gaps between them and do not overlap.

  • ` integer` - specify the offset of the partition, using a positive integer to specify the gap between the fragments or a negative integer to specify the overlap. The sum of the Partition Offset and Partition Width parameters must be a positive integer.

For example, Partition Width of 3 and Partition Offset of -2 means that each three-element fragment overlaps neighbouring fragments by two elements; while Partition Width of 2 and Partition Offset of 1 means that there is a one-element-wide gap between each pair of neighbouring two-element-wide fragments.

Dependencies

To use this parameter, select the Partition check box .

Default value

0
Program usage name

InputPartitionOffset
Tunable

No
Evaluatable

Yes

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 | BusSignal

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 | BusSignal
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 the Output data type parameters to Fixed-point.

Default value

fixdt(1, 16, 0)
Program usage name

OutDataTypeStrFixed
Tunable

No
Evaluatable

Yes

# Output bus type — output bus type
Data type

Details

Specify the output bus type.

For details on busbar operation, refer to Operation with user buses BusSignal in equipment blocks.

Dependencies

To use this parameter, set the parameters Output data type to . BusSignal.

Default value

BusSignal{(), Tuple{}, ()}
Program usage name

OutDataTypeStrBus
Tunable

No
Evaluatable

Yes

# Port dimensions — port dimension

Details

Specify the dimensionality of the output signal:

  • -1 - The port can load data for a signal of any dimension. The port inherits the dimension from the connected signal.

  • () - the port can load data for a scalar signal, i.e. a signal representing a single value (number).

  • (N,) - the port can load data for a signal representing a vector of dimension N.

  • (R, C) - the port can load data for a matrix signal having `R rows and `C columns.

Default value

-1
Program usage name

PortDimensions
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

Verilog generation: Yes

Examples