AdjustToCyclicRange(Variable, Variable, Variable) Function

Top

Description

Modulates the provided value to specified range. This is mostly used to keep angles within a defined range.

Timing Precision Mode

This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.

Function Signature

AdjustToCyclicRange(	Variable cyclicRangeLowerValue,
	Variable cyclicRangeUpperValue,
	Variable valueToModulate)

Arguments

cyclicRangeLowerValue
Description:	Value of the lower end of the cyclic range.

cyclicRangeUpperValue
Description:	Value of the upper end of the cyclic range.

valueToModulate
Description:	Value to modulate.

Return Value

Type:

number

Returns the modulated value.

Syntax

myVariable1 = AdjustToCyclicRange(myVariable2, myVariable3, myVariable4);