Skip to content
This repository was archived by the owner on Apr 23, 2025. It is now read-only.

Commit 7e53e41

Browse files
committed
Prepared for code review
1 parent 6dab709 commit 7e53e41

20 files changed

Lines changed: 383 additions & 236 deletions

examples/high_level_functions_demos/addon_steel_design.js

Lines changed: 67 additions & 42 deletions
Large diffs are not rendered by default.

includes/AddOns/SteelDesign/FireResistanceConfiguration.js

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,19 @@
66
/**
77
* Creates Steel Design Fire resistance Configuration
88
* @param {Number} no Fire resistance Configuration index, can be undefined
9-
* @param {String} name Fire resistance Configuration name, can be undefined
109
* @param {Array} members_no List of members assigned, can be undefined
1110
* @param {Array} member_sets_no List of member sets assigned, can be undefined
1211
* @param {String} comment Comment, can be undefined
1312
* @param {Object} params Additional parameters, can be undefined
1413
*/
1514
function SteelDesignFireResistanceConfiguration (no,
16-
name,
1715
members_no,
1816
member_sets_no,
1917
comment,
2018
params) {
2119
ASSERT(STEEL_DESIGN.isActive(), "Steel design add-on must be active");
2220
ASSERT(IsCurrentCodeOfStandard("EN") || IsCurrentCodeOfStandard("NTC"), "Fire resistance configuration is available only for EN, NTC code of standards");
23-
this.addon = createBaseSteelDesignConfiguration(STEEL_DESIGN.steel_design_fr_configurations, no, name, members_no, member_sets_no, comment, params);
21+
this.addon = createBaseSteelDesignConfiguration(STEEL_DESIGN.steel_design_fr_configurations, no, members_no, member_sets_no, comment, params);
2422
}
2523

2624
/**
@@ -37,6 +35,15 @@ SteelDesignFireResistanceConfiguration.prototype.GetFireResistanceConfiguration
3735
return this.addon;
3836
};
3937

38+
/**
39+
* Sets Name
40+
* @param {String} name Fire resistance Configuration name, can be undefined
41+
*/
42+
SteelDesignFireResistanceConfiguration.prototype.SetName = function (name) {
43+
ASSERT(typeof name !== "undefined", "Name must be specified");
44+
this.addon.name = name;
45+
};
46+
4047
/**
4148
* Defines final temperature
4249
* @param {String} property_define_final_temperature Final temperature (MANUALLY, ANALYTICALLY), can be undefined (is not set, ANALYTICALLY as default)
@@ -46,7 +53,7 @@ SteelDesignFireResistanceConfiguration.prototype.FinalTemperature = function (pr
4653
var container = this.addon.settings_ec3;
4754
}
4855
else if (IsCurrentCodeOfStandard("NTC")) {
49-
ASSERT(false, "No API support fo NTC code of standard");
56+
ASSERT(false, "No API support for NTC code of standard");
5057
}
5158
else {
5259
ASSERT(false, "Unsupported code of standard");
@@ -73,7 +80,7 @@ SteelDesignFireResistanceConfiguration.prototype.AnalyticallyDesignSettings = fu
7380
var container = this.addon.settings_ec3;
7481
}
7582
else if (IsCurrentCodeOfStandard("NTC")) {
76-
ASSERT(false, "No API support fo NTC code of standard");
83+
ASSERT(false, "No API support for NTC code of standard");
7784
}
7885
else {
7986
ASSERT(false, "Unsupported code of standard");
@@ -99,7 +106,7 @@ SteelDesignFireResistanceConfiguration.prototype.AnalyticallyFireProtection = fu
99106
var container = this.addon.settings_ec3;
100107
}
101108
else if (IsCurrentCodeOfStandard("NTC")) {
102-
ASSERT(false, "No API support fo NTC code of standard");
109+
ASSERT(false, "No API support for NTC code of standard");
103110
}
104111
else {
105112
ASSERT(false, "Unsupported code of standard");
@@ -149,7 +156,7 @@ SteelDesignFireResistanceConfiguration.prototype.AnalyticallyThermalActions = fu
149156
var container = this.addon.settings_ec3;
150157
}
151158
else if (IsCurrentCodeOfStandard("NTC")) {
152-
ASSERT(false, "No API support fo NTC code of standard");
159+
ASSERT(false, "No API support for NTC code of standard");
153160
}
154161
else {
155162
ASSERT(false, "Unsupported code of standard");
@@ -171,7 +178,7 @@ SteelDesignFireResistanceConfiguration.prototype.ManuallyFinalTemperature = func
171178
var container = this.addon.settings_ec3;
172179
}
173180
else if (IsCurrentCodeOfStandard("NTC")) {
174-
ASSERT(false, "No API support fo NTC code of standard");
181+
ASSERT(false, "No API support for NTC code of standard");
175182
}
176183
else {
177184
ASSERT(false, "Unsupported code of standard");

includes/AddOns/SteelDesign/ServiceabilityConfiguration.js

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,43 @@
11
/**
22
* Creates Steel Design Serviceability Configuration
3-
* @param {Number} no Serviceability Configuration index, can be undefined
4-
* @param {String} name Serviceability Configuration name, can be undefined
3+
* @param {Number} no Serviceability configuration index, can be undefined
54
* @param {Array} members_no List of members assigned, can be undefined
65
* @param {Array} member_sets_no List of member sets assigned, can be undefined
76
* @param {String} comment Comment, can be undefined
87
* @param {Object} params Additional parameters, can be undefined
98
*/
109
function SteelDesignServiceabilityConfiguration (no,
11-
name,
1210
members_no,
1311
member_sets_no,
1412
comment,
1513
params) {
1614
ASSERT(STEEL_DESIGN.isActive(), "Steel design add-on must be active");
17-
this.addon = createBaseSteelDesignConfiguration(STEEL_DESIGN.steel_design_sls_configurations, no, name, members_no, member_sets_no, comment, params);
15+
this.addon = createBaseSteelDesignConfiguration(STEEL_DESIGN.steel_design_sls_configurations, no, members_no, member_sets_no, comment, params);
1816
}
1917

2018
/**
21-
* @returns Serviceability Configuration index
19+
* @returns Serviceability configuration index
2220
*/
2321
SteelDesignServiceabilityConfiguration.prototype.GetNo = function () {
2422
return this.addon.no;
2523
};
2624

2725
/**
28-
* @returns Serviceability Configuration object
26+
* @returns Serviceability configuration object
2927
*/
3028
SteelDesignServiceabilityConfiguration.prototype.GetServiceabilityConfiguration = function () {
3129
return this.addon;
3230
};
3331

32+
/**
33+
* Sets Name
34+
* @param {String} name Serviceability configuration name, can be undefined
35+
*/
36+
SteelDesignServiceabilityConfiguration.prototype.SetName = function (name) {
37+
ASSERT(typeof name !== "undefined", "Name must be specified");
38+
this.addon.name = name;
39+
};
40+
3441
/**
3542
* Sets Design parameters
3643
* @param {Number} property_sl_beam_limit_characteristic Beam limits - action combination, characteristic, can be undefined (is not set, 300 as default)

includes/AddOns/SteelDesign/SteelDesignSupport.js

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ Member sets cannot be set?? What condition for member sets?
44

55
function createBaseSteelDesignConfiguration (object_to_create,
66
no,
7-
name,
87
members_no,
98
member_sets_no,
109
comment,
@@ -16,9 +15,6 @@ function createBaseSteelDesignConfiguration (object_to_create,
1615
else {
1716
addon = object_to_create.create(no);
1817
}
19-
if (typeof name !== "undefined") {
20-
addon.name = name;
21-
}
2218
setSteelDesign_Members(addon, members_no, member_sets_no);
2319
set_comment_and_parameters(addon, comment, params);
2420
return addon;

includes/AddOns/SteelDesign/StrengthConfigurationAISC.js

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,18 @@
11
/**
2-
* Creates Steel Design Strength Configuration
2+
* Creates Steel Design Strength Configuration for AISC code of standard
33
* @param {Number} no Strength Configuration index, can be undefined
4-
* @param {String} name Strength Configuration name, can be undefined
54
* @param {Array} members_no List of members assigned, can be undefined
65
* @param {Array} member_sets_no List of member sets assigned, can be undefined
76
* @param {String} comment Comment, can be undefined
87
* @param {Object} params Additional parameters, can be undefined
98
*/
109
function SteelDesignStrengthConfigurationAISC (no,
11-
name,
1210
members_no,
1311
member_sets_no,
1412
comment,
1513
params) {
1614
ASSERT(STEEL_DESIGN.isActive(), "Steel design add-on must be active");
17-
this.addon = createBaseSteelDesignConfiguration(STEEL_DESIGN.steel_design_uls_configurations, no, name, members_no, member_sets_no, comment, params);
15+
this.addon = createBaseSteelDesignConfiguration(STEEL_DESIGN.steel_design_uls_configurations, no, members_no, member_sets_no, comment, params);
1816
}
1917

2018
/**
@@ -31,14 +29,24 @@ SteelDesignStrengthConfigurationAISC.prototype.GetUltimateConfiguration = functi
3129
return this.addon;
3230
};
3331

32+
/**
33+
* Sets Name
34+
* @param {String} name Fire resistance Configuration name, can be undefined
35+
*/
36+
SteelDesignStrengthConfigurationAISC.prototype.SetName = function (name) {
37+
ASSERT(typeof name !== "undefined", "Name must be specified");
38+
this.addon.name = name;
39+
};
40+
3441
/**
3542
* Sets general design parameters
36-
* @param {Boolean} property_perform_stability_analysis Perform stability design, can be undefined (is not set, true as default)
43+
* @param {Boolean} property_perform_stability_analysis Perform stability design, can be undefined (true as default)
3744
*/
3845
SteelDesignStrengthConfigurationAISC.prototype.General = function (property_perform_stability_analysis) {
39-
if (typeof property_perform_stability_analysis !== "undefined") {
40-
this.addon.settings_aisc.property_perform_stability_analysis = property_perform_stability_analysis;
46+
if (typeof property_perform_stability_analysis === "undefined") {
47+
property_perform_stability_analysis = true;
4148
}
49+
this.addon.settings_aisc.property_perform_stability_analysis = property_perform_stability_analysis;
4250
};
4351

4452
/**

includes/AddOns/SteelDesign/UltimateConfigurationAS.js

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,18 @@
11
/**
2-
* Creates Steel Design Ultimate Configuration
2+
* Creates Steel Design Ultimate Configuration for AS code of standard
33
* @param {Number} no Ultimate Configuration index, can be undefined
4-
* @param {String} name Ultimate Configuration name, can be undefined
54
* @param {Array} members_no List of members assigned, can be undefined
65
* @param {Array} member_sets_no List of member sets assigned, can be undefined
76
* @param {String} comment Comment, can be undefined
87
* @param {Object} params Additional parameters, can be undefined
98
*/
109
function SteelDesignUltimateConfigurationAS (no,
11-
name,
1210
members_no,
1311
member_sets_no,
1412
comment,
1513
params) {
1614
ASSERT(STEEL_DESIGN.isActive(), "Steel design add-on must be active");
17-
this.addon = createBaseSteelDesignConfiguration(STEEL_DESIGN.steel_design_uls_configurations, no, name, members_no, member_sets_no, comment, params);
15+
this.addon = createBaseSteelDesignConfiguration(STEEL_DESIGN.steel_design_uls_configurations, no, members_no, member_sets_no, comment, params);
1816
}
1917

2018
/**
@@ -31,14 +29,24 @@ SteelDesignUltimateConfigurationAS.prototype.GetUltimateConfiguration = function
3129
return this.addon;
3230
};
3331

32+
/**
33+
* Sets Name
34+
* @param {String} name Fire resistance Configuration name, can be undefined
35+
*/
36+
SteelDesignUltimateConfigurationAS.prototype.SetName = function (name) {
37+
ASSERT(typeof name !== "undefined", "Name must be specified");
38+
this.addon.name = name;
39+
};
40+
3441
/**
3542
* Sets general design parameters
36-
* @param {Boolean} property_perform_stability_analysis Perform stability design, can be undefined (is not set, true as default)
43+
* @param {Boolean} property_perform_stability_analysis Perform stability design, can be undefined (true as default)
3744
*/
3845
SteelDesignUltimateConfigurationAS.prototype.General = function (property_perform_stability_analysis) {
39-
if (typeof property_perform_stability_analysis !== "undefined") {
40-
this.addon.settings_as4100.property_perform_stability_analysis = property_perform_stability_analysis;
46+
if (typeof property_perform_stability_analysis === "undefined") {
47+
property_perform_stability_analysis = true;
4148
}
49+
this.addon.settings_as4100.property_perform_stability_analysis = property_perform_stability_analysis;
4250
};
4351

4452
/**

includes/AddOns/SteelDesign/UltimateConfigurationBS.js

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,18 @@
11
/**
2-
* Creates Steel Design Ultimate Configuration
2+
* Creates Steel Design Ultimate Configuration for BS code of standard
33
* @param {Number} no Ultimate Configuration index, can be undefined
4-
* @param {String} name Ultimate Configuration name, can be undefined
54
* @param {Array} members_no List of members assigned, can be undefined
65
* @param {Array} member_sets_no List of member sets assigned, can be undefined
76
* @param {String} comment Comment, can be undefined
87
* @param {Object} params Additional parameters, can be undefined
98
*/
109
function SteelDesignUltimateConfigurationBS (no,
11-
name,
1210
members_no,
1311
member_sets_no,
1412
comment,
1513
params) {
1614
ASSERT(STEEL_DESIGN.isActive(), "Steel design add-on must be active");
17-
this.addon = createBaseSteelDesignConfiguration(STEEL_DESIGN.steel_design_uls_configurations, no, name, members_no, member_sets_no, comment, params);
15+
this.addon = createBaseSteelDesignConfiguration(STEEL_DESIGN.steel_design_uls_configurations, no, members_no, member_sets_no, comment, params);
1816
}
1917

2018
/**
@@ -31,14 +29,24 @@ SteelDesignUltimateConfigurationBS.prototype.GetUltimateConfiguration = function
3129
return this.addon;
3230
};
3331

32+
/**
33+
* Sets Name
34+
* @param {String} name Fire resistance Configuration name, can be undefined
35+
*/
36+
SteelDesignUltimateConfigurationBS.prototype.SetName = function (name) {
37+
ASSERT(typeof name !== "undefined", "Name must be specified");
38+
this.addon.name = name;
39+
};
40+
3441
/**
3542
* Sets general design parameters
36-
* @param {Boolean} property_perform_stability_analysis Perform stability design, can be undefined (is not set, true as default)
43+
* @param {Boolean} property_perform_stability_analysis Perform stability design, can be undefined (true as default)
3744
*/
3845
SteelDesignUltimateConfigurationBS.prototype.General = function (property_perform_stability_analysis) {
39-
if (typeof property_perform_stability_analysis !== "undefined") {
40-
this.addon.settings_bs5.property_perform_stability_analysis = property_perform_stability_analysis;
46+
if (typeof property_perform_stability_analysis === "undefined") {
47+
property_perform_stability_analysis = true;
4148
}
49+
this.addon.settings_bs5.property_perform_stability_analysis = property_perform_stability_analysis;
4250
};
4351

4452
/**

includes/AddOns/SteelDesign/UltimateConfigurationCSA.js

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,18 @@
11
/**
2-
* Creates Steel Design Ultimate Configuration
2+
* Creates Steel Design Ultimate Configuration for CSA code of standard
33
* @param {Number} no Ultimate Configuration index, can be undefined
4-
* @param {String} name Ultimate Configuration name, can be undefined
54
* @param {Array} members_no List of members assigned, can be undefined
65
* @param {Array} member_sets_no List of member sets assigned, can be undefined
76
* @param {String} comment Comment, can be undefined
87
* @param {Object} params Additional parameters, can be undefined
98
*/
109
function SteelDesignUltimateConfigurationCSA (no,
11-
name,
1210
members_no,
1311
member_sets_no,
1412
comment,
1513
params) {
1614
ASSERT(STEEL_DESIGN.isActive(), "Steel design add-on must be active");
17-
this.addon = createBaseSteelDesignConfiguration(STEEL_DESIGN.steel_design_uls_configurations, no, name, members_no, member_sets_no, comment, params);
15+
this.addon = createBaseSteelDesignConfiguration(STEEL_DESIGN.steel_design_uls_configurations, no, members_no, member_sets_no, comment, params);
1816
}
1917

2018
/**
@@ -31,14 +29,24 @@ SteelDesignUltimateConfigurationCSA.prototype.GetUltimateConfiguration = functio
3129
return this.addon;
3230
};
3331

32+
/**
33+
* Sets Name
34+
* @param {String} name Fire resistance Configuration name, can be undefined
35+
*/
36+
SteelDesignUltimateConfigurationCSA.prototype.SetName = function (name) {
37+
ASSERT(typeof name !== "undefined", "Name must be specified");
38+
this.addon.name = name;
39+
};
40+
3441
/**
3542
* Sets general design parameters
36-
* @param {Boolean} property_perform_stability_analysis Perform stability design, can be undefined (is not set, true as default)
43+
* @param {Boolean} property_perform_stability_analysis Perform stability design, can be undefined (true as default)
3744
*/
3845
SteelDesignUltimateConfigurationCSA.prototype.General = function (property_perform_stability_analysis) {
39-
if (typeof property_perform_stability_analysis !== "undefined") {
40-
this.addon.settings_csa.property_perform_stability_analysis = property_perform_stability_analysis;
46+
if (typeof property_perform_stability_analysis === "undefined") {
47+
property_perform_stability_analysis = true;
4148
}
49+
this.addon.settings_csa.property_perform_stability_analysis = property_perform_stability_analysis;
4250
};
4351

4452
/**

0 commit comments

Comments
 (0)