agi.foundation.navigation

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

Class GpsReceiverHelper

java.lang.Object

agi.foundation.navigation.GpsReceiverHelper

public final class GpsReceiverHelper
extends Object

A collection of helper methods for working with GpsReceiver and related types.

Method Summary

Modifier and Type	Method and Description
static GpsReceiver	getGpsReceiver(IServiceProvider provider) Gets the GpsReceiver from the IGpsReceiverService provided by an object.
static GpsReceiver	getGpsReceiver(IServiceProvider provider, String exceptionMessage) Gets the GpsReceiver from the IGpsReceiverService provided by an object.
static IGpsReceiverService	getGpsReceiverService(IServiceProvider provider) Gets the IGpsReceiverService provided by an object.
static IGpsReceiverService	getGpsReceiverService(IServiceProvider provider, String exceptionMessage) Gets the IGpsReceiverService provided by an object.
static IGpsReceiverService	getOptionalGpsReceiverService(IServiceProvider provider) Gets the IGpsReceiverService provided by an object, or null if the service does not exist.

Methods inherited from class java.lang.Object

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

Method Detail

getGpsReceiverService

@Nonnull
public static IGpsReceiverService getGpsReceiverService(@Nonnull
                                                                  IServiceProvider provider)

Gets the IGpsReceiverService provided by an object.

Parameters:

provider - The object from which to obtain the service.

Returns:

The service provided by the object.

Throws:

ArgumentNullException - Thrown when provider is null.

ServiceNotAvailableException - Thrown when provider does not provide IGpsReceiverService.

getGpsReceiverService

@Nonnull
public static IGpsReceiverService getGpsReceiverService(@Nonnull
                                                                  IServiceProvider provider,
                                                                  String exceptionMessage)

Gets the IGpsReceiverService provided by an object.

Parameters:

provider - The object 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 object.

Throws:

ArgumentNullException - Thrown when provider is null.

ServiceNotAvailableException - Thrown when provider does not provide IGpsReceiverService.

getOptionalGpsReceiverService

@Nullable
public static IGpsReceiverService getOptionalGpsReceiverService(@Nonnull
                                                                           IServiceProvider provider)

Gets the IGpsReceiverService provided by an object, or null if the service does not exist.

Parameters:

provider - The object from which to obtain the service.

Returns:

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

Throws:

ArgumentNullException - Thrown when provider is null.

getGpsReceiver

public static GpsReceiver getGpsReceiver(@Nonnull
                                         IServiceProvider provider)

Gets the GpsReceiver from the IGpsReceiverService provided by an object.

Parameters:

provider - The object from which to obtain the IGpsReceiverService service.

Returns:

The GpsReceiver from the IGpsReceiverService.

Throws:

ArgumentNullException - Thrown when provider is null.

ServiceNotAvailableException - Thrown when provider does not provide IGpsReceiverService.

getGpsReceiver

public static GpsReceiver getGpsReceiver(@Nonnull
                                         IServiceProvider provider,
                                         String exceptionMessage)

Gets the GpsReceiver from the IGpsReceiverService provided by an object.

Parameters:

provider - The object from which to obtain the IGpsReceiverService service.

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

Returns:

The GpsReceiver from the IGpsReceiverService.

Throws:

ArgumentNullException - Thrown when provider is null.

ServiceNotAvailableException - Thrown when provider does not provide IGpsReceiverService.