RAPendulum

class RAPendulum

Rocky PrePost Scripting wrapper representing a Pendulum 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('Pendulum')
pendulum = motion_1.GetTypeObject()

Methods:

Name	Description
GetAmplitudeVariation([unit])	Get the value of "Amplitude Variation".
GetDirection()	Get the value of "Direction".
GetFrequencyVariation([unit])	Get the value of "Frequency Variation".
GetInitialAmplitude([unit])	Get the value of "Initial Amplitude".
GetInitialFrequency([unit])	Get the value of "Initial Frequency".
GetInitialPhase([unit])	Get the value of "Initial Phase".
SetAmplitudeVariation(value[, unit])	Set the value of "Amplitude Variation".
SetDirection(values)	Set the values of "Direction".
SetFrequencyVariation(value[, unit])	Set the value of "Frequency Variation".
SetInitialAmplitude(value[, unit])	Set the value of "Initial Amplitude".
SetInitialFrequency(value[, unit])	Set the value of "Initial Frequency".
SetInitialPhase(value[, unit])	Set the value of "Initial Phase".

GetAmplitudeVariation(unit: str | None = None)

Get the value of “Amplitude Variation”.

• Parameters: unit – The unit for the returned value. If no unit is provided, the returned value will be in “rad/s”.

GetDirection()

Get the value of “Direction”.

GetFrequencyVariation(unit: str | None = None)

Get the value of “Frequency Variation”.

• Parameters: unit – The unit for the returned value. If no unit is provided, the returned value will be in “Hz/s”.

GetInitialAmplitude(unit: str | None = None)

Get the value of “Initial Amplitude”.

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

GetInitialFrequency(unit: str | None = None)

Get the value of “Initial Frequency”.

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

GetInitialPhase(unit: str | None = None)

Get the value of “Initial Phase”.

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

SetAmplitudeVariation(value: str | float, unit: str | None = None)

Set the value of “Amplitude Variation”.

• Parameters:
  • value – The value to set. This value can be an expression with input variables or float type.
  • unit – The unit for value. If no unit is provided, value is assumed to be in “rad/s”.

SetDirection(values: List[str | float])

Set the values of “Direction”.

• 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.
• Raises: RockyApiError – If values doesn’t have exactly 3 elements.

SetFrequencyVariation(value: str | float, unit: str | None = None)

Set the value of “Frequency Variation”.

• Parameters:
  • value – The value to set. This value can be an expression with input variables or float type.
  • unit – The unit for value. If no unit is provided, value is assumed to be in “Hz/s”.

SetInitialAmplitude(value: str | float, unit: str | None = None)

Set the value of “Initial Amplitude”.

• Parameters:
  • value – The value to set. This value can be an expression with input variables or float type.
  • unit – The unit for value. If no unit is provided, value is assumed to be in “rad”.

SetInitialFrequency(value: str | float, unit: str | None = None)

Set the value of “Initial Frequency”.

• Parameters:
  • value – The value to set. This value can be an expression with input variables or float type.
  • unit – The unit for value. If no unit is provided, value is assumed to be in “Hz”.

SetInitialPhase(value: str | float, unit: str | None = None)

Set the value of “Initial Phase”.

• Parameters:
  • value – The value to set. This value can be an expression with input variables or float type.
  • unit – The unit for value. If no unit is provided, value is assumed to be in “rad”.