Attempts to configure the OrientationAxes
of each transmitter and receiver
in the Links
collection. If the OrientationAxes
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.
AGI.Foundation.Communications (in AGI.Foundation.Communications.dll) Version: 20.3.405.0 (20.3.405.0)
public AntennaTargetingResultCollection ConfigureAntennaTargeting()
Public Function ConfigureAntennaTargeting As AntennaTargetingResultCollection
member ConfigureAntennaTargeting : unit -> AntennaTargetingResultCollection
The collection of antennas whose OrientationAxes
were not modified and the reason for not doing so.
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.
- Antennas that target a single transmitter/receiver are oriented using AxesTargetingLink.
- Isotropic antennas that target multiple transmitters or receivers are oriented using the Links.DefaultInertialFrame.Axes property.
- Isotropic antennas that only target a single transmitter or receiver are oriented using AxesTargetingLink.
- AntennaTargetingResultReason.TargetsMultipleAntennas is returned if a non-isotropic antenna targets multiple antennas.
- AntennaTargetingResultReason.ISetOrientationAxesNotAvailable is returned if the antenna does not support
- Null values in the Links collection are ignored.
- Null values for Transmitter or Receiver properties on each link are ignored.
- Items in the Links collection that do not support ILinkService are ignored.
- Items in TransmitToAll and ReceiveFromAll are ignored since they will by definition target multiple antennas.