diff --git a/DocsGeneration/Data/Parameter.cs b/DocsGeneration/Data/Parameter.cs index e35e02907..6f76580ec 100644 --- a/DocsGeneration/Data/Parameter.cs +++ b/DocsGeneration/Data/Parameter.cs @@ -127,7 +127,7 @@ private string GetClassSummary(Type paramType) { XmlNode xmlDocuOfMethod = GsaGhDll.GsaGhXml.SelectSingleNode( "//member[@name='" + path + "']"); string text = xmlDocuOfMethod.InnerXml - .Replace("", string.Empty).Replace("", string.Empty); + .Replace("", string.Empty).Replace("", string.Empty); string cleanStr = Regex.Replace(text, @"\s+", " "); return cleanStr.Trim(); } @@ -156,7 +156,8 @@ public static List GetParameters(Type[] typelist, List com parameters.Add(param); Console.WriteLine($"Added {param.Name} parameter"); } - } catch (Exception) { + } + catch (Exception) { continue; } } diff --git a/DocsGeneration/MarkDowns/Helpers/FileHelper.cs b/DocsGeneration/MarkDowns/Helpers/FileHelper.cs index 7fa465b73..d80086ac2 100644 --- a/DocsGeneration/MarkDowns/Helpers/FileHelper.cs +++ b/DocsGeneration/MarkDowns/Helpers/FileHelper.cs @@ -35,6 +35,9 @@ public static string CreateIconLink(Parameter parameter) { string name = parameter.ParameterType.Replace(" (List)", string.Empty); name = name.Replace(" (Tree)", string.Empty); name = name.Replace(" ", string.Empty); + if (name.Contains("LoadValue") && name.Contains("kN,kN/m,kN/m²")) { + name = "Load"; + } name = $"{name}Param"; iconNames.Add(name); // ![Material](./images/gsagh/MaterialParam.png) diff --git a/DocsGeneration/MarkDowns/Helpers/StringHelper.cs b/DocsGeneration/MarkDowns/Helpers/StringHelper.cs index f1beaff2e..f763ac638 100644 --- a/DocsGeneration/MarkDowns/Helpers/StringHelper.cs +++ b/DocsGeneration/MarkDowns/Helpers/StringHelper.cs @@ -65,6 +65,7 @@ public static string ComponentDescription(string str, List parameterName private static string ConvertSummaryToMarkup(string str) { str = str.Replace("", "\n\n").Replace("", string.Empty); str = str.Replace("IGsaLoad", "GsaLoad"); + str = str.Replace("IGsaResult", "GsaResult"); str = str.Replace("IGsaGridLoad", "GsaGridLoad"); str = str.Replace("IGsaStandardMaterial", "GsaStandardMaterial"); str = str.Replace("IGsaAnnotation", "GsaAnnotation"); diff --git a/GsaGH/Parameters/2_Geometry/GsaAssembly.cs b/GsaGH/Parameters/2_Geometry/GsaAssembly.cs index f7f6c1a78..785816451 100644 --- a/GsaGH/Parameters/2_Geometry/GsaAssembly.cs +++ b/GsaGH/Parameters/2_Geometry/GsaAssembly.cs @@ -7,7 +7,7 @@ namespace GsaGH.Parameters { /// /// Assemblies are a way to define an entity that is formed from a collection of elements or members and can be thought of as a super-element. This is not an analysis entity but just a convenience for post-processing such as cut section forces. Typical uses of assemblies include cores, where the core is modelled with 2D finite elements, or trusses where the truss is modelled with top and bottom chords and bracing. In both these cases the assembly is identified by a list of included elements. /// Unlike the analysis elements, an assembly does not have a clearly define orientation and location of reference point so these must be defined explicitly. - /// Refer to Assemblies to read more. + /// Refer to Assemblies to read more. /// public class GsaAssembly { public Guid Guid { get; set; } = Guid.NewGuid(); diff --git a/GsaGH/Parameters/3_Loads/GsaGridPlaneSurface.cs b/GsaGH/Parameters/3_Loads/GsaGridPlaneSurface.cs index 05dd4eedb..42441ed76 100644 --- a/GsaGH/Parameters/3_Loads/GsaGridPlaneSurface.cs +++ b/GsaGH/Parameters/3_Loads/GsaGridPlaneSurface.cs @@ -9,7 +9,7 @@ namespace GsaGH.Parameters { /// - /// A Grid Plane Surface is used by Grid Loads. + /// A Grid Plane Surface is used by Grid Loads. /// A grid plane defines the geometry of a surface, and the load behaviour of the grid plane is defined by a grid surface. /// In Grasshopper, a Grid Plane Surface contains both the information of what in GSA is known as a Grid Plane and a Grid Surface /// The Grasshopper plugin will automatically create a fitting Grid Plane Surface when using the , or components. diff --git a/GsaGH/Parameters/5_Results/2_Results/GsaResult.cs b/GsaGH/Parameters/5_Results/2_Results/GsaResult.cs index 4e7f676cb..e07748e5c 100644 --- a/GsaGH/Parameters/5_Results/2_Results/GsaResult.cs +++ b/GsaGH/Parameters/5_Results/2_Results/GsaResult.cs @@ -5,18 +5,7 @@ using GsaGH.Helpers; namespace GsaGH.Parameters.Results { - /// - /// A Result is used to select Cases from an analysed and extract the values for post-processing or visualisation. - /// The following result types can be extracted if they are present in the model: - /// - /// Node Results: `Displacement` and `Reaction`. - /// 1D Element Results: `Displacement`, `Force` and `StrainEnergyDensity`. - /// 2D Element Results: `Displacement`, `Force`, `Moment`, `Shear` and `Stress`. - /// 3D Element Results: `Displacement` and `Stress`. - /// Global Results: `Frequency`, `LoadFactor`, `ModalGeometricStiffness`, `ModalMass`, `ModalStiffness`, `TotalLoad`, `TotalReaction`, `Mode`, `EffectiveInertia`, `EffectiveMass` and `Eigenvalue`. - /// - /// All result values from the .NET API have been wrapped in Unit Number and can be converted into different measures on the fly. The Result parameter caches the result values. - /// + public class GsaResult : IGsaResult { public int CaseId { get; set; } public int Permutations { get; set; } = 0; diff --git a/GsaGH/Parameters/5_Results/2_Results/IGsaResult.cs b/GsaGH/Parameters/5_Results/2_Results/IGsaResult.cs index cc89b26e7..377c9f353 100644 --- a/GsaGH/Parameters/5_Results/2_Results/IGsaResult.cs +++ b/GsaGH/Parameters/5_Results/2_Results/IGsaResult.cs @@ -1,6 +1,18 @@ using System.Collections.Generic; namespace GsaGH.Parameters.Results { + /// + /// A Result is used to select Cases from an analysed and extract the values for post-processing or visualisation. + /// The following result types can be extracted if they are present in the model: + /// + /// Node Results: `Displacement` and `Reaction`. + /// 1D Element Results: `Displacement`, `Force` and `StrainEnergyDensity`. + /// 2D Element Results: `Displacement`, `Force`, `Moment`, `Shear` and `Stress`. + /// 3D Element Results: `Displacement` and `Stress`. + /// Global Results: `Frequency`, `LoadFactor`, `ModalGeometricStiffness`, `ModalMass`, `ModalStiffness`, `TotalLoad`, `TotalReaction`, `Mode`, `EffectiveInertia`, `EffectiveMass` and `Eigenvalue`. + /// + /// All result values from the .NET API have been wrapped in Unit Number and can be converted into different measures on the fly. The Result parameter caches the result values. + /// public interface IGsaResult { public int CaseId { get; } public string CaseName { get; }