agi.foundation.communications

(agi.foundation.communications-2024r3.jar)

Class AntennaTargetingResult

java.lang.Object

agi.foundation.communications.AntennaTargetingResult

public class AntennaTargetingResult
extends Object

Defines the result of attempting to orient a transmitter or receiver located within a CommunicationSystem.

Constructor Summary

Constructors

Constructor and Description
AntennaTargetingResult(IServiceProvider antenna, AntennaTargetingResultReason cause) Creates a new instance specifying all parameters

Method Summary

Modifier and Type	Method and Description
IServiceProvider	getAntenna() Gets the antenna that could not be targeted.
AntennaTargetingResultReason	getCause() Gets the reason the antenna could not be targeted.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AntennaTargetingResult

public AntennaTargetingResult(IServiceProvider antenna,
                              @Nonnull
                              AntennaTargetingResultReason cause)

Creates a new instance specifying all parameters

Parameters:

antenna - The antenna that could not be targeted.

cause - The reason the antenna could not be targeted.

Method Detail

getAntenna

public final IServiceProvider getAntenna()

Gets the antenna that could not be targeted.

getCause

@Nonnull
public final AntennaTargetingResultReason getCause()

Gets the reason the antenna could not be targeted.