Load
Load Lists
The active load list — which cases and combinations are active for the next command or query.
7 functions
Create
CreateLoadList
Description
Creates the load list.
Parameters
listType(int): list type.loadCaseList(list): load case list.
Returns
bool: True if the call succeeded, False otherwise.
Example
from openstaad import ops
s = ops.connect()
result = s.CreateLoadList(1, [1, 2])
print(result)
Get
GetAssignmentListForLoadType
Description
Returns the assignment list for load type.
Parameters
loadType(int): load type.loadIndex(int): load index.
Returns
list: A list of integers.
Example
from openstaad import ops
s = ops.connect()
result = s.GetAssignmentListForLoadType(1, 1)
print(result)
GetListSizeForLoadType
Description
Returns the list size for load type.
Parameters
loadType(int): load type.loadIndex(int): load index.
Returns
raw: The raw return value from the underlying OpenSTAAD COM call. Refer to the official Bentley OpenSTAAD API reference for this method's exact return semantics.
Example
from openstaad import ops
s = ops.connect()
result = s.GetListSizeForLoadType(1, 1)
print(result)
GetLoadCountInLoadList
Description
Returns the load count in load list.
Parameters
varLoadListIndex(int): var load list index.
Returns
raw: The raw return value from the underlying OpenSTAAD COM call. Refer to the official Bentley OpenSTAAD API reference for this method's exact return semantics.
Example
from openstaad import ops
s = ops.connect()
result = s.GetLoadCountInLoadList(1)
print(result)
GetLoadListCount
Description
Returns the load list count.
Parameters
None.
Returns
raw: The raw return value from the underlying OpenSTAAD COM call. Refer to the official Bentley OpenSTAAD API reference for this method's exact return semantics.
Example
from openstaad import ops
s = ops.connect()
result = s.GetLoadListCount()
print(result)
GetLoadsInLoadList
Description
Returns the loads in load list.
Parameters
varLoadListIndex(int): var load list index.
Returns
list: A list of integers.
Example
from openstaad import ops
s = ops.connect()
result = s.GetLoadsInLoadList(1)
print(result)
Delete
DeleteLoadList
Description
Deletes the load list.
Parameters
varLoadListIndex(int): var load list index.
Returns
bool: True if the call succeeded, False otherwise.
Example
from openstaad import ops
s = ops.connect()
result = s.DeleteLoadList(1)
print(result)