⟨/⟩ Nts/50_Domain/VehicleCalc.cs

326 строк · в начало

using System;
using Rugrid.Sdaid.Notation.Documents;

namespace Rugrid.Sdaid.Epas.Nts.Domain
{
    /// <summary>
    /// Расчёт нормативного расхода топлива транспортного средства. Отдельная сущность: `Vehicle`
    /// хранит данные АИС и данные форм модуля, а расчёт хранит результаты
    /// расчёта, статус расчёта и журнал. Собственных входных параметров у расчёта нет — вход собирается
    /// из `Vehicle` по методике. Расчёт по ТС — один (текущий).
    /// </summary>
    public class DOC_VehicleCalc : IDomainEntityDocument, IHasStructuralLinks, IFolder<NtsDomainFolder>
    {
        public SdaidLink[] Links => new[]
        {
            Rel.Uses<DOC_Vehicle>(),
            Rel.Uses<DOC_CalculationStatus>(),
            Rel.Uses<DOC_NtsModificationSelectionStatus>(),
            Rel.Uses<DOC_NtsSelectionMethod>(),
            Rel.Uses<DOC_SelectedModifications>(),
            Rel.Uses<DOC_ProcessingStatus>(),
            Rel.Uses<DOC_NtsAisLoadStatus>(),
        };

        public static string _refName = "Расчёт ТС";

        public string Name => "Расчёт ТС";

        public string Description =>
            @"Расчёт нормативного расхода топлива транспортного средства: результаты расчёта, статус расчёта и журнал.";

        public string Version => "0.1";
        public string Status => "draft";
        public string[] Comments => new string[0];

        public Type Entity => typeof(VehicleCalc);

        public static string Purpose = $""""
## Назначение

Расчёт ведётся по методике {SdaidAnchors.RefTo<Rugrid.Sdaid.Epas.Nts.Backend.Calc.DOC_NtsCalc>()}.
Вход собирается из {SdaidAnchors.RefTo<DOC_Vehicle>()} — характеристик ТС
из АИС и данных, введённых в модуле; собственных входных параметров расчёт не хранит.
Здесь лежат результаты расчёта, статус расчёта, журнал, статус загрузки данных из АИС и итоговый
статус обработки ТС — вся эта сущность описывает процесс обработки ТС, а не само ТС.

Отдельная сущность выбрана потому, что {SdaidAnchors.RefTo<DOC_Vehicle>()} содержит и данные
АИС, и данные модуля; импорт обновляет только поля АИС. Результаты, статус расчёта и журнал —
собственность модуля, импорт их не трогает.
"""";
    }

    /// <summary>
    /// Доменная сущность «Расчёт ТС». Класс — источник структуры: таблица свойств и диаграмма
    /// связей строятся по нему. Содержит только расчётные (вычисляемые) параметры.
    /// </summary>
    [DomainEntity]
    public class VehicleCalc
    {
        /// <summary>Идентификатор записи</summary>
        [DomainField(Alias = "id", RequiredOnCreate = true, Range = "UUID", Immutable = true)]
        public Guid Id { get; set; }

        /// <summary>Транспортное средство</summary>
        [Relation]
        [DomainField(Alias = "vehicle_id", RequiredOnCreate = true, Immutable = true)]
        public Vehicle? Vehicle { get; set; }

        /// <summary>Базовая норма расхода топлива $H_s$, л/100 км</summary>
        [DomainField(Alias = "base_consumption_rate", Unit = "л/100 км", Range = "вещественное, ≥ 0",
            Calculated = "Да, `fuel.base_norm` — базовая норма H_s")]
        public decimal BaseConsumptionRate { get; set; }

        /// <summary>Минимальная базовая норма отобранной группы $H_{min}$, л/100 км</summary>
        [DomainField(Alias = "min_base_consumption_rate", Unit = "л/100 км", Range = "вещественное, ≥ 0",
            Calculated = "Да, `fuel.base_norm` — H_min")]
        public decimal MinBaseConsumptionRate { get; set; }

        /// <summary>Максимальная базовая норма отобранной группы $H_{max}$, л/100 км</summary>
        [DomainField(Alias = "max_base_consumption_rate", Unit = "л/100 км", Range = "вещественное, ≥ 0",
            Calculated = "Да, `fuel.base_norm` — H_max")]
        public decimal MaxBaseConsumptionRate { get; set; }

        /// <summary>Эталонный расход $Q_{эт}$, л</summary>
        [DomainField(Alias = "reference_norm_consumption", Unit = "л", Range = "вещественное, ≥ 0",
            Calculated = "Да, `fuel.reference_consumption` — та же ветка категории ТС, что и Q_н, со входом H_эт вместо H_s")]
        public decimal ReferenceNormConsumption { get; set; }

        /// <summary>Эталонная норма расхода топлива $H_{эт}$, л/100 км</summary>
        [DomainField(Alias = "reference_consumption_rate", Unit = "л/100 км", Range = "вещественное, ≥ 0",
            Calculated = "Да, `fuel.reference_norm` — минимум по всей базовой группе, не только отобранным")]
        public decimal ReferenceConsumptionRate { get; set; }

        /// <summary>Пробег $S$, км</summary>
        [DomainField(Alias = "mileage", Unit = "км", Range = "вещественное, ≥ 0",
            Calculated = "Да, `fuel.mileage`")]
        public decimal Mileage { get; set; }

        /// <summary>Поправочный коэффициент к норме в зимний период $D^{зима}$, %</summary>
        [DomainField(Alias = "correction_factor_winter", Unit = "%", Range = "вещественное",
            Calculated = "Да, `fuel.correction_factor_winter` — D^{зима}")]
        public decimal CorrectionFactorWinter { get; set; }

        /// <summary>Поправочный коэффициент к норме в летний период $D^{лето}$, %</summary>
        [DomainField(Alias = "correction_factor_summer", Unit = "%", Range = "вещественное",
            Calculated = "Да, `fuel.correction_factor_summer` — D^{лето}")]
        public decimal CorrectionFactorSummer { get; set; }

        /// <summary>Поправочный коэффициент при работе за пригородной зоной $D^{загор}$, %</summary>
        [DomainField(Alias = "suburb_coefficient", Unit = "%", Range = "вещественное",
            Calculated = "Да, `fuel.cf_suburb`")]
        public decimal SuburbCoefficient { get; set; }

        /// <summary>Нормативный расход в зимний период $Q^{зима}$, л</summary>
        [DomainField(Alias = "norm_consumption_winter", Unit = "л", Range = "вещественное, ≥ 0",
            Calculated = "Да, `fuel.q_winter`, `fuel.bus_q_winter`, …")]
        public decimal NormConsumptionWinter { get; set; }

        /// <summary>Нормативный расход в летний период $Q^{лето}$, л</summary>
        [DomainField(Alias = "norm_consumption_summer", Unit = "л", Range = "вещественное, ≥ 0",
            Calculated = "Да, `fuel.q_summer`, `fuel.bus_q_summer`, …")]
        public decimal NormConsumptionSummer { get; set; }

        /// <summary>Нормативный расход в городском режиме $Q^{гор}$, л</summary>
        [DomainField(Alias = "norm_consumption_urban", Unit = "л", Range = "вещественное, ≥ 0",
            Calculated = "Да, `fuel.q_urban` — Q^{гор}")]
        public decimal NormConsumptionUrban { get; set; }

        /// <summary>Нормативный расход за пригородной зоной $Q^{загор}$, л</summary>
        [DomainField(Alias = "norm_consumption_suburban", Unit = "л", Range = "вещественное, ≥ 0",
            Calculated = "Да, `fuel.q_suburban` — Q^{загор}")]
        public decimal NormConsumptionSuburban { get; set; }

        /// <summary>Нормативный расход $Q_н$, л</summary>
        [DomainField(Alias = "norm_consumption", Unit = "л", Range = "вещественное, ≥ 0",
            Calculated = "Да, результат ветки категории ТС: `fuel.normative_consumption` — нормативный расход Q_н")]
        public decimal NormConsumption { get; set; }

        /// <summary>Нормативный расход на работу отопителя $Q_{обор}$, л</summary>
        [DomainField(Alias = "norm_consumption_by_using_heater", Unit = "л", Range = "вещественное, ≥ 0",
            Calculated = "Да, `fuel.q_equipment` — Q_{обор}")]
        public decimal NormConsumptionByUsingHeater { get; set; }

        /// <summary>Нормативный расход на пробег $Q_{пробег}$, л</summary>
        [DomainField(Alias = "norm_consumption_mileage", Unit = "л", Range = "вещественное, ≥ 0",
            Calculated = "Да, `fuel.q_mileage` — нормативный расход на пробег Q_{пробег}; не применяется в ветке самосвалов")]
        public decimal NormConsumptionMileage { get; set; }

        /// <summary>Масса груза $G_{гр}$, т</summary>
        [DomainField(Alias = "cargo_mass", Unit = "т", Range = "вещественное, ≥ 0",
            Calculated = "Да, `fuel.g_cargo` — масса груза G_{гр}")]
        public decimal CargoMass { get; set; }

        /// <summary>Пробег с грузом $S_{гр}$, км</summary>
        [DomainField(Alias = "cargo_mileage", Unit = "км", Range = "вещественное, ≥ 0",
            Calculated = "Да, `fuel.s_cargo` — S_{гр}")]
        public decimal CargoMileage { get; set; }

        /// <summary>Объём транспортной работы $W$, т·км</summary>
        [DomainField(Alias = "transport_work", Unit = "т·км", Range = "вещественное, ≥ 0",
            Calculated = "Да, `fuel.w` — объём транспортной работы W")]
        public decimal TransportWork { get; set; }

        /// <summary>Норма расхода топлива на транспортную работу $H_w$, л/100 т·км</summary>
        [DomainField(Alias = "transport_work_consumption_rate", Unit = "л/100 т·км", Range = "вещественное, ≥ 0",
            Calculated = "Да, `fuel.h_transport` — расчёт от вида топлива: H_w")]
        public decimal TransportWorkConsumptionRate { get; set; }

        /// <summary>Норма расхода топлива на дополнительную массу прицепа $H_g$, л/100 т·км</summary>
        [DomainField(Alias = "trailer_mass_consumption_rate", Unit = "л/100 т·км", Range = "вещественное, ≥ 0",
            Calculated = "Да, `fuel.h_trailer` — расчёт от вида топлива: H_g")]
        public decimal TrailerMassConsumptionRate { get; set; }

        /// <summary>Нормативный расход на транспортную работу $Q_{трансп}$, л</summary>
        [DomainField(Alias = "norm_consumption_by_transport_work", Unit = "л", Range = "вещественное, ≥ 0",
            Calculated = "Да, `fuel.q_transport` — Q_{трансп}")]
        public decimal NormConsumptionByTransportWork { get; set; }

        /// <summary>Нормативный расход на массу прицепа $Q_{прицеп}$, л</summary>
        [DomainField(Alias = "norm_consumption_by_trailer_mass", Unit = "л", Range = "вещественное, ≥ 0",
            Calculated = "Да, `fuel.q_trailer` — Q_{прицеп}")]
        public decimal NormConsumptionByTrailerMass { get; set; }

        /// <summary>Норма расхода автомобиля-самосвала (автопоезда) $H_{sanc}$, л/100 км</summary>
        [DomainField(Alias = "dump_truck_consumption_rate", Unit = "л/100 км", Range = "вещественное, ≥ 0",
            Calculated = "Да, `fuel.h_sanc` — H_{sanc}")]
        public decimal DumpTruckConsumptionRate { get; set; }

        /// <summary>Нормативный расход на ездки с грузом $Q_{ездки}$, л</summary>
        [DomainField(Alias = "norm_consumption_by_trips", Unit = "л", Range = "вещественное, ≥ 0",
            Calculated = "Да, `fuel.q_trips` — Q_{ездки}")]
        public decimal NormConsumptionByTrips { get; set; }

        /// <summary>Норма расхода топлива на работу специального оборудования $H_т$, л/ч</summary>
        [DomainField(Alias = "consumption_rate_for_special_equipment", Unit = "л/ч", Range = "вещественное, ≥ 0",
            Calculated = "Да, `fuel.h_special_equipment` — H_т")]
        public decimal ConsumptionRateForSpecialEquipment { get; set; }

        /// <summary>Норма специального автомобиля на пробег с учётом транспортной работы $H_{sc}$, л/100 км</summary>
        [DomainField(Alias = "special_vehicle_consumption_rate", Unit = "л/100 км", Range = "вещественное, ≥ 0",
            Calculated = "Да, `fuel.h_sc` — H_sc")]
        public decimal SpecialVehicleConsumptionRate { get; set; }

        /// <summary>Норма расхода топлива на пробег при выполнении специальной работы во время передвижения $H_s''$, л/100 км</summary>
        [DomainField(Alias = "special_work_consumption_rate", Unit = "л/100 км", Range = "вещественное, ≥ 0",
            Calculated = "Да, `fuel.h_s_special_work` — H_s''")]
        public decimal SpecialWorkConsumptionRate { get; set; }

        /// <summary>Пробег к месту работы и обратно $S'$, км</summary>
        [DomainField(Alias = "special_mileage_to_work", Unit = "км", Range = "вещественное, ≥ 0",
            Calculated = "Да, `fuel.s_special_to_work` — S'")]
        public decimal SpecialMileageToWork { get; set; }

        /// <summary>Пробег при выполнении специальной работы при передвижении $S''$, км</summary>
        [DomainField(Alias = "special_mileage_on_work", Unit = "км", Range = "вещественное, ≥ 0",
            Calculated = "Да, `fuel.s_special_on_work` — S''")]
        public decimal SpecialMileageOnWork { get; set; }

        /// <summary>Время работы специального оборудования $T$, ч</summary>
        [DomainField(Alias = "special_equipment_time", Unit = "ч", Range = "вещественное, ≥ 0",
            Calculated = "Да, `fuel.special_equipment_time` — T")]
        public decimal SpecialEquipmentTime { get; set; }

        /// <summary>Нормативный расход за период передвижения в зимний период $Q_{движ}^{зима}$, л</summary>
        [DomainField(Alias = "norm_consumption_move_winter", Unit = "л", Range = "вещественное, ≥ 0",
            Calculated = "Да, `fuel.special_move_q_winter`")]
        public decimal NormConsumptionMoveWinter { get; set; }

        /// <summary>Нормативный расход за период передвижения в летний период $Q_{движ}^{лето}$, л</summary>
        [DomainField(Alias = "norm_consumption_move_summer", Unit = "л", Range = "вещественное, ≥ 0",
            Calculated = "Да, `fuel.special_move_q_summer`")]
        public decimal NormConsumptionMoveSummer { get; set; }

        /// <summary>Нормативный расход в городском режиме за период передвижения $Q_{движ}^{гор}$, л</summary>
        [DomainField(Alias = "norm_consumption_move_urban", Unit = "л", Range = "вещественное, ≥ 0",
            Calculated = "Да, `fuel.special_move_q_urban`")]
        public decimal NormConsumptionMoveUrban { get; set; }

        /// <summary>Нормативный расход за пригородной зоной за период передвижения $Q_{движ}^{загор}$, л</summary>
        [DomainField(Alias = "norm_consumption_move_suburban", Unit = "л", Range = "вещественное, ≥ 0",
            Calculated = "Да, `fuel.special_move_q_suburban`")]
        public decimal NormConsumptionMoveSuburban { get; set; }

        /// <summary>Нормативный расход за период передвижения $Q_{движ}$, л</summary>
        [DomainField(Alias = "norm_consumption_move", Unit = "л", Range = "вещественное, ≥ 0",
            Calculated = "Да, `fuel.special_move`")]
        public decimal NormConsumptionMove { get; set; }

        /// <summary>Нормативный расход за период стоянки в зимний период $Q_{стоян}^{зима}$, л</summary>
        [DomainField(Alias = "norm_consumption_stop_winter", Unit = "л", Range = "вещественное, ≥ 0",
            Calculated = "Да, `fuel.special_stop_q_winter`")]
        public decimal NormConsumptionStopWinter { get; set; }

        /// <summary>Нормативный расход за период стоянки в летний период $Q_{стоян}^{лето}$, л</summary>
        [DomainField(Alias = "norm_consumption_stop_summer", Unit = "л", Range = "вещественное, ≥ 0",
            Calculated = "Да, `fuel.special_stop_q_summer`")]
        public decimal NormConsumptionStopSummer { get; set; }

        /// <summary>Нормативный расход в городском режиме за период стоянки $Q_{стоян}^{гор}$, л</summary>
        [DomainField(Alias = "norm_consumption_stop_urban", Unit = "л", Range = "вещественное, ≥ 0",
            Calculated = "Да, `fuel.special_stop_q_urban`")]
        public decimal NormConsumptionStopUrban { get; set; }

        /// <summary>Нормативный расход за пригородной зоной за период стоянки $Q_{стоян}^{загор}$, л</summary>
        [DomainField(Alias = "norm_consumption_stop_suburban", Unit = "л", Range = "вещественное, ≥ 0",
            Calculated = "Да, `fuel.special_stop_q_suburban`")]
        public decimal NormConsumptionStopSuburban { get; set; }

        /// <summary>Нормативный расход за период стоянки $Q_{стоян}$, л</summary>
        [DomainField(Alias = "norm_consumption_stop", Unit = "л", Range = "вещественное, ≥ 0",
            Calculated = "Да, `fuel.special_stop`")]
        public decimal NormConsumptionStop { get; set; }

        /// <summary>Статус расчёта</summary>
        [Relation]
        [DomainField(Alias = "calculation_status_id", RequiredOnCreate = true,
            Default = "Не выполнен",
            Description = "Результат работы калькулятора: не выполнен, успешно выполнен или выполнен с ошибкой")]
        public CalculationStatus? CalculationStatus { get; set; }

        /// <summary>Статус подбора модификации</summary>
        [Relation]
        [DomainField(Alias = "modification_selection_status_id", RequiredOnCreate = true,
            Calculated = "Да",
            Range = "{Не выполнен; Не определена; Определена; Определена группа}",
            Default = "Не выполнен",
            Description = "Определяется состоянием подбора: не выполнялся / ни одной / одна / несколько модификаций")]
        public NtsModificationSelectionStatus? ModificationSelectionStatus { get; set; }

        /// <summary>Способ подбора</summary>
        [Relation]
        [DomainField(Alias = "selection_method_id", RequiredOnCreate = true,
            Calculated = "Да", Range = "{Не определён; авто; эксперт}", Default = "Не определён",
            Description = "Не определён — подбор не выполнялся; авто — подбор выполнен сервисом при загрузке ТС; эксперт — пользователь нажал «Применить»")]
        public NtsSelectionMethod? SelectionMethod { get; set; }

        /// <summary>Журнал расчёта</summary>
        [DomainField(Alias = "calc_log_json", RequiredOnCreate = true, Calculated = "Да",
            Description = "Шаги расчёта с формулами и значениями, JSON")]
        public string? CalcLogJson { get; set; }

        /// <summary>Ошибки расчёта</summary>
        [DomainField(Alias = "calc_errors_json", RequiredOnCreate = true, Calculated = "Да",
            Description = "Ошибки расчёта, JSON")]
        public string? CalcErrorsJson { get; set; }

        /// <summary>Дата расчёта</summary>
        [DomainField(Alias = "calc_date", Calculated = "Да", Description = "Дата и время выполнения расчёта")]
        public DateTime? CalcDate { get; set; }

        /// <summary>Статус загрузки</summary>
        [Relation]
        [DomainField(Alias = "ais_load_status_id", RequiredOnCreate = true,
            Calculated = "Да", Default = "Не выполнена",
            Description = "Достаточность данных из АИС ОИА ПЭО для расчёта: устанавливается процедурой приёма данных")]
        public NtsAisLoadStatus? AisLoadStatus { get; set; }

        /// <summary>Статус обработки ТС</summary>
        [Relation]
        [DomainField(Alias = "processing_status_id", RequiredOnCreate = true,
            Calculated = "Да", Default = "Не выполнена",
            Description = "Итоговый статус обработки ТС: вычисляется по статусу загрузки, статусу расчёта, статусу подбора модификации и способу подбора")]
        public ProcessingStatus? ProcessingStatus { get; set; }
    }
}