Skip to content

Commit 37cdd32

Browse files
Josef TaylorIsakNaslundBh
authored andcommitted
adding method descriptions
1 parent 0ff81d4 commit 37cdd32

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

RAM_Engine/Create/UniformLoadSet/RAMUniformLoadSet.cs

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,24 @@
3131
using RAMDATAACCESSLib;
3232
using BH.Engine.Reflection;
3333
using BH.oM.Reflection.Attributes;
34+
using System.ComponentModel;
3435

3536

3637
namespace BH.Engine.Adapters.RAM
3738
{
3839
public static partial class Create
3940
{
4041
[PreviousVersion("4.2","BH.Engine.Adapters.RAM.Create.CreateRAMUniformLoadSet(System.Double, System.Double, System.Double, BH.oM.Adapters.RAM.RAMLiveLoadTypes, System.Double, System.Double, System.Double, System.String)")]
42+
[Description("Creates a UniformLoadSet specifically for use in RAM. RAM has built-in loadcases, so other loadcases must be mapped to them.")]
43+
[Input("sdl", "post-composite dead load which is applied to cured concrete decks, i.e. (assuming self weight of slab is set to be counted in the Self-Weight Criteria menu).")]
44+
[Input("cdl", "pre-composite dead load including any allowance for ponding (assuming self weight of slab is set to be counted in the Self-Weight Criteria menu).")]
45+
[Input("liveLoad","loads to be applied post composite such as occupancy loads. These should generally be entered without reduction.")]
46+
[Input("llType","sets a flag for which type of live load has been entered, which impacts how the program will apply reduction or combine with snow loading.")]
47+
[Input("partition","additional live loads such as partitions which will not be reduced, regardless of the value of llType.")]
48+
[Input("cll", "live loads from construction activities which will be present during the pre-composite stage.")]
49+
[Input("massDl", "dead loads which contribute to lateral mass of the building, does not include self weight of modelled elements provided Self-Weight is accounted for in the Criteria. Generally this value will be similar to the SDL value")]
50+
[Input("name", "A useful and descriptive name which will be used in RAM to refer to this set of loads.")]
51+
[Output("a set of area loads suitable for pushing to RAM.")]
4152
public static UniformLoadSet RAMUniformLoadSet(double sdl, double cdl, double liveLoad, RAMLiveLoadTypes llType, double partition, double cll, double massDl, string name = "")
4253
{
4354

0 commit comments

Comments
 (0)