Signal Specification
Specifies the desired magnitude, sampling time, data type, numeric type, and other signal attributes.
blockType: SignalSpecification
Path in the library:
|
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 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
#
IN
—
input signal
scalar
| vector
| matrix
| array
Details
An input signal specified as a scalar, vector, matrix or N-dimensional array.
Data types |
|
Complex numbers support |
Yes |
Output
#
OUT
—
output signal
scalar
| vector
| matrix
| array
Details
A transformed input signal as a scalar, vector, matrix or N-dimensional array whose attributes are defined by the user.
Data types |
|
Complex numbers support |
Yes |
Parameters
Main
#
Data type —
output data type
Inherit: auto
| Float64
| Float32
| Float16
| Int8
| UInt8
| Int16
| UInt16
| Int32
| UInt32
| Int64
| UInt64
| Int128
| UInt128
| Bool
| Fixed-point
Details
The required output data type. If the input data type does not match the specified value, the unit generates an error.
Values |
|
Default value |
|
Program usage name |
|
Tunable |
No |
Evaluatable |
No |
#
Output fixed-point type —
fixed point output type
Data type
Details
Fixed point output type.
Dependencies
To use this parameter, set the Data type parameters to Fixed-point
.
Default value |
|
Program usage name |
|
Tunable |
No |
Evaluatable |
Yes |
# Dimensions (-1 for inherited) — values of input and output signals
Details
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 value (n,)
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.
Default value |
|
Program usage name |
|
Tunable |
No |
Evaluatable |
Yes |
#
Sample time —
sampling interval
SampleTime (real number / vector of two real numbers)
Details
Set the time interval between samples. To fix the sampling time, set this parameter to -1
.
Default value |
|
Program usage name |
|
Tunable |
No |
Evaluatable |
Yes |
#
Signal type —
signal complexity
auto
| real
| complex
Details
Complexity of input and output signals. Defined as:
-
auto
- inheritance of complexity from the input. -
real` - a real signal is expected.
-
complex
- a complex signal is expected.
Values |
|
Default value |
|
Program usage name |
|
Tunable |
No |
Evaluatable |
No |