 | APIsetCombination Method |
Set a linear add combination from an existing loadcase. It can be called multiple times. If the loadcase is already in combination, change its factor.
REST path: /loadcase/combo/set/[name]/[loadcase]/[factor]/[type]/[servType]
REST verb: GET
Namespace: NextFEMapiAssembly: NextFEMapi (in NextFEMapi.dll) Version: 2.7.2.0 (2.7.2.0)
Syntaxpublic bool setCombination(
string name,
string loadcase,
double factor,
int type = 0,
int servType = 0
)
Public Function setCombination (
name As String,
loadcase As String,
factor As Double,
Optional type As Integer = 0,
Optional servType As Integer = 0
) As Boolean
Dim instance As API
Dim name As String
Dim loadcase As String
Dim factor As Double
Dim type As Integer
Dim servType As Integer
Dim returnValue As Boolean
returnValue = instance.setCombination(name,
loadcase, factor, type, servType)
public:
bool setCombination(
String^ name,
String^ loadcase,
double factor,
int type = 0,
int servType = 0
)
member setCombination :
name : string *
loadcase : string *
factor : float *
?type : int *
?servType : int
(* Defaults:
let _type = defaultArg type 0
let _servType = defaultArg servType 0
*)
-> bool Parameters
- name String
- Name of the loadcase to transform into a combination, or target combination
- loadcase String
- Name of the loadcase to add to the combination
- factor Double
- Factor for the loadcase to add to the combination
- type Int32 (Optional)
- Set the combination type for checking: 0 (default) unknown, 1 ultimate, 2 serviceability, 3 seismic
- servType Int32 (Optional)
- Set the combination type for checking: 0 (default) unknown, 1 characteristic, 2 frequent, 3 quasi-permanent
Return Value
BooleanTrue if successful
See Also