Click or drag to resize

CommunicationSystemConfigureAntennaTargeting Method

Attempts to configure the OrientationAxes of each transmitter and receiver in the Links collection. If the OrientationAxes property is already defined on a given antenna, it will be overwritten. If an optimal orientation cannot be determined for a given antenna, the orientation is left unchanged.

Namespace:  AGI.Foundation.Communications
Assembly:  AGI.Foundation.Communications (in AGI.Foundation.Communications.dll) Version: 19.1.398.0 (19.1.398.0)
Syntax
public AntennaTargetingResultCollection ConfigureAntennaTargeting()

Return Value

Type: AntennaTargetingResultCollection
The collection of antennas whose OrientationAxes were not modified and the reason for not doing so.
Exceptions
Remarks
This method provides a best-effort approach to optimally orienting antennas in the communication system. Optimal orientation is defined as the antenna pointing directly at the antenna it is communicating with. The following heuristics are employed.
  1. Antennas that target a single transmitter/receiver are oriented using AxesTargetingLink.
  2. Isotropic antennas that target multiple transmitters or receivers are oriented using the Links.DefaultInertialFrame.Axes property.
  3. Isotropic antennas that only target a single transmitter or receiver are oriented using AxesTargetingLink.
  4. AntennaTargetingResultReason.TargetsMultipleAntennas is returned if a non-isotropic antenna targets multiple antennas.
  5. AntennaTargetingResultReason.ISetOrientationAxesNotAvailable is returned if the antenna does not support ISetOrientationAxes.
  6. Null values in the Links collection are ignored.
  7. Null values for Transmitter or Receiver properties on each link are ignored.
  8. Items in the Links collection that do not support ILinkService are ignored.
  9. Items in TransmitToAll and ReceiveFromAll are ignored since they will by definition target multiple antennas.
See Also