RAPrescribedForce

class RAPrescribedForce

Rocky PrePost Scripting wrapper representing an Additional Force motion.

Retrieve this specific wrapper after setting the correct motion type on a RAMotion. For example:

motions = motion_frame.GetMotions()
motion_1 = motions.New()
motion_1.SetType('Additional Force')
additional_force = motion_1.GetTypeObject()

Methods:

GetForceValue(unit: Optional[str] = None)

Get the value of “Force Value”.

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

SetForceValue(values: Sequence[Union[str, float]], unit: Optional[str] = None)

Set the values of “Force 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”.
• Raises: RockyApiError – If values doesn’t have exactly 3 elements.