## On this page

  

 

 # RAPrescribedMoment

 Last update: 17.07.2025 

<a id="generated.RAPrescribedMoment"></a>

### *class* RAPrescribedMoment

Rocky PrePost Scripting wrapper representing an Additional Moment motion.

Retrieve this specific wrapper after setting the correct motion type on a [`RAMotion`](RAMotion.md#generated.RAMotion). For example:

```python
motions = motion_frame.GetMotions()
motion_1 = motions.New()
motion_1.SetType('Additional Moment')
additional_moment = motion_1.GetTypeObject()

```

**Methods:**

NameDescription[`GetMomentValue`](#generated.RAPrescribedMoment.GetMomentValue)(\[unit\])Get the value of "Moment Value".[`SetMomentValue`](#generated.RAPrescribedMoment.SetMomentValue)(values\[, unit\])Set the values of "Moment Value".<a id="generated.RAPrescribedMoment.GetMomentValue"></a>

#### GetMomentValue(unit: Optional\[str\] = None)

Get the value of “Moment Value”.

- **Parameters:****unit** – The unit for the returned values. If no unit is provided, the returned values will be in “N.m”.

<a id="generated.RAPrescribedMoment.SetMomentValue"></a>

#### SetMomentValue(values: Sequence\[Union\[str, float\]\], unit: Optional\[str\] = None)

Set the values of “Moment Value”.

- **Parameters:**
    - **values** – The values to set. The values can be heterogeneous, the element of values can be an expression with input variables or a float. Must have exactly 3 elements.
    - **unit** – The unit for values. If no unit is provided, values is assumed to be in “N.m”.
- **Raises:****RockyApiError** – If values doesn’t have exactly 3 elements.