Engee Function

信息单元格（不可编辑）--自动显示 Engee Function 区块的变量、输入和输出信号的属性（尺寸、类型、离散度）以及用户设置的其他参数。其内容根据程序块设置动态更新。单元格始终处于激活状态，但在方法控制菜单 中无法选择。它具有半透明文本，用于显示工具提示。

Define component struct - 添加单元格 Component struct code ，其中定义了块组件 Engee Function 的结构（从 AbstractCausalComponent 类型继承）。结构字段定义在不可编辑的行 struct Block <: AbstractCausalComponent 和 end 之间。默认情况下，会创建一个 g 参数，并用 gain 块的值进行初始化，而且 Block() 构造函数不需要任何参数。

使用普通代码 - 添加单元格 Common code ，其中的代码以自由格式书写。默认情况下，单元格为空。例如，如果 Component struct code 中的标准结构声明不合适（由于不可编辑的 "struct Block <: AbstractCausalComponent"），可以禁用*Define component struct* 删除单元格，并在 Common code 中手动定义组件结构。 方法管理菜单中的任何函数也是如此—​您可以编写自己的代码来代替 Common code 中的标准单元。

Define step method - 添加单元格 Step method code ，该单元格定义了计算程序块 Engee Function 输出信号的 Step 方法。方法签名根据 Ports 标签中端口的相应标签（Label）值自动生成。该方法以函数形式表示（详见此处），并在每个仿真步骤中被调用。字段定义在不可编辑的行 function (c::Block)(t::Real, in1) 和 end 之间。t::Real "的第一个参数是模拟时间，然后输入变量。输出的计算值通过关键字 return 返回。

Define update method - 添加 Update method 代码*单元，其中的 update! 方法会在每个仿真步骤更新块 *Engee Function 的内部状态。第一个参数 c::Block 是程序块结构，第二个参数 t::Real 是模拟时间，然后传递输入信号。如果程序块没有内部状态，该方法可以保持为空，只返回 c。

定义终止方法代码 - 添加*终止方法代码*单元，当块 Engee Function 的模拟终止时（使用`terminate!方法），该单元将被执行。c::Block 的第一个参数是程序块的结构。默认情况下，该方法不会执行任何其他操作，只会返回 c。

覆盖类型继承方法 - 添加覆盖类型继承方法的*类型继承方法*单元格。

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

覆盖尺寸继承方法 - 添加*尺寸继承方法*单元，覆盖尺寸继承方法。

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 - 添加 Common types and dimensions inheritance method 单元，使用通用方法同时覆盖类型和维度的继承。

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

覆盖样本时间继承方法 - 添加*样本时间继承方法*单元格，覆盖计算步骤继承方法。

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

覆盖直接穿通设置方法 - 添加一个*直接穿通设置方法*单元，用于定义直接穿通连接。

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 - 块的名称。添加到 Engee 画布的每个程序块都有一个名称，可以通过此常量引用。例如，您可以在初始化错误时引用 BLOCK_NAME，以打印其中的代码块名称。

START_TIME - 模型设置中的模拟开始时间。

STOP_TIME` - 模型设定的模拟结束时间。

INPUT_SIGNAL_ATTRIBUTES - 每个输入端口的属性列表。例如，要查找第一个输入信号的属性，请使用 INPUT_SIGNAL_ATTRIBUTES[1]，其中 1 是模块 Engee Function 的第一个输入端口。

OUTPUT_SIGNAL_ATTRIBUTES` - 列出每个输出端口的属性。例如，要查找第一个输出端口的属性，请使用 OUTPUT_SIGNAL_ATTRIBUTES[1] ，其中 1 是程序块的第一个输出端口 Engee Function 。

dimensions - 信号的维数。可缩写为 dims。

type - 信号的类型。可缩写为 tp。

sample_time - 计算步骤。它表示的结构类似于信号的属性，可以通过. 点访问。有两个访问函数可用：

direct_feedthrough - 指示循环端口是否打开。仅用于输入端口（仅检查输入端口的属性）。可缩写为 df。

FixedPoint` - 所有定点数的抽象类型；

Fixed` - 固定数的具体类型，使用位表示法手动创建；

fi(…​)`-使用数值和表示参数创建`Fixed`类型的值；

fixdt(…​) - 创建固定类型，并指定符号、宽度和小数位数。

作为参数传递；

在组件结构中使用它们（*组件结构代码*单元）；

在*步骤方法代码*单元格中通过`emul`、esum、`ediv`对它们进行运算（更多详情请参见章节 转换函数和类型化算术运算：econvert`、esum、emul、ediv。);

应用于 propagate_types(…​)、 `propagate_dimensions(…​)`中的计算。

总线信号{...}` - 包含名称、类型和尺寸的总线类型；

get_bus_names(type) - 获取信号名称列表；

get_bus_types(type) - 获取信号类型；

get_bus_dimensions(type) - 获取信号尺寸；

get_names_types_dims(type) - 一次获取所有信号；

get_bus_signal_type(::NamedTuple) - 用值定义 BusSignal 类型。

在程序块参数中 - 可以通过 fi(…​)`指定定点值，总线结构可以作为 `NamedTuple 传递。总线类型可通过 `get_bus_signal_type(…​)`自动定义。

在 Common code 单元中，您可以定义数据类型（Fixed, BusSignal{…​}）、组件结构（struct Block）、创建辅助函数或初始化值。如果*步骤方法代码*或*组件结构代码*被禁用，还可以将基本逻辑移至此处。

在 Component struct code 单元中，在描述结构的字段时，可以使用 Fixed 类型的值，如果字段表示复合信号，也可以使用 BusSignal 类型的值。

在*步骤方法代码*单元中—​执行程序块的基本逻辑。在这里，固定数字和总线信号可以参与计算、比较和结构处理。

在*类型继承方法*单元中—​可以使用 "固定 "和 "总线信号 "类型来分析输入并设置组件的输出类型。

在 Dimensions inheritance method 单元中，您可以使用来自总线的 Fixed 数据和值来定义输出尺寸。

在*更新方法代码*单元中—​如果程序块有内部状态，可使用`Fixed`或`BusSignal`等字段在每个模拟步骤中存储或更改该状态。

在*终止方法代码*单元中—​如果结构包含相应字段，则允许使用这些类型记录最终状态。

在*常用类型和维数继承方法*单元中—​如果要同时处理两种类型和维数，`Fixed`和`BusSignal`也可以参与计算逻辑。

实型：Float16"、"Float32"、"Float64"。

整数Int8`、Int16`、Int32`、Int64`、Int128`、UInt8`、UInt16`、UInt32`、UInt64`、UInt128`。

逻辑: Bool.

固定的Fixed`（通过 fi(…​) 或 fixdt(…​) 创建）

复数： Complex{T}，其中 T 是上述任何类型

type 是将数值转换成的类型。如果 var 是复数，则指定基实数类型。例如，econvert(Float32, Complex{Int16}(1 + 2im))`将返回`Complex{Float32}；

var - 要转换的值；

rounding_mode - 舍入方法（RoundDown, RoundUp, RoundNearest, RoundNearestTiesAway, RoundToZero）；

overflow - 如果为 true，则使用换行；如果为 false，则启用饱和 - 值受类型范围限制。 econvert 函数可用于比较前的类型转换、算术表达式内的类型转换、在条件中处理信号时的类型转换以及其他情况。

x1, x2 - 运算的参数（可以是标量或数组）；

out_type - 生成和返回结果的类型；

overflow - 启用溢出（true）或饱和（false）；

rm - 舍入方法（请参阅上面的列表）。

确定添加相同类型 T 的 n 值时的输出类型：

sum_promote_type(::Type{T}, n::Integer=1, hdlsetup::Bool=false)

确定两个不同类型 T1 和 T2 的 n 值相加时的输出类型：

sum_promote_type(::Type{T1}, ::Type{T2}, n::Integer=1, hdlsetup::Bool=false)

定义添加任意多个不同类型参数时的输出类型：

sum_promote_type_from_inputs(types::Type...; hdlsetup::Bool=false)

确定累加器在累加相同类型 T 的 n 值时的类型：

sum_accumulator_promote_type(::Type{T}, n::Integer=1, hdlsetup::Bool=false)

确定两个不同类型的 T1 和 T2 值相加时累加器的类型：

sum_accumulator_promote_type(::Type{T1}, ::Type{T2}, n::Integer=1, hdlsetup::Bool=false)

确定任意多个不同类型参数相加时的累加器类型：

sum_accumulator_promote_type_from_inputs(types::Type...; hdlsetup::Bool=false)

确定相同类型 T 数值相乘时的输出类型：

mul_promote_type(::Type{T}, hdlsetup::Bool=false)

定义两个不同类型 T1 和 T2 相乘时的输出类型：

mul_promote_type(::Type{T1}, ::Type{T2}, hdlsetup::Bool=false)

确定除以 T 类型的单个值时的输出类型：

div_promote_type(::Type{T}, hdlsetup::Bool=false)

确定 T1 类型的值除以 T2 类型的值时的输出类型：

div_promote_type(::Type{T1}, ::Type{T2}, hdlsetup::Bool=false)

将输入数据转换为具有覆盖输出参数的向量；

使用缓存和严格类型化结构来提高性能；

实现直接无穿通块，打破代数循环；

自定义输出采样周期。

*端口：%<Inputs>, %<Outputs> - 输入和输出端口的数量； %<InputPort1Type>, %<OutputPort1Type>, %<InputPort1Size>, %<OutputPort1Size> - 数据类型和信号维度。

*时间特性：%<SampleTime> - 离散化； %<SampleTimeInheritanceMethod> - 离散化继承方法。

*代码块：%<ComponentStructCode>, %<StepMethodCode> - 步骤结构和方法代码。

参数：%<Parameters>, %<Parameter1Name>, %<Parameter1Value> - 参数名称和值。

Inclusion flags：%<DefineComponentStruct>, %<UseCommonCode>, %<DefineStepMethod>, %<DefineUpdateMethod>, %<DefineTerminateMethod> - 包含相应的代码部分。

*参考方法：%<OverrideTypesInhMethod>、%<OverrideDimsInhMethod>、%<OverrideSampleTimeInhMethod> - 类型继承设置。

其他：%<UseExternalCache> - 使用外部缓存。