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 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
#
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 —
type of output data
Inherit: auto | Float64 | Float32 | Float16 | Int8 | UInt8 | Int16 | UInt16 | Int32 | UInt32 | Int64 | UInt64 | Int128 | UInt128 | Bool | Fixed-point | BusSignal
Details
The type of output data. If the input data type does not match the specified value, the block returns an error.
| Values |
|
| Default value |
|
| Program usage name |
|
| Tunable |
No |
| Evaluatable |
No |
#
Output fixed-point type —
the type of fixed-point output
Data type
Details
The type of fixed-point output.
Dependencies
To use this parameter, specify for the parameter Data type meaning Fixed-point.
| Default value |
|
| Program usage name |
|
| Tunable |
No |
| Evaluatable |
Yes |
#
Output bus type —
type of output bus
Data type
Details
Describes the type of bus that the unit outputs.
You can set the type yourself or enter the name of a variable that stores a type that has already been created in the workspace.
Dependencies
To use this parameter, set for the parameter Data type meaning BusSignal.
| Default value |
|
| Program usage name |
|
| Tunable |
No |
| Evaluatable |
Yes |
# Dimensions (-1 for inherited) — values of input and output signals
Details
The parameter sets the values of the input and output signals.
Meaning () The parameter indicates a scalar value.
Meaning -1 The parameter indicates that the signals inherit the dimensions.
Meaning (n,) The parameter specifies a vector of width n.
Meaning (m,n) The parameter specifies a matrix with m rows and n columns.
| Default value |
|
| Program usage name |
|
| Tunable |
No |
| Evaluatable |
Yes |
#
Sample time —
the interval between the calculation steps
SampleTime (real number / vector of two real numbers)
Details
Specify the interval between the calculation steps as a non-negative number. To inherit the calculation step, set this parameter to -1.
| Default value |
|
| Program usage name |
|
| Tunable |
No |
| Evaluatable |
Yes |
#
Signal type —
signal complexity
auto | real | complex
Details
The complexity of the input and output signals. Set as:
-
auto– inheritance of complexity from the input. -
real– a physical signal is expected. -
complex– a complex signal is expected.
| Values |
|
| Default value |
|
| Program usage name |
|
| Tunable |
No |
| Evaluatable |
No |