Engee Function

Information cell (non-editable) - automatically displays block variables *Engee Function*attributes of input and output signals (dimension, type, discreteness) and other parameters set by the user. Its content is updated dynamically depending on the block settings. The cell is always active, but is not selectable in the method control menu . It has semi-transparent text, which is used to display tooltips.

Define component struct - adds the cell Component struct code*which specifies the structure of the block component *Engee Function (inherited from AbstractCausalComponent type). The structure fields are defined between the uneditable lines struct Block <: AbstractCausalComponent and end. By default, a parameter g is created and initialised with the block value gain, and the Block() constructor takes no arguments.

Use common code - adds a cell Common code*in which the code is written in free form. By default the cell is empty. For example, if the standard structure declaration in *Component struct code is not suitable (because of the uneditable struct Block <: AbstractCausalComponent), you can disable Define component struct to remove the cell, and define the component structure manually in the Common code. The same goes for any functions from the method control menu - instead of standard cells, you can write your own code in . Common code.

Define step method - adds a cell Step method code*which defines the Step method that calculates output signals of the block *Engee Function. The method signature is generated automatically depending on the values of the corresponding labels of ports in the Ports tab. The method is represented as a functor (see here for details) and is called at each simulation step. The fields are defined between the uneditable strings function (c::Block)(t::Real, in1) and end. The first argument of t::Real is the simulation time, then the input variables are passed in. The calculated values of the outputs are returned via the return keyword.

Define update method - adds a Update method code cell, in which the update! method updates the internal state of the block Engee Function at each step of the simulation. The first argument c::Block is the block structure, the second t::Real is the simulation time, then the input signals are passed. If the block has no internal state, the method can remain empty and just return c.

Define terminate method code - adds a Terminate method code cell that is executed when the block simulation is terminated Engee Function (using the terminate! method). The first argument of c::Block is the structure of the block. By default, the method does not perform any additional actions and simply returns c.

Override type inheritance method - adds a Types inheritance method cell that overrides the type inheritance method.

function propagate_types(inputs_types::Vector{DataType})::Vector{DataType}
# Функция, возвращающая массив типов сигналов на выходе.
# Игнорируется, если используется алгоритм по умолчанию.
# В данном случае учитываются тип входного сигнала и тип
# параметра блока `gain`.
    input_type = first(inputs_types)
    # promote_type возвращает тип, к которому приводятся типы-аргументы
    # при арифметических операциях с объектами этих типов.
    output_type = promote_type(input_type, eltype(gain))
    return [output_type]
end

Override dimensions inheritance method - adds the Dimensions inheritance method cell, which overrides the method of dimensions inheritance.

function propagate_dimensions(inputs_dimensions::Vector{<:Dimensions})::Vector{<:Dimensions}
# Функция, возвращающая массив размерностей сигналов на выходе.
# Игнорируется, если используется алгоритм по умолчанию.
# В данном случае учитываются размерности входного сигнала и
# параметра блока `gain`.
    input_dimensions = first(inputs_dimensions)
    mock_input = zeros(input_dimensions)
    mock_output = mock_input .* gain
    return [size(mock_output)]
end

Use common method for types and dimensions inheritance - adds the Common types and dimensions inheritance method cell, which uses a common method to override inheritance of types and dimensions at the same time.

function propagate_types_and_dimensions(inputs_types::Vector{DataType}, inputs_dimensions::Vector{<:Dimensions})::Tuple{Vector{DataType}, Vector{<:Dimensions}}
# Функция, возвращающая массив типов сигналов и массив
# размерностей сигналов на выходе. Эту функцию можно использовать
# если необходимо одновременно переопределить и алгоритм наследования
# типов сигналов, и алгоритм наследования размерностей.
    outputs_types = propagate_types(inputs_types)
    outputs_dimensions = propagate_dimensions(inputs_dimensions)
    return outputs_types, outputs_dimensions
end

Override sample time inheritance method - adds a Sample times inheritance method cell that overrides the calculation step inheritance method.

function propagate_sample_times(inputs_sample_times::Vector{SampleTime}, fixed_solver::Bool)::SampleTime
# Функция, возвращающая время дискретизации блока.
# Используется только в режиме наследования `Custom`.
# Параметр fixed_solver говорит о том, используется решатель
# с постоянным шагом (true) или с переменным (false).
# Более сложный пример работы с наследованием времени
# дискретизации блока можно посмотреть в документации.
    return first(inputs_sample_times)
end

const SampleTime = NamedTuple{(:period, :offset, :mode), Tuple{Rational{Int64}, Rational{Int64}, Symbol}}

Override direct feedthrough setting method - adds a Direct feedthrough setting method cell that defines a direct feedthrough connection.

function direct_feedthroughs()::Vector{Bool}
# Функция, возвращающая массив булевых значений, определяющих,
# сквозные соединения. Если i-ый элемент массива равен true,
# то i-ый порт имеет сквозное соединение.
# Игнорируется, если используется алгоритм по умолчанию.
    return [true]
end

function direct_feedthroughs()::Vector{Bool}
    if gain == 2
        return [false]
    else
        return [true]
    end
end

BLOCK_NAME - the name of the block. Each block added to the Engee canvas has a name that can be referenced via this constant. For example, you can refer to BLOCK_NAME during error initialisation to print the block name in it.

START_TIME - the start of the simulation from the model settings.

END_TIME - end of the simulation from the model settings.

INPUT_SIGNAL_ATTRIBUTES - lists of attributes for each input port. For example, to find out the attributes of the first input signal - use INPUT_SIGNAL_ATTRIBUTES[1], where 1 is the first input port of the block Engee Function.

OUTPUT_SIGNAL_ATTRIBUTES - lists from attributes for each output port. For example, to find out the attributes of the first output - use OUTPUT_SIGNAL_ATTRIBUTES[1], where 1 is the first output port of the block Engee Function.

dimensions - the dimensionality of the signal. It can be abbreviated to dims.

type - signal type. Can be abbreviated to tp.

sample_time - calculation step. It represents a structure similar to the attributes of signals, which can be accessed through the point .. Two access functions are available:

direct_feedthrough - specifies whether the loop port opens. Used for input ports only (checks attributes for the input port only). Can be abbreviated to df.

*Ports: %<Inputs>, %<Outputs> - number of input and output ports; %<InputPort1Type>, %<OutputPort1Type>, %<InputPort1Size>, %<OutputPort1Size> - data type and dimensionality of signals.

*Temporal characteristics: %<SampleTime> - discretisation; %<SampleTimeInheritanceMethod> - discretisation inheritance method.

*Code blocks: %<ComponentStructCode>, %<StepMethodCode> - step structure and method code.

Parameters: %<Parameters>, %<Parameter1Name>, %<Parameter1Value> - names and values of parameters.

Inclusion flags: %<DefineComponentStruct>, %<UseCommonCode>, %<DefineStepMethod>, %<DefineUpdateMethod>, %<DefineTerminateMethod> - inclusion of corresponding code sections.

*Reference methods: %<OverrideTypesInhMethod>, %<OverrideDimsInhMethod>, %<OverrideSampleTimeInhMethod> - type inheritance settings.

Other: %<UseExternalCache> - usage of external cache.