# LoadWizards
# MemberLoadFromAreaLoadWizard
Kind: global class
# new MemberLoadFromAreaLoadWizard(no, load_case, comment, params)
Creates member load wizard
Param | Type | Description |
---|---|---|
no | Number | Member load wizard index, can be undefined |
load_case | Object | Load case |
comment | String | Comment, can be undefined |
params | Object | Additional parameters, can be undefined |
# memberLoadFromAreaLoadWizard.Uniform(no, load_case, uniform_magnitude, coordinate_system, load_direction, comment, params)
Creates uniform member load wizard
Kind: instance method of MemberLoadFromAreaLoadWizard
Param | Type | Description |
---|---|---|
no | Number | Member load wizard index, can be undefined |
load_case | Object | Load case |
uniform_magnitude | Number | Uniform load magnitude |
coordinate_system | Number | Index of coordinate system, can be undefined (Global XYZ as default) |
load_direction | String | Load direction, can be undefined (ZA as default) |
comment | String | Comment, can be undefined |
params | Object | Additional parameters |
# memberLoadFromAreaLoadWizard.Linear(no, load_case, magnitude_1, node_1, magnitude_2, node_2, magnitude_3, node_3, coordinate_system, load_direction, comment, params)
Creates linear member load wizard
Kind: instance method of MemberLoadFromAreaLoadWizard
Param | Type | Description |
---|---|---|
no | Number | Member load wizard index, can be undefined |
load_case | Object | Load case |
magnitude_1 | Number | First area load magnitude |
node_1 | Number | Index of first node |
magnitude_2 | Number | Second area load magnitude |
node_2 | Number | Index of second node |
magnitude_3 | Number | Third area load magnitude |
node_3 | Number | Index of third node |
coordinate_system | Number | Index of coordinate system, can be undefined (Global XYZ as default) |
load_direction | String | Load direction, can be undefined (ZA as default) |
comment | String | Comment, can be undefined |
params | Object | Additional parameters |
# memberLoadFromAreaLoadWizard.VaryingInX(no, load_case, load_distribution_values, coordinate_system, load_direction, comment, params)
Creates varying in X member load wizard
Kind: instance method of MemberLoadFromAreaLoadWizard
Param | Type | Description |
---|---|---|
no | Number | Index of member load wizard |
load_case | Object | Load case |
load_distribution_values | Array | Load distribution values ([Y1, ΔY1, p1, ... Yn, ΔYn, pn]) |
coordinate_system | Number | Index of coordinate system, can be undefined (Global XYZ as default) |
load_direction | String | Load direction, can be undefined (ZA as default) |
comment | String | Comment, can be undefined |
params | Object | Additional parameters |
# memberLoadFromAreaLoadWizard.VaryingInY(no, load_case, load_distribution_values, coordinate_system, load_direction, comment, params)
Creates varying in Y member load wizard
Kind: instance method of MemberLoadFromAreaLoadWizard
Param | Type | Description |
---|---|---|
no | Number | Index of member load wizard |
load_case | Object | Load case |
load_distribution_values | Array | Load distribution values ([Y1, ΔY1, p1, ... Yn, ΔYn, pn]) |
coordinate_system | Number | Index of coordinate system, can be undefined (Global XYZ as default) |
load_direction | String | Load direction, can be undefined (ZA as default) |
comment | String | Comment, can be undefined |
params | Object | Additional parameters |
# memberLoadFromAreaLoadWizard.VaryingInZ(no, load_case, load_distribution_values, coordinate_system, load_direction, comment, params)
Creates varying in Z member load wizard
Kind: instance method of MemberLoadFromAreaLoadWizard
Param | Type | Description |
---|---|---|
no | Number | Index of member load wizard |
load_case | Object | Load case |
load_distribution_values | Array | Load distribution values ([Y1, ΔY1, p1, ... Yn, ΔYn, pn]) |
coordinate_system | Number | Index of coordinate system, can be undefined (Global XYZ as default) |
load_direction | String | Load direction, can be undefined (ZA as default) |
comment | String | Comment, can be undefined |
params | Object | Additional parameters |
# memberLoadFromAreaLoadWizard.SetCornerNodes(corner_nodes)
Sets corner nodes for member load from area load wizard
Kind: instance method of MemberLoadFromAreaLoadWizard
Param | Type | Description |
---|---|---|
corner_nodes | Array | Corner nodes (["1,2,3", "4-8", ...]) |
# memberLoadFromAreaLoadWizard.SetExcludedMembers(excluded_members, excluded_parallel_members)
Sets excluded members for member load from area load wizard
Kind: instance method of MemberLoadFromAreaLoadWizard
Param | Type | Description |
---|---|---|
excluded_members | Array | Single members |
excluded_parallel_members | Array | Members parallel to member |
# memberLoadFromAreaLoadWizard.LockForNewMembers(lock_for_new_members)
Sets lock for new members
Kind: instance method of MemberLoadFromAreaLoadWizard
Param | Type | Description |
---|---|---|
lock_for_new_members | Boolean | Lock for new members, can be undefined (true as default) |
# memberLoadFromAreaLoadWizard.SmoothConcentratedLoad(smooth_punctual_load_enabled)
Sets smooth concentrated load
Kind: instance method of MemberLoadFromAreaLoadWizard
Param | Type | Description |
---|---|---|
smooth_punctual_load_enabled | Boolean | Smooth concentrated load enabled, can be undefined (true as default) |
# memberLoadFromAreaLoadWizard.ConsiderMemberEccentricity(consider_member_eccentricity)
Sets consider member eccentricity
Kind: instance method of MemberLoadFromAreaLoadWizard
Param | Type | Description |
---|---|---|
consider_member_eccentricity | Boolean | Consider member eccentricity, can be undefined (true as default) |
# memberLoadFromAreaLoadWizard.ConsiderSectionDistribution(consider_section_distribution)
Sets consider section distribution
Kind: instance method of MemberLoadFromAreaLoadWizard
Param | Type | Description |
---|---|---|
consider_section_distribution | Boolean | Consider section distribution, can be undefined (true as default) |
# memberLoadFromAreaLoadWizard.AbsoluteToleranceForMembersOnPlane(absolute_tolerance)
Sets absolute tolerance for member on plane
Kind: instance method of MemberLoadFromAreaLoadWizard
Param | Type | Description |
---|---|---|
absolute_tolerance | Number | Absolute tolerance by distance, can be undefined (0.0005 as default) |
# memberLoadFromAreaLoadWizard.RelativeToleranceForMembersOnPlane(relative_tolerance)
Sets relative tolerance for member on plane
Kind: instance method of MemberLoadFromAreaLoadWizard
Param | Type | Description |
---|---|---|
relative_tolerance | Number | Relative tolerance by angle, can be undefined (1.0 by default) |
# memberLoadFromAreaLoadWizard.AbsoluteToleranceForNodesOnLine(absolute_tolerance)
Sets absolute tolerance for nodes on line
Kind: instance method of MemberLoadFromAreaLoadWizard
Param | Type | Description |
---|---|---|
absolute_tolerance | Number | Absolute tolerance by distance, can be undefined (0.0005 as default) |
# memberLoadFromAreaLoadWizard.RelativeToleranceForNodesOnLine(relative_tolerance)
Sets relative tolerance for nodes on line
Kind: instance method of MemberLoadFromAreaLoadWizard
Param | Type | Description |
---|---|---|
relative_tolerance | Number | Relative tolerance by angle, can be undefined (1.0 by default) |
# MemberLoadFromFreeLineLoadWizard
Kind: global class
# new MemberLoadFromFreeLineLoadWizard(no, load_case, comment, params)
Creates member load wizard
Param | Type | Description |
---|---|---|
no | Number | Member load wizard index, can be undefined |
load_case | Object | Load case |
comment | String | Comment, can be undefined |
params | Object | Additional parameters, can be undefined |
# memberLoadFromFreeLineLoadWizard.Uniform(no, load_case, uniform_magnitude, node_1, node_2, coordinate_system, load_direction, comment, params)
Creates uniform member load wizard
Kind: instance method of MemberLoadFromFreeLineLoadWizard
Param | Type | Description |
---|---|---|
no | Number | Member load wizard index, can be undefined |
load_case | Object | Load case |
uniform_magnitude | Number | Uniform load magnitude |
node_1 | Number | Index of first node |
node_2 | Number | Index of second node |
coordinate_system | Number | Index of coordinate system, can be undefined (Global XYZ as default) |
load_direction | String | Load direction, can be undefined (ZA as default) |
comment | String | Comment, can be undefined |
params | Object | Additional parameters, can be undefined |
# memberLoadFromFreeLineLoadWizard.Linear(no, load_case, magnitude_1, node_1, magnitude_2, node_2, coordinate_system, load_direction, comment, params)
Creates linear member load wizard
Kind: instance method of MemberLoadFromFreeLineLoadWizard
Param | Type | Description |
---|---|---|
no | Number | Member load wizard index, can be undefined |
load_case | Object | Load case |
magnitude_1 | Number | First area load magnitude |
node_1 | Number | Index of first node |
magnitude_2 | Number | Second area load magnitude |
node_2 | Number | Index of second node |
coordinate_system | Number | Index of coordinate system, can be undefined (Global XYZ as default) |
load_direction | String | Load direction, can be undefined (ZA as default) |
comment | String | Comment, can be undefined |
params | Object | Additional parameters, can be undefined |
# memberLoadFromFreeLineLoadWizard.AbsoluteToleranceForMembersOnPlane(absolute_tolerance)
Sets absolute tolerance for member on plane
Kind: instance method of MemberLoadFromFreeLineLoadWizard
Param | Type | Description |
---|---|---|
absolute_tolerance | Number | Absolute tolerance by distance, can be undefined (0.0005 as default) |
# memberLoadFromFreeLineLoadWizard.RelativeToleranceForMembersOnPlane(relative_tolerance)
Sets relative tolerance for member on plane
Kind: instance method of MemberLoadFromFreeLineLoadWizard
Param | Type | Description |
---|---|---|
relative_tolerance | Number | Relative tolerance by angle, can be undefined (1.0 by default) |
# memberLoadFromFreeLineLoadWizard.AbsoluteToleranceForNodesOnLine(absolute_tolerance)
Sets absolute tolerance for nodes on line
Kind: instance method of MemberLoadFromFreeLineLoadWizard
Param | Type | Description |
---|---|---|
absolute_tolerance | Number | Absolute tolerance by distance, can be undefined (0.0005 as default) |
# memberLoadFromFreeLineLoadWizard.RelativeToleranceForNodesOnLine(relative_tolerance)
Sets relative tolerance for nodes on line
Kind: instance method of MemberLoadFromFreeLineLoadWizard
Param | Type | Description |
---|---|---|
relative_tolerance | Number | Relative tolerance by angle, can be undefined (1.0 by default) |
# memberLoadFromFreeLineLoadWizard.ExcludedMembers(excluded_members, excluded_parallel_members)
Sets excluded members
Kind: instance method of MemberLoadFromFreeLineLoadWizard
Param | Type | Description |
---|---|---|
excluded_members | Array | List of excluded member indexes, can be undefined |
excluded_parallel_members | Array | List of excluded parallel members, can be undefined |
# memberLoadFromFreeLineLoadWizard.LockForNewMembers(lock_for_new_members)
Sets lock for new members
Kind: instance method of MemberLoadFromFreeLineLoadWizard
Param | Type | Description |
---|---|---|
lock_for_new_members | Boolean | Lock for new members, can be undefined (true as default) |
# memberLoadFromFreeLineLoadWizard.ConsiderMemberEccentricity(consider_member_eccentricity)
Sets consider member eccentricity
Kind: instance method of MemberLoadFromFreeLineLoadWizard
Param | Type | Description |
---|---|---|
consider_member_eccentricity | Boolean | Consider member eccentricity, can be undefined (true as default) |
# memberLoadFromFreeLineLoadWizard.ConsiderSectionDistribution(consider_section_distribution)
Sets consider section distribution
Kind: instance method of MemberLoadFromFreeLineLoadWizard
Param | Type | Description |
---|---|---|
consider_section_distribution | Boolean | Consider section distribution, can be undefined (true as default) |
# SnowLoadWizard
Kind: global class
# new SnowLoadWizard(no, comment, params)
Creates empty snow load wizard
Param | Type | Description |
---|---|---|
no | Number | Snow load wizard index, can be undefined |
comment | String | Comment, can be undefined |
params | Object | Additional parameters, can be undefined |
# snowLoadWizard.SetMonoPitchRoofType(no, roof_corner_nodes, load_case, comment, params)
Creates flat/monopitch snow load wizard
Kind: instance method of SnowLoadWizard
Param | Type | Description |
---|---|---|
no | Number | Snow load wizard index, can be undefined |
roof_corner_nodes | Array | Roofs corner nodes indexes |
load_case | Object | Load case |
comment | String | Comment, can be undefined |
params | Object | Additional parameters, can be undefined |
# snowLoadWizard.SetDuopitch(no, roof_corner_nodes, load_case_1, load_case_2, load_case_3, comment, params)
Creates duopitch snow load wizard
Kind: instance method of SnowLoadWizard
Param | Type | Description |
---|---|---|
no | Number | Snow load wizard index, can be undefined |
roof_corner_nodes | Array | Roofs corner nodes indexes |
load_case_1 | Object | Load case (Case i) |
load_case_2 | Object | Load case (Case ii) |
load_case_3 | Object | Load case (Case iii) |
comment | String | Comment, can be undefined |
params | Object | Additional parameters, can be undefined |
# snowLoadWizard.SetLoadedRoofs(loaded_planes_accessibility)
Sets loaded roofs
Kind: instance method of SnowLoadWizard
Param | Type | Description |
---|---|---|
loaded_planes_accessibility | Array | Enable or disable loaded roofs (array of booleans [roof1 or roof1, roof2]) |
# snowLoadWizard.WithoutLoadsOnMembers(objects_without_loads, objects_without_loads_parallel_to)
Generated on members
Kind: instance method of SnowLoadWizard
Param | Type | Description |
---|---|---|
objects_without_loads | Array | Without load on members, can be undefined |
objects_without_loads_parallel_to | Array | Without load parallel to members, can be undefined |
# snowLoadWizard.WithoutLoadsOnSurfaces(objects_without_loads, objects_without_loads_parallel_to)
Generated on surfaces
Kind: instance method of SnowLoadWizard
Param | Type | Description |
---|---|---|
objects_without_loads | Array | Without load on surfaces, can be undefined |
objects_without_loads_parallel_to | Array | Without load parallel to surfaces, can be undefined |
# snowLoadWizard.WithoutLoadsOnLines(objects_without_loads, objects_without_loads_parallel_to)
Generated on lines
Kind: instance method of SnowLoadWizard
Param | Type | Description |
---|---|---|
objects_without_loads | Array | Without load on lines, can be undefined |
objects_without_loads_parallel_to | Array | Without load parallel to lines, can be undefined |
# snowLoadWizard.SnowOverhang(enabled)
Sets snow overhang
Kind: instance method of SnowLoadWizard
Param | Type | Description |
---|---|---|
enabled | Boolean | Can be undefined, true as default |
# snowLoadWizard.SnowGuard(enabled)
Sets snow guard
Kind: instance method of SnowLoadWizard
Param | Type | Description |
---|---|---|
enabled | Boolean | Can be undefined, true as default |
# snowLoadWizard.LockForNewObjects(enabled)
Sets lock for new members
Kind: instance method of SnowLoadWizard
Param | Type | Description |
---|---|---|
enabled | Boolean | Can be undefined, true as default |
# snowLoadWizard.ConsiderMemberEccentricity(enabled)
Sets consider member eccentricity
Kind: instance method of SnowLoadWizard
Param | Type | Description |
---|---|---|
enabled | Boolean | Can be undefined, true as default |
# snowLoadWizard.ConsiderSectionDistribution(enabled)
Sets consider section distribution
Kind: instance method of SnowLoadWizard
Param | Type | Description |
---|---|---|
enabled | Boolean | Can be undefined, true as default |
# WindLoadWizard
Kind: global class
# new WindLoadWizard(no, comment, params)
Creates empty wind load wizard
Param | Type | Description |
---|---|---|
no | Number | Wind load wizard index, can be undefined |
comment | String | Comment, can be undefined |
params | Object | Additional parameters, can be undefined |
# windLoadWizard.WallsRoofMonopitch(no, base_corner_nodes, roof_corner_nodes, load_cases, wind_directions, comment, params)
Creates vertical walls with flat/monopitch roof
Kind: instance method of WindLoadWizard
Param | Type | Description |
---|---|---|
no | Number | Wind load wizard index, can be undefined |
base_corner_nodes | Array | Base corner nodes indexes |
roof_corner_nodes | Array | Roof corner nodes indexes |
load_cases | Array | Load case 1, load case 2 |
wind_directions | Array | Wind directions (roof sides accessibility), can be undefined, for info setWindDirections function |
comment | String | Comment, can be undefined |
params | Object | Additional parameters, can be undefined |
# windLoadWizard.WallsRoofDuoPitch(no, base_corner_nodes, roof_corner_nodes, load_cases, wind_directions, comment, params)
Creates vertical walls with duopitch roof
Kind: instance method of WindLoadWizard
Param | Type | Description |
---|---|---|
no | Number | Wind load wizard index, can be undefined |
base_corner_nodes | Array | Base corner nodes indexes |
roof_corner_nodes | Array | Roof corner nodes indexes |
load_cases | Array | Load cases |
wind_directions | Array | Wind directions (roof sides accessibility), can be undefined, for info setWindDirections function |
comment | String | Comment, can be undefined |
params | Object | Additional parameters, can be undefined |
# windLoadWizard.RoofMonoPitch(no, roof_corner_nodes, load_cases, wind_directions, comment, params)
Creates flat/monopitch roof
Kind: instance method of WindLoadWizard
Param | Type | Description |
---|---|---|
no | Number | Wind load wizard index, can be undefined |
roof_corner_nodes | Array | Roof corner nodes indexes |
load_cases | Array | Load cases |
wind_directions | Array | Wind directions (roof sides accessibility), can be undefined, for info setWindDirections function |
comment | String | Comment, can be undefined |
params | Object | Additional parameters, can be undefined |
# windLoadWizard.RoofDuopitch(no, roof_corner_nodes, load_cases, wind_directions, comment, params)
Creates duopitch roof
Kind: instance method of WindLoadWizard
Param | Type | Description |
---|---|---|
no | Number | Wind load wizard index, can be undefined |
roof_corner_nodes | Array | Roof corner nodes indexes |
load_cases | Array | Load cases |
wind_directions | Array | Wind directions (roof sides accessibility), can be undefined, for info setWindDirections function |
comment | String | Comment, can be undefined |
params | Object | Additional parameters, can be undefined |
# windLoadWizard.SetLoadedWallsAndRoofs(roofs_accessibility)
Sets loaded walls/roofs
Kind: instance method of WindLoadWizard
Param | Type | Description |
---|---|---|
roofs_accessibility | Array | Roofs/walls accessibility [Wall 1, Wall 2, Wall 3, Wall4] (Vertical walls with flat/monopitch roof, Vertical walls with duopitch roof) [Roof 1] (Flat/monopitch roof) [Roof 1, Roof 2] (Duopitch roof) |
# windLoadWizard.WithoutLoadsOnMembers(objects_without_loads, objects_without_loads_parallel_to)
Generated on members
Kind: instance method of WindLoadWizard
Param | Type | Description |
---|---|---|
objects_without_loads | Array | Without load on members, can be undefined |
objects_without_loads_parallel_to | Array | Without load parallel to members, can be undefined |
# windLoadWizard.WithoutLoadsOnSurfaces(objects_without_loads, objects_without_loads_parallel_to)
Generated on surfaces
Kind: instance method of WindLoadWizard
Param | Type | Description |
---|---|---|
objects_without_loads | Array | Without load on surfaces, can be undefined |
objects_without_loads_parallel_to | Array | Without load parallel to surfaces, can be undefined |
# windLoadWizard.WithoutLoadsOnLines(objects_without_loads, objects_without_loads_parallel_to)
Generated on lines
Kind: instance method of WindLoadWizard
Param | Type | Description |
---|---|---|
objects_without_loads | Array | Without load on lines, can be undefined |
objects_without_loads_parallel_to | Array | Without load parallel to lines, can be undefined |
# windLoadWizard.LockForNewObjects(enabled)
Sets lock for new members
Kind: instance method of WindLoadWizard
Param | Type | Description |
---|---|---|
enabled | Boolean | Can be undefined, true as default |
# windLoadWizard.ConsiderMemberEccentricity(enabled)
Sets consider member eccentricity
Kind: instance method of WindLoadWizard
Param | Type | Description |
---|---|---|
enabled | Boolean | Can be undefined, true as default |
# windLoadWizard.ConsiderSectionDistribution(enabled)
Sets consider section distribution
Kind: instance method of WindLoadWizard
Param | Type | Description |
---|---|---|
enabled | Boolean | Can be undefined, true as default |
# createBaseMemberLoadFromAreaLoadWizard(no, load_case, comment, params) ⇒
Creates member load wizard (private)
Kind: global function
Returns: Created member load wizard
Param | Type | Description |
---|---|---|
no | Number | Member load wizard index, can be undefined |
load_case | Object | Load case |
comment | String | Comment |
params | Object | Additional parameters |
# setMemberLoadFromAreaLoadWizardDistribution(member_wizard, load_distribution, load_distribution_values) ⇒
Sets load distribution to member load wizard (private)
Kind: global function
Returns: Modified member load wizard
Param | Type | Description |
---|---|---|
member_wizard | Object | Member load wizard |
load_distribution | Number | Load distribution |
load_distribution_values | Array | Load distribution values |
# createBaseMemberLoadFromFreeLineLoadWizard(no, load_case, comment, params) ⇒
Creates member load wizard (private)
Kind: global function
Returns: Created member load wizard
Param | Type | Description |
---|---|---|
no | Number | Member load wizard index, can be undefined |
load_case | Object | Load case |
comment | String | Comment, can be undefined |
params | Object | Additional parameters, can be undefined |
# setMemberLoadFromFreeLineLoadWizardDistribution(member_wizard, load_distribution, load_distribution_values) ⇒
Sets load distribution to member load wizard (private)
Kind: global function
Returns: Modified member load wizard
Param | Type | Description |
---|---|---|
member_wizard | Object | Member load wizard |
load_distribution | Number | Load distribution |
load_distribution_values | Array | Load distribution values |
# withoutLoadsOn(snow_load_wizard, table_row, objects_without_loads, objects_without_loads_parallel_to)
Sets objects without load (private)
Kind: global function
Param | Type | Description |
---|---|---|
snow_load_wizard | Object | Snow load wizard |
table_row | Number | Table row to which values hes to be set |
objects_without_loads | Array | Object's indexes without loads |
objects_without_loads_parallel_to | Array | Object's indexes without loads parallel to |
# createSnowLoadWizard(no, comment, params)
Creates empty snow load wizard (private)
Kind: global function
Param | Type | Description |
---|---|---|
no | Number | Snow load wizard index, can be undefined |
comment | String | Comment, can be undefined |
params | Object | Additional parameters, can be undefined |
# setWindDirections(wind_load_wizard, roof_sides_accessibility)
Sets wind perpendicular to roofs (private)
Kind: global function
Param | Type | Description |
---|---|---|
wind_load_wizard | Object | Wind load wizard to set |
roof_sides_accessibility | Array | Roof sides accessibility [Wall 1, Wall 2, Wall 3, Wall 4] (Vertical walls with flat/monopitch roof, Vertical walls with duopitch roof) [Direction 1, Direction 2, Direction 3, Direction 4] (Flat monopitch roof, Duopitch roof) |
# withoutLoadsOn(wind_load_wizard, table_row, objects_without_loads, objects_without_loads_parallel_to)
Sets objects without load (private)
Kind: global function
Param | Type | Description |
---|---|---|
wind_load_wizard | Object | Wind load wizard |
table_row | Number | Table row to which values hes to be set |
objects_without_loads | Array | Object's indexes without loads |
objects_without_loads_parallel_to | Array | Object's indexes without loads parallel to |
# createWindLoadWizard(no, comment, params)
Creates empty wind load wizard (private)
Kind: global function
Param | Type | Description |
---|---|---|
no | Number | Wind load wizard index, can be undefined |
comment | String | Comment, can be undefined |
params | Object | Additional parameters, can be undefined |
← Loads SpecialObjects →