Engee documentation

Signal Specification

Specifies the desired magnitude, sampling time, data type, numeric type, and other signal attributes.

signal specification

Description

The Signal Specification block allows you to set the attributes of the signal connected to its input and output ports.

If the specified attributes conflict with the attributes specified by the blocks connected to its ports, Engee generates an error when compiling the model. For example, at the beginning of the simulation, if there are no conflicts, the solver removes the Signal Specification block from the compiled model.

You can use the Signal Specification block to ensure that the actual signal attributes match the desired attributes. You can also use it to ensure that the signal attributes are correctly propagated throughout the model. However, if some blocks have undefined attributes for the signals they receive or output, the model does not have enough information to correctly propagate the attributes. In such cases, the Signal Specification block can provide the necessary information.

Usage of the Signal Specification block also helps speed up model compilation when blocks do not have signal attributes.

Ports

Input

Port_1 - input signal
scalar | vector | matrix | array

Input signal as a scalar, vector, matrix or N-dimensional array.

Data types: Float16, Float32, Float64, Int8, Int16, Int32, Int64, Int128, UInt8, UInt16, UInt32, UInt64, UInt128, Bool, Fixed.

Output

Port_1 - output signal
scalar | vector | matrix | array

Transformed input signal in the form of scalar, vector, matrix or N-dimensional array, attributes of which are defined by the user.

Data types: Float16, Float32, Float64, Int8, Int16, Int32, Int64, Int128, UInt8, UInt16, UInt32, UInt64, UInt128, Bool, Fixed.

Parameters

Data type - output data type
Inherit: auto (by default) | Float16 | Float32 | Float64 | Int8 | Int16 | Int32 | Int64 | Int128 | UInt8 | UInt16 | UInt32 | UInt64 | UInt128 | Bool | Fixed

Required output data type. If the input data type does not match the specified value, the block generates an error.

Table 1. Usage in program code

Block parameter

OutDataTypeStr

Type

character vector

Value

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

* By default*

Inherit: auto

Dimensions (-1 for inherited) - values of input and output signals
-1 (by default) | (n,) | (m,n)

Parameters sets the values of input and output signals.

The value () of the parameters indicates a scalar value.

The -1 value of the parameters indicates that the signals inherit dimensions.

The (n,) value of the parameters indicates a vector of width n.

The value (m,n) of the parameters specifies a matrix with m rows and n columns.

Usage in program code

Block parameter

Dimensions

Type

character vector

Values

-1, (n,), (m,n)

By default

-1

Sample time (-1 for inherited) - time interval between samples
-1 (by default) | scalar | vector

Set the time interval between samples. To fix the sampling time, set this parameter to -1.

Usage in program code

Block parameter

SampleTime

Type

character vector

Values

any real number

* By default*

-1

Signal type - signal complexity
auto (by default) | real | `complex

Select the complexity of input and output signals.

auto - inherit the complexity from the input.

real - real signal is expected.

complex - complex signal is expected.

Usage in program code

Block parameter

SignalType

Type

Signal vector

Values

auto, real, complex

By default

auto