add limits in lines catalog (#3074)

Signed-off-by: Etienne LESOT <[email protected]>
Co-authored-by: Rehili Ghazwa <[email protected]>

Author: EtienneLt

src/components/dialogs/line-types-catalog/limit-custom-aggrid.tsx

@@ -0,0 +1,65 @@
+/**
+ * Copyright (c) 2025, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+import { AgGridReact } from 'ag-grid-react';
+import { CATEGORIES_TABS, LineTypeInfo } from './line-catalog.type';
+import { ColDef } from 'ag-grid-community';
+import { RefObject, useMemo } from 'react';
+import { CustomAGGrid } from '@gridsuite/commons-ui';
+import { AGGRID_LOCALES } from '../../../translations/not-intl/aggrid-locales';
+import { suppressEventsToPreventEditMode } from '../commons/utils';
+
+const defaultColDef: ColDef = {
+    filter: true,
+    sortable: true,
+    resizable: false,
+    lockPinned: true,
+    wrapHeaderText: true,
+    autoHeaderHeight: true,
+    suppressKeyboardEvent: suppressEventsToPreventEditMode,
+};
+
+interface LimitsCustomAgGridProps {
+    gridRef: RefObject<AgGridReact>;
+    currentTab: number;
+    aerialRowData: LineTypeInfo[];
+    undergroundRowData: LineTypeInfo[];
+    aerialColumnDefs: ColDef[];
+    undergroundColumnDefs: ColDef[];
+    onSelectionChanged: () => void;
+    onGridReady: () => void;
+}
+
+export default function LimitCustomAgGrid({
+    gridRef,
+    currentTab,
+    aerialRowData,
+    undergroundRowData,
+    aerialColumnDefs,
+    undergroundColumnDefs,
+    onSelectionChanged,
+    onGridReady,
+}: Readonly<LimitsCustomAgGridProps>) {
+    const { rowData, columnDefs } = useMemo(() => {
+        if (currentTab === CATEGORIES_TABS.AERIAL.id) {
+            return { rowData: aerialRowData, columnDefs: aerialColumnDefs };
+        }
+        return { rowData: undergroundRowData, columnDefs: undergroundColumnDefs };
+    }, [currentTab, aerialRowData, undergroundRowData, aerialColumnDefs, undergroundColumnDefs]);
+
+    return (
+        <CustomAGGrid
+            ref={gridRef}
+            rowData={rowData}
+            defaultColDef={defaultColDef}
+            columnDefs={columnDefs}
+            rowSelection="single"
+            onSelectionChanged={onSelectionChanged}
+            onGridReady={onGridReady}
+            overrideLocales={AGGRID_LOCALES}
+        />
+    );
+}

src/components/dialogs/line-types-catalog/line-catalog.type.ts

@@ -25,6 +25,8 @@ export type LineTypeInfo = {
     linearResistance: number;
     linearReactance: number;
     linearCapacity: number;
+    limitsForLineType: CurrentLimitsInfo[];
+    shapeFactors: number[];
 } & (AerialLineTypeInfo | UndergroundLineTypeInfo);
 
 // Interface with Line creation/modification
@@ -33,3 +35,18 @@ export type ComputedLineCharacteristics = {
     totalReactance: number;
     totalSusceptance: number;
 };
+
+export type CurrentLimitsInfo = {
+    limitSetName: string;
+    permanentLimit: number;
+    temporaryLimitValue: number;
+    temporaryLimitAcceptableDuration: number;
+    temporaryLimitName: string;
+    area: string;
+    temperature: string;
+};
+
+export const CATEGORIES_TABS = {
+    AERIAL: { id: 0, name: 'AERIAL' },
+    UNDERGROUND: { id: 1, name: 'UNDERGROUND' },
+} as const;

src/components/dialogs/line-types-catalog/line-type-segment-creation.tsx

@@ -5,18 +5,18 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  */
 
-import { FunctionComponent, useCallback, useEffect } from 'react';
+import { useCallback, useEffect } from 'react';
 import { useWatch } from 'react-hook-form';
 import { KilometerAdornment } from '../dialog-utils';
 import EditIcon from '@mui/icons-material/Edit';
 import { FloatInput } from '@gridsuite/commons-ui';
 import { IconButton } from '@mui/material';
 import {
     SEGMENT_DISTANCE_VALUE,
-    SEGMENT_TYPE_VALUE,
-    SEGMENT_RESISTANCE,
     SEGMENT_REACTANCE,
+    SEGMENT_RESISTANCE,
     SEGMENT_SUSCEPTANCE,
+    SEGMENT_TYPE_VALUE,
 } from '../../utils/field-constants';
 import { ReadOnlyInput } from '../../utils/rhf-inputs/read-only/read-only-input';
 import { ButtonReadOnlyInput } from '../../utils/rhf-inputs/read-only/button-read-only-input';
@@ -29,12 +29,12 @@ export interface LineTypeSegmentCreationProps {
     onSegmentDistanceChange: (index: number) => void;
 }
 
-const LineTypeSegmentCreation: FunctionComponent<LineTypeSegmentCreationProps> = ({
+export default function LineTypeSegmentCreation({
     name,
     index,
     onEditButtonClick,
     onSegmentDistanceChange,
-}) => {
+}: Readonly<LineTypeSegmentCreationProps>) {
     const watchDistance = useWatch({
         name: `${name}.${index}.${SEGMENT_DISTANCE_VALUE}`,
     });
@@ -79,6 +79,4 @@ const LineTypeSegmentCreation: FunctionComponent<LineTypeSegmentCreationProps> =
             <GridItem size={2}>{segmentSusceptanceField}</GridItem>
         </>
     );
-};
-
-export default LineTypeSegmentCreation;
+}

src/components/dialogs/line-types-catalog/line-type-segment-dialog.tsx

@@ -5,34 +5,42 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  */
 
-import { FunctionComponent, useCallback } from 'react';
-import { SEGMENTS, TOTAL_REACTANCE, TOTAL_RESISTANCE, TOTAL_SUSCEPTANCE } from '../../utils/field-constants';
+import { useCallback } from 'react';
 import { yupResolver } from '@hookform/resolvers/yup';
 import yup from 'components/utils/yup-config';
 import { ModificationDialog } from '../commons/modificationDialog';
 import { useForm } from 'react-hook-form';
 import { LineTypeSegmentForm } from './line-type-segment-form';
 import { CustomFormProvider } from '@gridsuite/commons-ui';
 import { ComputedLineCharacteristics } from './line-catalog.type';
-import { emptyLineSegment, SegmentSchema } from './segment-utils';
+import { SegmentSchema } from './segment-utils';
+import {
+    FINAL_CURRENT_LIMITS,
+    SEGMENTS,
+    TOTAL_REACTANCE,
+    TOTAL_RESISTANCE,
+    TOTAL_SUSCEPTANCE,
+} from '../../utils/field-constants';
+import { InferType } from 'yup';
+import { DeepNullable } from '../../utils/ts-utils';
 
 const LineTypeSegmentSchema = yup
     .object()
     .shape({
         [TOTAL_RESISTANCE]: yup.number().required(),
         [TOTAL_REACTANCE]: yup.number().required(),
         [TOTAL_SUSCEPTANCE]: yup.number().required(),
+        [FINAL_CURRENT_LIMITS]: yup.array(),
         [SEGMENTS]: yup.array().of(SegmentSchema).required().min(1, 'AtLeastOneSegmentNeeded'),
     })
     .required();
 
-export type LineTypeSegmentFormData = yup.InferType<typeof LineTypeSegmentSchema>;
-
-const emptyFormData: LineTypeSegmentFormData = {
+const emptyFormData = {
     [TOTAL_RESISTANCE]: 0.0,
     [TOTAL_REACTANCE]: 0.0,
     [TOTAL_SUSCEPTANCE]: 0.0,
-    [SEGMENTS]: [emptyLineSegment],
+    [FINAL_CURRENT_LIMITS]: [],
+    [SEGMENTS]: [],
 };
 
 export interface LineTypeSegmentDialogProps {
@@ -41,10 +49,12 @@ export interface LineTypeSegmentDialogProps {
     onSave: (data: ComputedLineCharacteristics) => void;
 }
 
-const LineTypeSegmentDialog: FunctionComponent<LineTypeSegmentDialogProps> = ({ open, onSave, onClose }) => {
-    const formMethods = useForm<LineTypeSegmentFormData>({
+export type LineTypeSegmentDialogSchemaForm = InferType<typeof LineTypeSegmentSchema>;
+
+export default function LineTypeSegmentDialog({ open, onSave, onClose }: Readonly<LineTypeSegmentDialogProps>) {
+    const formMethods = useForm<DeepNullable<LineTypeSegmentDialogSchemaForm>>({
         defaultValues: emptyFormData,
-        resolver: yupResolver<LineTypeSegmentFormData>(LineTypeSegmentSchema),
+        resolver: yupResolver<DeepNullable<LineTypeSegmentDialogSchemaForm>>(LineTypeSegmentSchema),
     });
 
     const { reset } = formMethods;
@@ -53,9 +63,6 @@ const LineTypeSegmentDialog: FunctionComponent<LineTypeSegmentDialogProps> = ({
         reset(emptyFormData);
     }, [reset]);
 
-    /**
-     * RENDER
-     */
     return (
         <CustomFormProvider validationSchema={LineTypeSegmentSchema} {...formMethods}>
             <ModificationDialog
@@ -71,6 +78,4 @@ const LineTypeSegmentDialog: FunctionComponent<LineTypeSegmentDialogProps> = ({
             </ModificationDialog>
         </CustomFormProvider>
     );
-};
-
-export default LineTypeSegmentDialog;
+}