agi.foundation.access

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

Class LinkHelper

java.lang.Object

agi.foundation.access.LinkHelper

public final class LinkHelper
extends Object

A collection of helper methods for working with links such as LinkInstantaneous and LinkSpeedOfLight.

Method Summary

Modifier and Type	Method and Description
static VectorDisplacement	getDisplacementVectorByRole(ILinkService link, LinkRole role) Gets the displacement vector for a given link and role.
static VectorDisplacement	getDisplacementVectorByRole(IServiceProvider link, LinkRole role) Gets the displacement vector for a given link and role.
static LinkDelayEvaluator	getLinkDelayEvaluatorByRole(ILinkService link, EvaluatorGroup group, LinkRole role) Gets a link delay evaluator for a given link and role.
static LinkDelayEvaluator	getLinkDelayEvaluatorByRole(IServiceProvider link, EvaluatorGroup group, LinkRole role) Gets a link delay evaluator for a given link and role.
static ILinkService	getLinkService(IServiceProvider link) Gets the ILinkService provided by a link.
static ILinkService	getLinkService(IServiceProvider link, String exceptionMessage) Gets the ILinkService provided by a link.
static LinkRole	getOppositeLinkEnd(LinkRole role) Given a LinkRole, returns the LinkRole representing the opposite end of the link.
static ILinkService	getOptionalLinkService(IServiceProvider link) Gets the ILinkService provided by a link, or null if the service does not exist.
static IServiceProvider	getParticipantByRole(ILinkService link, LinkRole role) Gets the participant that is playing a specified role in the link.
static IServiceProvider	getParticipantByRole(IServiceProvider link, LinkRole role) Gets the participant that is playing a specified role in the link.
static LinkRole	getRoleOfParticipant(ILinkService link, IServiceProvider participant) Gets the role played by a specified participant in the link.
static LinkRole	getRoleOfParticipant(IServiceProvider link, IServiceProvider participant) Gets the role played by a specified participant in the link.

Methods inherited from class java.lang.Object

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

Method Detail

getLinkService

@Nonnull
public static ILinkService getLinkService(@Nonnull
                                                    IServiceProvider link)

Gets the ILinkService provided by a link.

Parameters:

link - The link from which to obtain the service.

Returns:

The service provided by the link.

Throws:

ArgumentNullException - Thrown when link is null.

ServiceNotAvailableException - Thrown when link does not provide ILinkService.

getLinkService

@Nonnull
public static ILinkService getLinkService(@Nonnull
                                                    IServiceProvider link,
                                                    String exceptionMessage)

Gets the ILinkService provided by a link.

Parameters:

link - The link from which to obtain the service.

exceptionMessage - An error message to include in the exception if the service is unavailable.

Returns:

The service provided by the link.

Throws:

ArgumentNullException - Thrown when link is null.

ServiceNotAvailableException - Thrown when link does not provide ILinkService.

getOptionalLinkService

@Nullable
public static ILinkService getOptionalLinkService(@Nonnull
                                                             IServiceProvider link)

Gets the ILinkService provided by a link, or null if the service does not exist.

Parameters:

link - The link from which to obtain the service.

Returns:

The service provided by the link, or null if the service does not exist.

Throws:

ArgumentNullException - Thrown when link is null.

getParticipantByRole

public static IServiceProvider getParticipantByRole(@Nonnull
                                                    IServiceProvider link,
                                                    @Nonnull
                                                    LinkRole role)

Gets the participant that is playing a specified role in the link.

Parameters:

link - The link.

role - The role for which to obtain the participant.

Returns:

The participant.

Throws:

ArgumentNullException - Thrown when link is null.

ArgumentException - Thrown when role is not LinkRole.TRANSMITTER or LinkRole.RECEIVER.

ServiceNotAvailableException - Thrown when link does not provide ILinkService.

getParticipantByRole

public static IServiceProvider getParticipantByRole(@Nonnull
                                                    ILinkService link,
                                                    @Nonnull
                                                    LinkRole role)

Gets the participant that is playing a specified role in the link.

Parameters:

link - The link.

role - The role for which to obtain the participant.

Returns:

The participant.

Throws:

ArgumentNullException - Thrown when link is null.

ArgumentException - Thrown when role is not LinkRole.TRANSMITTER or LinkRole.RECEIVER.

getDisplacementVectorByRole

@Nonnull
public static VectorDisplacement getDisplacementVectorByRole(@Nonnull
                                                                       IServiceProvider link,
                                                                       @Nonnull
                                                                       LinkRole role)

Gets the displacement vector for a given link and role.

Parameters:

link - The link.

role - The role for which to obtain the displacement vector.

Returns:

The displacement vector.

Throws:

ArgumentNullException - Thrown when link is null.

ArgumentException - Thrown when role is not LinkRole.TRANSMITTER or LinkRole.RECEIVER.

ServiceNotAvailableException - Thrown when link does not provide ILinkService.

getDisplacementVectorByRole

@Nonnull
public static VectorDisplacement getDisplacementVectorByRole(@Nonnull
                                                                       ILinkService link,
                                                                       @Nonnull
                                                                       LinkRole role)

Gets the displacement vector for a given link and role.

Parameters:

link - The link.

role - The role for which to obtain the displacement vector.

Returns:

The displacement vector.

Throws:

ArgumentNullException - Thrown when link is null.

ArgumentException - Thrown when role is not LinkRole.TRANSMITTER or LinkRole.RECEIVER.

getLinkDelayEvaluatorByRole

@Nonnull
public static LinkDelayEvaluator getLinkDelayEvaluatorByRole(@Nonnull
                                                                       IServiceProvider link,
                                                                       @Nonnull
                                                                       EvaluatorGroup group,
                                                                       @Nonnull
                                                                       LinkRole role)

Gets a link delay evaluator for a given link and role.

Parameters:

link - The link.

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.

role - The role for which to obtain a link delay evaluator.

Returns:

The link delay evaluator.

Throws:

ArgumentNullException - Thrown when link or group is null.

ArgumentException - Thrown when role is not LinkRole.TRANSMITTER or LinkRole.RECEIVER.

ServiceNotAvailableException - Thrown when link does not provide ILinkService.

getLinkDelayEvaluatorByRole

@Nonnull
public static LinkDelayEvaluator getLinkDelayEvaluatorByRole(@Nonnull
                                                                       ILinkService link,
                                                                       @Nonnull
                                                                       EvaluatorGroup group,
                                                                       @Nonnull
                                                                       LinkRole role)

Gets a link delay evaluator for a given link and role.

Parameters:

link - The link.

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.

role - The role for which to obtain a link delay evaluator.

Returns:

The link delay evaluator.

Throws:

ArgumentNullException - Thrown when link or group is null.

ArgumentException - Thrown when role is not LinkRole.TRANSMITTER or LinkRole.RECEIVER.

getRoleOfParticipant

@Nonnull
public static LinkRole getRoleOfParticipant(@Nonnull
                                                      IServiceProvider link,
                                                      IServiceProvider participant)

Gets the role played by a specified participant in the link.

Parameters:

link - The link.

participant - The participant.

Returns:

The role played by the participant.

Throws:

ArgumentNullException - Thrown when link is null.

ServiceNotAvailableException - Thrown when link does not provide ILinkService.

ArgumentException - Thrown when participant is not the Transmitter (get) or the Receiver (get) in the link.

getRoleOfParticipant

@Nonnull
public static LinkRole getRoleOfParticipant(@Nonnull
                                                      ILinkService link,
                                                      IServiceProvider participant)

Gets the role played by a specified participant in the link.

Parameters:

link - The link.

participant - The participant.

Returns:

The role played by the participant.

Throws:

ArgumentNullException - Thrown when link is null.

ServiceNotAvailableException - Thrown when link does not provide ILinkService.

ArgumentException - Thrown when participant is not the Transmitter (get) or the Receiver (get) in the link.

getOppositeLinkEnd

@Nonnull
public static LinkRole getOppositeLinkEnd(@Nonnull
                                                    LinkRole role)

Given a LinkRole, returns the LinkRole representing the opposite end of the link.

Parameters:

role - The link role for which to obtain the opposite end.

Returns:

The opposite end of the link.

Throws:

ArgumentException - Thrown when role is not LinkRole.TRANSMITTER or LinkRole.RECEIVER.