feat(etabs): add UI integration for dynamic result type selection (#1025)

* refactor: linking up results type

* fix: send settings

Author: bjoernsteinhagen

Connectors/CSi/Speckle.Connectors.CSiShared/Bindings/CsiSharedSendBinding.cs

@@ -64,7 +64,8 @@ await manager.Process(
           .Initialize(
             _csiConversionSettingsFactory.Create(
               _csiApplicationService.SapModel,
-              _toSpeckleSettingsManager.GetLoadCasesAndCombinations(card)
+              _toSpeckleSettingsManager.GetLoadCasesAndCombinations(card),
+              _toSpeckleSettingsManager.GetResultTypes(card)
             )
           );
       },

Connectors/CSi/Speckle.Connectors.CSiShared/HostApp/Helpers/CsiResultsExtractorFactory.cs

@@ -0,0 +1,21 @@
+using Microsoft.Extensions.DependencyInjection;
+using Speckle.Converters.CSiShared.ToSpeckle.Helpers;
+
+namespace Speckle.Connectors.CSiShared.HostApp.Helpers;
+
+public class CsiResultsExtractorFactory
+{
+  private readonly IServiceProvider _serviceProvider;
+
+  public CsiResultsExtractorFactory(IServiceProvider serviceProvider)
+  {
+    _serviceProvider = serviceProvider;
+  }
+
+  public IApplicationResultsExtractor GetExtractor(string resultsKey) =>
+    resultsKey switch
+    {
+      "FrameForces" => _serviceProvider.GetRequiredService<CsiFrameForceResultsExtractor>(),
+      _ => throw new InvalidOperationException($"{resultsKey} not accounted for in CsiResultsExtractorFactory")
+    };
+}

Connectors/CSi/Speckle.Connectors.CSiShared/Operations/Send/CsiRootObjectBuilder.cs

@@ -8,7 +8,6 @@
 using Speckle.Converters.Common;
 using Speckle.Converters.CSiShared;
 using Speckle.Converters.CSiShared.Extensions;
-using Speckle.Converters.CSiShared.ToSpeckle.Helpers;
 using Speckle.Converters.CSiShared.Utils;
 using Speckle.Sdk;
 using Speckle.Sdk.Logging;
@@ -41,7 +40,7 @@ public class CsiRootObjectBuilder : IRootObjectBuilder<ICsiWrapper>
   private readonly ISdkActivityFactory _activityFactory;
   private readonly ICsiApplicationService _csiApplicationService;
   private readonly LoadCaseManager _loadCaseManager;
-  private readonly CsiFrameForceResultsExtractor _frameForceResultsExtractor;
+  private readonly CsiResultsExtractorFactory _resultsExtractorFactory;
 
   public CsiRootObjectBuilder(
     IRootToSpeckleConverter rootToSpeckleConverter,
@@ -53,7 +52,7 @@ public CsiRootObjectBuilder(
     ISdkActivityFactory activityFactory,
     ICsiApplicationService csiApplicationService,
     LoadCaseManager loadCaseManager,
-    CsiFrameForceResultsExtractor frameForceResultsExtractor
+    CsiResultsExtractorFactory resultsExtractorFactory
   )
   {
     _converterSettings = converterSettings;
@@ -65,7 +64,7 @@ CsiFrameForceResultsExtractor frameForceResultsExtractor
     _activityFactory = activityFactory;
     _csiApplicationService = csiApplicationService;
     _loadCaseManager = loadCaseManager;
-    _frameForceResultsExtractor = frameForceResultsExtractor;
+    _resultsExtractorFactory = resultsExtractorFactory;
   }
 
   /// <summary>
@@ -121,24 +120,35 @@ CancellationToken cancellationToken
       rootObjectCollection[ProxyKeys.SECTION] = _sectionUnpacker.UnpackSections().ToList();
     }
 
+    // Extract analysis results (if applicable)
+    // NOTE: used in the results extraction to extract results for objects being published only
     var objectSelectionSummary = GetObjectSummary(csiObjects);
-
-    // TODO: Inject correct "extractor" according to which analysis results send settings
     var selectedCasesAndCombinations = _converterSettings.Current.SelectedLoadCasesAndCombinations;
+    var requestedResultTypes = _converterSettings.Current.SelectedResultTypes;
+
     if (selectedCasesAndCombinations != null && selectedCasesAndCombinations.Count > 0)
     {
+      if (requestedResultTypes == null || requestedResultTypes.Count == 0)
+      {
+        throw new SpeckleException(
+          "No result types stipulated for the requested load cases and combinations. Adjust publish settings."
+        );
+      }
+
       if (!_csiApplicationService.SapModel.GetModelIsLocked()) // Don't know if there's a better way to ensure analysis is run
       {
         _logger.LogError("Model unlocked. No access to analysis results.");
       }
       else
       {
         _loadCaseManager.ConfigureSelectedLoadCases(selectedCasesAndCombinations);
-        Base analysisResults =
-          new()
-          {
-            ["columnForces"] = _frameForceResultsExtractor.GetResults(objectSelectionSummary[ModelObjectType.FRAME])
-          };
+        Base analysisResults = new();
+        foreach (var resultType in requestedResultTypes)
+        {
+          var extractor = _resultsExtractorFactory.GetExtractor(resultType);
+          var objectNames = objectSelectionSummary[extractor.TargetObjectType];
+          analysisResults[extractor.ResultsKey] = extractor.GetResults(objectNames);
+        }
         rootObjectCollection["analysisResults"] = analysisResults;
       }
     }

Connectors/CSi/Speckle.Connectors.CSiShared/ServiceRegistration.cs

@@ -46,6 +46,7 @@ public static IServiceCollection AddCsi(this IServiceCollection services)
     services.AddScoped<SendOperation<ICsiWrapper>>();
 
     services.AddScoped<CsiMaterialPropertyExtractor>();
+    services.AddScoped<CsiResultsExtractorFactory>();
     services.AddScoped<MaterialUnpacker>();
     services.AddScoped<IFrameSectionPropertyExtractor, CsiFrameSectionPropertyExtractor>();
     services.AddScoped<IShellSectionPropertyExtractor, CsiShellSectionPropertyExtractor>();

Connectors/CSi/Speckle.Connectors.CSiShared/Settings/ResultTypeSetting.cs

@@ -8,5 +8,5 @@ public class ResultTypeSetting(List<string> values) : ICardSetting
   public string? Title { get; set; } = "Result Type";
   public string? Type { get; set; } = "array";
   public object? Value { get; set; } = values;
-  public List<string>? Enum { get; set; } = new List<string> { "Joint Reactions", "Joint Displacements", };
+  public List<string>? Enum { get; set; } = ["FrameForces"];
 }

Connectors/CSi/Speckle.Connectors.CSiShared/Speckle.Connectors.CSiShared.projitems

@@ -18,6 +18,7 @@
     <Compile Include="$(MSBuildThisFileDirectory)Bindings\CsiSharedSelectionBinding.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)Bindings\CsiSharedSendBinding.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)Filters\CsiSharedSelectionFilter.cs" />
+    <Compile Include="$(MSBuildThisFileDirectory)HostApp\Helpers\CsiResultsExtractorFactory.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)HostApp\MaterialUnpacker.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)HostApp\CsiSendCollectionManager.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)HostApp\Helpers\CsiFrameSectionPropertyExtractor.cs" />

Converters/CSi/Speckle.Converters.CSiShared/CsiConversionSettings.cs

@@ -3,5 +3,6 @@ namespace Speckle.Converters.CSiShared;
 public record CsiConversionSettings(
   cSapModel SapModel,
   string SpeckleUnits,
-  List<string>? SelectedLoadCasesAndCombinations = null
+  List<string>? SelectedLoadCasesAndCombinations = null,
+  List<string>? SelectedResultTypes = null
 );

Converters/CSi/Speckle.Converters.CSiShared/CsiConversionSettingsFactory.cs

@@ -11,6 +11,15 @@ IConverterSettingsStore<CsiConversionSettings> settingsStore
 {
   public CsiConversionSettings Current => settingsStore.Current;
 
-  public CsiConversionSettings Create(cSapModel document, List<string>? selectedLoadCasesAndCombinations = null) =>
-    new(document, unitsConverter.ConvertOrThrow(document.GetPresentUnits()), selectedLoadCasesAndCombinations ?? []);
+  public CsiConversionSettings Create(
+    cSapModel document,
+    List<string>? selectedLoadCasesAndCombinations = null,
+    List<string>? selectedResultTypes = null
+  ) =>
+    new(
+      document,
+      unitsConverter.ConvertOrThrow(document.GetPresentUnits()),
+      selectedLoadCasesAndCombinations ?? [],
+      selectedResultTypes ?? []
+    );
 }

Converters/CSi/Speckle.Converters.CSiShared/ToSpeckle/Helpers/CsiFrameForceResultsExtractor.cs

@@ -9,6 +9,7 @@ public sealed class CsiFrameForceResultsExtractor : IApplicationResultsExtractor
   private readonly ResultsArrayProcessor _resultsArrayProcessor;
 
   public string ResultsKey => "FrameForces";
+  public ModelObjectType TargetObjectType => ModelObjectType.FRAME;
 
   public ResultsConfiguration Configuration { get; } =
     new(["Elm", "LoadCase", "Wrap:ElmSta", "Wrap:StepNum"], ["P", "V2", "V3", "T", "M2", "M3"]);

Converters/CSi/Speckle.Converters.CSiShared/ToSpeckle/Helpers/IApplicationResultsExtractor.cs

@@ -14,6 +14,12 @@ public interface IApplicationResultsExtractor
   /// <example>"FrameForces", "JointReactions", "BaseReactions"</example>
   string ResultsKey { get; }
 
+  /// <summary>
+  /// Gets the type of CSI model objects that this extractor operates on.
+  /// Used to automatically resolve the correct object names from the selection summary.
+  /// </summary>
+  ModelObjectType TargetObjectType { get; }
+
   /// <summary>
   /// Gets the configuration defining how to process raw API arrays into hierarchical structure.
   /// Specifies grouping hierarchy and result value keys.