# Load Cases functions | OpenStaad Python

> Primary and reference load cases — the containers every applied load belongs to. Create and query cases before adding nodal, member, or plate loads.

Source: https://www.openstaad.com/docs/load-cases

Every function is a method of the session `s = ops.connect()` (`from openstaad import ops`).

## Create

### CreateNewPrimaryLoad

**Description**

Creates the new primary load.

**Parameters**

- `primaryLoadTitle` (str): primary load title.

**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**

```python
from openstaad import ops

s = ops.connect()
result = s.CreateNewPrimaryLoad("value")
print(result)
```

### CreateNewPrimaryLoadEx

**Description**

Creates the new primary load ex.

**Parameters**

- `primaryLoadTitle` (str): primary load title.
- `loadType` (int): load type.

**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**

```python
from openstaad import ops

s = ops.connect()
result = s.CreateNewPrimaryLoadEx("value", 1)
print(result)
```

### CreateNewPrimaryLoadEx2

**Description**

Creates the new primary load ex 2.

**Parameters**

- `primaryLoadTitle` (str): primary load title.
- `loadType` (int): load type.
- `loadCaseNo` (int): load case no.

**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**

```python
from openstaad import ops

s = ops.connect()
result = s.CreateNewPrimaryLoadEx2("value", 1, 1)
print(result)
```

### CreateNewReferenceLoad

**Description**

Creates the new reference load.

**Parameters**

- `nodeNo` (int): node no.
- `referenceLoadCaseTitle` (str): reference load case title.
- `loadType` (int): load type.

**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**

```python
from openstaad import ops

s = ops.connect()
result = s.CreateNewReferenceLoad(1, "value", 1)
print(result)
```

## Add

### AddReferenceLoad

**Description**

Adds the reference load.

**Parameters**

- `varRefLoadCaseNoIds` (list): var ref load case no ids.
- `varFactorList` (list): var factor list.

**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**

```python
from openstaad import ops

s = ops.connect()
result = s.AddReferenceLoad([1, 2], [1, 2])
print(result)
```

### AddSeismicLoad

**Description**

Adds the seismic load.

**Parameters**

- `loadDirection` (int): load direction.
- `factor` (float): factor.

**Returns**

bool: `True` if the call succeeded, `False` otherwise.

**Example**

```python
from openstaad import ops

s = ops.connect()
result = s.AddSeismicLoad(1, 1.0)
print(result)
```

## Get

### GetActiveLoad

**Description**

Returns the active load.

**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**

```python
from openstaad import ops

s = ops.connect()
result = s.GetActiveLoad()
print(result)
```

### GetAttribute

**Description**

Returns the attribute.

**Parameters**

- `lLoadCase` (int): l load case.

**Returns**

bool: `True` if the call succeeded, `False` otherwise.

**Example**

```python
from openstaad import ops

s = ops.connect()
result = s.GetAttribute(1)
print(result)
```

### GetConcForceCount

**Description**

Returns the conc force count.

**Parameters**

- `nBeamNo` (int): n beam no.

**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**

```python
from openstaad import ops

s = ops.connect()
result = s.GetConcForceCount(1)
print(result)
```

### GetConcForces

**Description**

Returns the conc forces.

**Parameters**

- `nBeamNo` (int): n beam no.

**Returns**

list: A list of values.

**Example**

```python
from openstaad import ops

s = ops.connect()
result = s.GetConcForces(1)
print(result)
```

### GetConcMomentCount

**Description**

Returns the conc moment count.

**Parameters**

- `nBeamNo` (int): n beam no.

**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**

```python
from openstaad import ops

s = ops.connect()
result = s.GetConcMomentCount(1)
print(result)
```

### GetConcMoments

**Description**

Returns the conc moments.

**Parameters**

- `nBeamNo` (int): n beam no.

**Returns**

list: A list of values.

**Example**

```python
from openstaad import ops

s = ops.connect()
result = s.GetConcMoments(1)
print(result)
```

### GetInfluenceArea

**Description**

Returns the influence area.

**Parameters**

- `varfMinX` (float): varf min x.
- `varfMaxX` (float): varf max x.
- `varfMinY` (float): varf min y.
- `varfMaxY` (float): varf max y.
- `varfMinZ` (float): varf min z.
- `varfMaxZ` (float): varf max z.
- `varnDirection` (int): varn direction.

**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**

```python
from openstaad import ops

s = ops.connect()
result = s.GetInfluenceArea(1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1)
print(result)
```

### GetLinearVaryingLoadCount

**Description**

Returns the linear varying load count.

**Parameters**

- `nBeamNo` (int): n beam no.

**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**

```python
from openstaad import ops

s = ops.connect()
result = s.GetLinearVaryingLoadCount(1)
print(result)
```

### GetLinearVaryingLoads

**Description**

Returns the linear varying loads.

**Parameters**

- `nBeamNo` (int): n beam no.

**Returns**

list: A list of values.

**Example**

```python
from openstaad import ops

s = ops.connect()
result = s.GetLinearVaryingLoads(1)
print(result)
```

### GetLoadCaseTitle

**Description**

Returns the load case title.

**Parameters**

- `varLoadNo` (int): var load no.

**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**

```python
from openstaad import ops

s = ops.connect()
result = s.GetLoadCaseTitle(1)
print(result)
```

### GetLoadItemsCount

**Description**

Returns the load items count.

**Parameters**

- `loadCaseNo` (int): load case no.

**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**

```python
from openstaad import ops

s = ops.connect()
result = s.GetLoadItemsCount(1)
print(result)
```

### GetLoadItemType

**Description**

Returns the load item type.

**Parameters**

- `loadCaseNo` (int): load case no.
- `loadItemIndex` (int): load item 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**

```python
from openstaad import ops

s = ops.connect()
result = s.GetLoadItemType(1, 1)
print(result)
```

### GetLoadType

**Description**

Returns the load type.

**Parameters**

- `varLoadNo` (int): var load no.

**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**

```python
from openstaad import ops

s = ops.connect()
result = s.GetLoadType(1)
print(result)
```

### GetLoadTypeCount

**Description**

Returns the load type count.

**Parameters**

- `loadType` (int): load type.

**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**

```python
from openstaad import ops

s = ops.connect()
result = s.GetLoadTypeCount(1)
print(result)
```

### GetNLLoadStep

**Description**

Returns the NL load step.

**Parameters**

- `loadCaseNo` (int): load case no.

**Returns**

int: An integer value returned by STAAD.Pro for this call.

**Example**

```python
from openstaad import ops

s = ops.connect()
result = s.GetNLLoadStep(1)
print(result)
```

### GetNoOfSetsInReferenceLoad

**Description**

Returns the number of the sets in reference load.

**Parameters**

- `nIndex` (int): n 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**

```python
from openstaad import ops

s = ops.connect()
result = s.GetNoOfSetsInReferenceLoad(1)
print(result)
```

### GetPrimaryLoadCaseCount

**Description**

Returns the primary load case 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**

```python
from openstaad import ops

s = ops.connect()
result = s.GetPrimaryLoadCaseCount()
print(result)
```

### GetPrimaryLoadCaseNumbers

**Description**

Returns the primary load case numbers.

**Parameters**

None.

**Returns**

list: A list of integers.

**Example**

```python
from openstaad import ops

s = ops.connect()
result = s.GetPrimaryLoadCaseNumbers()
print(result)
```

### GetReferenceLoadByIndex

**Description**

Returns the reference load by index.

**Parameters**

- `nIndex` (int): n index.

**Returns**

tuple: A tuple of `(list[int], list[float])`.

**Example**

```python
from openstaad import ops

s = ops.connect()
result = s.GetReferenceLoadByIndex(1)
print(result)
```

### GetReferenceLoadCaseCount

**Description**

Returns the reference load case 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**

```python
from openstaad import ops

s = ops.connect()
result = s.GetReferenceLoadCaseCount()
print(result)
```

### GetReferenceLoadCaseNumbers

**Description**

Returns the reference load case numbers.

**Parameters**

None.

**Returns**

list: A list of integers.

**Example**

```python
from openstaad import ops

s = ops.connect()
result = s.GetReferenceLoadCaseNumbers()
print(result)
```

### GetReferenceLoadCaseTitle

**Description**

Returns the reference load case title.

**Parameters**

- `varLoadNo` (int): var load no.

**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**

```python
from openstaad import ops

s = ops.connect()
result = s.GetReferenceLoadCaseTitle(1)
print(result)
```

### GetReferenceLoadCount

**Description**

Returns the reference load 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**

```python
from openstaad import ops

s = ops.connect()
result = s.GetReferenceLoadCount()
print(result)
```

### GetReferenceLoadType

**Description**

Returns the reference load type.

**Parameters**

- `varLoadNo` (int): var load no.

**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**

```python
from openstaad import ops

s = ops.connect()
result = s.GetReferenceLoadType(1)
print(result)
```

## Set/Assign

### SetASDLoadAttribute

**Description**

Sets the ASD load attribute.

**Parameters**

- `loadCaseRefID` (int): load case ref ID.
- `strengthType` (int): strength type.
- `allowStressIncrease` (bool): allow stress increase.

**Returns**

bool: `True` if the call succeeded, `False` otherwise.

**Example**

```python
from openstaad import ops

s = ops.connect()
result = s.SetASDLoadAttribute(1, 1, True)
print(result)
```

### SetLoadActive

**Description**

Sets the load active.

**Parameters**

- `loadNumber` (int): load number.

**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**

```python
from openstaad import ops

s = ops.connect()
result = s.SetLoadActive(1)
print(result)
```

### SetLoadType

**Description**

Sets the load type.

**Parameters**

- `loadCaseNumber` (int): load case number.
- `loadType` (int): load type.

**Returns**

bool: `True` if the call succeeded, `False` otherwise.

**Example**

```python
from openstaad import ops

s = ops.connect()
result = s.SetLoadType(1, 1)
print(result)
```

### SetLSDLoadAttribute

**Description**

Sets the LSD load attribute.

**Parameters**

- `loadCaseRefID` (int): load case ref ID.

**Returns**

bool: `True` if the call succeeded, `False` otherwise.

**Example**

```python
from openstaad import ops

s = ops.connect()
result = s.SetLSDLoadAttribute(1)
print(result)
```

### SetReferenceLoadActive

**Description**

Sets the reference load active.

**Parameters**

- `nLoadCaseNo` (int): n load case no.

**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**

```python
from openstaad import ops

s = ops.connect()
result = s.SetReferenceLoadActive(1)
print(result)
```

## Remove

### RemoveAttribute

**Description**

Removes the attribute.

**Parameters**

- `lLoadCase` (int): l load case.

**Returns**

bool: `True` if the call succeeded, `False` otherwise.

**Example**

```python
from openstaad import ops

s = ops.connect()
result = s.RemoveAttribute(1)
print(result)
```

## Clear

### ClearPrimaryLoadCase

**Description**

Clears the primary load case.

**Parameters**

- `varLoadCaseNos` (list): var load case nos.
- `isReferenceLoad` (bool): is reference load.

**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**

```python
from openstaad import ops

s = ops.connect()
result = s.ClearPrimaryLoadCase([1, 2], True)
print(result)
```

### ClearReferenceLoadCase

**Description**

Clears the reference load case.

**Parameters**

- `varLoadCaseNos` (list): var load case nos.

**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**

```python
from openstaad import ops

s = ops.connect()
result = s.ClearReferenceLoadCase([1, 2])
print(result)
```

## Is

### IsDynamicLoadIncluded

**Description**

Checks whether dynamic load included.

**Parameters**

- `nLoadCase` (int): n load case.

**Returns**

bool: `True` if the call succeeded, `False` otherwise.

**Example**

```python
from openstaad import ops

s = ops.connect()
result = s.IsDynamicLoadIncluded(1)
print(result)
```