consts.ts

import {
  RollingStockComfortType,
  ConditionalEffortCurve,
  EffortCurve,
  LoadingGaugeType,
  RollingStockCommon,
} from 'common/api/osrdEditoastApi';

export const THERMAL_TRACTION_IDENTIFIER = 'thermal';
export const STANDARD_COMFORT_LEVEL: RollingStockComfortType = 'STANDARD';

export const DEFAULT_SELECTORS_CLASSNAME = 'selector-SNCF';

export type EffortCurves = {
  modes: {
    [key: string]: {
      curves: ConditionalEffortCurve[];
      defaultCurve: EffortCurve;
      isElectric: boolean;
    };
  };
};

export type Curve = {
  max_efforts: number[];
  speeds: number[];
};

export type SelectedCurves = {
  [key: string]: {
    curves: ConditionalEffortCurve[];
    default_curve: EffortCurve;
    is_electric: boolean;
  };
};

export type RollingStockSelectorParams = {
  comfortLevels: RollingStockComfortType[];
  electricalProfiles: (string | null)[];
  powerRestrictions: (string | null)[];
  tractionModes: string[];
};

export interface RollingStockSelectorParam {
  comfortLevels: RollingStockComfortType;
  electricalProfiles: string | null;
  powerRestrictions: string | null;
  tractionModes: string;
}

export type EffortCurveCondKeys = {
  comfortLevels: string;
  electricalProfiles: string;
  powerRestrictions: string;
};

export const effortCurveCondKeys: EffortCurveCondKeys = {
  comfortLevels: 'comfort',
  electricalProfiles: 'electrical_profile_level',
  powerRestrictions: 'power_restriction_code',
};

export type RollingStockParametersValidValues = {
  // TODO: remove this line in the type
  [key: string]: string | number | null | EffortCurves | RollingStockCommon['power_restrictions'];
  railjsonVersion: string;
  name: string;
  detail: string;
  family: string;
  grouping: string;
  number: string;
  reference: string;
  series: string;
  subseries: string;
  type: string;
  unit: string;
  length: number;
  mass: number;
  maxSpeed: number;
  startupTime: number;
  startupAcceleration: number;
  comfortAcceleration: number;
  gammaValue: number;
  inertiaCoefficient: number;
  loadingGauge: LoadingGaugeType;
  rollingResistanceA: number;
  rollingResistanceB: number;
  rollingResistanceC: number;
  electricalPowerStartupTime: number | null;
  raisePantographTime: number | null;
  defaultMode: string | null;
  effortCurves: EffortCurves;
  basePowerClass: string | null;
  powerRestrictions: RollingStockCommon['power_restrictions'];
};

export type RollingStockParametersValues = {
  // TODO: remove this line in the type
  [key: string]:
    | string
    | number
    | null
    | EffortCurves
    | RollingStockCommon['power_restrictions']
    | undefined;
  railjsonVersion: string;
  name: string;
  detail: string;
  family: string;
  grouping: string;
  number: string;
  reference: string;
  series: string;
  subseries: string;
  type: string;
  unit: string;
  length?: number;
  mass?: number;
  maxSpeed?: number;
  startupTime?: number;
  startupAcceleration?: number;
  comfortAcceleration?: number;
  gammaValue?: number;
  inertiaCoefficient?: number;
  loadingGauge: 'G1' | 'G2' | 'GA' | 'GB' | 'GB1' | 'GC' | 'FR3.3' | 'FR3.3/GB/G2' | 'GLOTT';
  rollingResistanceA?: number;
  rollingResistanceB?: number;
  rollingResistanceC?: number;
  electricalPowerStartupTime: number | null;
  raisePantographTime: number | null;
  defaultMode: string | null;
  effortCurves: EffortCurves;
  basePowerClass: string | null;
  powerRestrictions: RollingStockCommon['power_restrictions'];
};

export type SchemaProperty = {
  title: string;
  type: string;
  side: string;
  format?: string;
  enum?: string[];
  min?: number;
  max?: number;
  unit?: string;
  units?: string[];
};

export enum RollingStockEditorMetadata {
  name = 'name',
  detail = 'detail',
  family = 'family',
  grouping = 'grouping',
  number = 'number',
  reference = 'reference',
  series = 'series',
  subseries = 'subseries',
  type = 'type',
  unit = 'unit',
}

export enum RollingStockEditorParameter {
  length = 'length',
  mass = 'mass',
  maxSpeed = 'maxSpeed',
  startupTime = 'startupTime',
  startupAcceleration = 'startupAcceleration',
  comfortAcceleration = 'comfortAcceleration',
  gammaValue = 'gammaValue',
  inertiaCoefficient = 'inertiaCoefficient',
  loadingGauge = 'loadingGauge',
  basePowerClass = 'basePowerClass',
  rollingResistanceA = 'rollingResistanceA',
  rollingResistanceB = 'rollingResistanceB',
  rollingResistanceC = 'rollingResistanceC',
}

export const RollingStockSchemaProperties: SchemaProperty[] = [
  {
    title: 'name',
    type: 'string',
    side: 'left',
  },
  {
    title: 'detail',
    type: 'string',
    side: 'left',
  },
  {
    title: 'family',
    type: 'string',
    side: 'left',
  },
  {
    title: 'grouping',
    type: 'string',
    side: 'left',
  },
  {
    title: 'number',
    type: 'string',
    side: 'middle',
  },
  {
    title: 'reference',
    type: 'string',
    side: 'middle',
  },
  {
    title: 'series',
    type: 'string',
    side: 'middle',
  },
  {
    title: 'subseries',
    type: 'string',
    side: 'right',
  },
  {
    title: 'type',
    type: 'string',
    side: 'right',
  },
  {
    title: 'unit',
    type: 'string',
    side: 'right',
  },
  {
    title: 'length',
    type: 'number',
    min: 0,
    max: 2000,
    unit: 'm',
    side: 'left',
  },
  {
    title: 'mass',
    type: 'number',
    min: 0,
    max: 100000000,
    units: ['t', 'kg'],
    side: 'left',
  },
  {
    title: 'maxSpeed',
    type: 'number',
    min: 0,
    max: 600,
    unit: 'km/h',
    side: 'left',
  },
  {
    title: 'startupTime',
    type: 'number',
    min: 0,
    unit: 's',
    side: 'left',
  },
  {
    title: 'startupAcceleration',
    type: 'number',
    min: 0,
    unit: 'm/s²',
    side: 'left',
  },
  {
    title: 'comfortAcceleration',
    type: 'number',
    min: 0.01,
    unit: 'm/s²',
    side: 'middle',
  },
  {
    title: 'inertiaCoefficient',
    type: 'number',
    min: 1,
    max: 2,
    side: 'middle',
  },
  {
    title: 'gammaValue',
    type: 'number',
    min: 0.01,
    max: 2,
    unit: 'm/s²',
    side: 'middle',
  },
  {
    title: 'loadingGauge',
    type: 'string',
    enum: ['G1', 'G2', 'GA', 'GB', 'GB1', 'GC', 'FR3.3', 'FR3.3/GB/G2', 'GLOTT'],
    side: 'middle',
  },
  {
    title: 'basePowerClass',
    type: 'string',
    side: 'middle',
  },
  {
    title: 'rollingResistanceA',
    type: 'number',
    min: 0,
    units: ['N', 'daN', 'daN/t'],
    side: 'right',
  },
  {
    title: 'rollingResistanceB',
    type: 'number',
    min: 0,
    units: ['N/(m/s)', 'daN/(km/h)', 'daN/(km/h)/t'],
    side: 'right',
  },
  {
    title: 'rollingResistanceC',
    type: 'number',
    min: 0,
    units: ['N/(m/s)²', 'daN/(km/h)²', 'daN/(km/h)²/t'],
    side: 'right',
  },
];

const ComfortLevels = {
  STANDARD: 'STANDARD',
  AC: 'AC',
  HEATING: 'HEATING',
};

export const comfortOptions = Object.keys(ComfortLevels) as RollingStockComfortType[];

export type ElectricalProfileByMode = {
  '1500': (string | null)[];
  '25000': (string | null)[];
  other: null[];
  thermal: null[];
};

export const electricalProfilesByMode: ElectricalProfileByMode = {
  '1500': ['O', 'A', 'A1', 'B', 'C', 'D', 'E', 'F', 'G', null],
  '25000': ['25000', '22500', '20000', null],
  other: [null],
  thermal: [null],
};