agi.foundation.access

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

Interface ILinkService

All Superinterfaces:

ICloneWithContext

All Known Implementing Classes:

LinkInstantaneous, LinkRefracted, LinkSpeedOfLight

public interface ILinkService
extends ICloneWithContext

A service interface that provides the most basic methods for modeling a communication link between a transmitter and a receiver.

Method Summary

Modifier and Type	Method and Description
LinkDelayEvaluator	getOffsetToReceptionTimeEvaluator(EvaluatorGroup group) Gets an evaluator that, given a time at which something is transmitted by the Transmitter (get), evaluates the time at which it will be received by the Receiver (get).
LinkDelayEvaluator	getOffsetToTransmissionTimeEvaluator(EvaluatorGroup group) Gets an evaluator that, given a time at which something is received at the Receiver (get), evaluates the time at which it was transmitted by the Transmitter (get).
IServiceProvider	getReceiver() Gets the object that is receiving.
VectorDisplacement	getReceiverDisplacementRelativeToTransmitter() Gets a displacement vector that represents the displacement to the Receiver (get) as observed by the Transmitter (get).
IServiceProvider	getTransmitter() Gets the object that is transmitting.
VectorDisplacement	getTransmitterDisplacementRelativeToReceiver() Gets a displacement vector that represents the displacement to the Transmitter (get) as observed by the Receiver (get).

Methods inherited from interface agi.foundation.infrastructure.ICloneWithContext

clone

Method Detail

getTransmitter

IServiceProvider getTransmitter()

Gets the object that is transmitting.

getReceiver

IServiceProvider getReceiver()

Gets the object that is receiving.

getTransmitterDisplacementRelativeToReceiver

@Nonnull
VectorDisplacement getTransmitterDisplacementRelativeToReceiver()

Gets a displacement vector that represents the displacement to the Transmitter (get) as observed by the Receiver (get).

Returns:

The displacement vector.

getReceiverDisplacementRelativeToTransmitter

@Nonnull
VectorDisplacement getReceiverDisplacementRelativeToTransmitter()

Gets a displacement vector that represents the displacement to the Receiver (get) as observed by the Transmitter (get).

Returns:

The displacement vector.

getOffsetToTransmissionTimeEvaluator

@Nonnull
LinkDelayEvaluator getOffsetToTransmissionTimeEvaluator(@Nonnull
                                                                  EvaluatorGroup group)

Gets an evaluator that, given a time at which something is received at the Receiver (get), evaluates the time at which it was transmitted by the Transmitter (get). The time is expressed as an offset from the input time.

Since the transmission time is before the reception time, this evaluator will always return a negative (or zero) duration.

Parameters:

group - The group with which to associate the new evaluator. By grouping evaluators that are often evaluated at the same Julian dates, common computations can be performed only once for the entire group instead of multiple times for each evaluator.

Returns:

The evaluator.

Throws:

ArgumentNullException - Thrown when group is null.

getOffsetToReceptionTimeEvaluator

@Nonnull
LinkDelayEvaluator getOffsetToReceptionTimeEvaluator(@Nonnull
                                                               EvaluatorGroup group)

Gets an evaluator that, given a time at which something is transmitted by the Transmitter (get), evaluates the time at which it will be received by the Receiver (get). The time is expressed as an offset from the input time.

Since the reception is after the transmission time, this evaluator will always return a positive (or zero) duration.

Parameters:

group - The group with which to associate the new evaluator. By grouping evaluators that are often evaluated at the same Julian dates, common computations can be performed only once for the entire group instead of multiple times for each evaluator.

Returns:

The evaluator.

Throws:

ArgumentNullException - Thrown when group is null.