RFLinkComponent.BuildAntennaGainGraphicsOverlay(GraphicsOverlay, Variable, Variable) Method

Top

Description

Populates the provided graphics overlay with the contents of the antenna gain pattern. The geometry is scaled based on the value of meanRadius. The useGainScaling parameter determines whether the radius in a given direction is scaled based on the gain, or kept at a uniform length. The graphics overlay's reference will be automatically set to the RFLinkComponent's source object.

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.

Click here to see the documentation for this object in nanosecond timing precision mode.

Method Signature

RFLinkComponent.BuildAntennaGainGraphicsOverlay(	GraphicsOverlay overlay,
	Variable meanRadius,
	Variable useGainScaling)

Arguments

overlay
Description:	The graphics overlay to be populated.

meanRadius
Description:	Sets the radius that the mean gain value will be placed at.
Units:	km

useGainScaling

Description:

If true, adjusts gain radii relative to the mean radius based on the relative gain values. Otherwise all gains will be placed at the mean radius.

Valid Values:

Value	Label
0	false
1	true

Syntax

myRFLinkComponent1.BuildAntennaGainGraphicsOverlay(myGraphicsOverlay1, myVariable1, myVariable2);