com.microej.gnss.test.util

Enum FunctionalityLevel

java.lang.Object

java.lang.Enum<FunctionalityLevel>

com.microej.gnss.test.util.FunctionalityLevel

All Implemented Interfaces:

Serializable, Comparable<FunctionalityLevel>

public enum FunctionalityLevel
extends Enum<FunctionalityLevel>

Wrapper of the AT command AT+CFUN.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AIRPLANE_MODE Module's RF-interface (TX and RX) is shut down whereby it logs off from the network and enters Airplane mode, which is indicated via "^SYSSTART AIRPLANE MODE" URC.
NORMAL Normal functionality level.

Method Summary

Modifier and Type	Method and Description
static FunctionalityLevel	get() Gets the current functionality level.
static void	reset() Resets and restarts the module.
static void	set(FunctionalityLevel level) Gets the current functionality level.
static FunctionalityLevel	valueOf(String name) Returns the enum constant of this type with the specified name.
static FunctionalityLevel[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

AIRPLANE_MODE

public static final FunctionalityLevel AIRPLANE_MODE

Module's RF-interface (TX and RX) is shut down whereby it logs off from the network and enters Airplane mode, which is indicated via "^SYSSTART AIRPLANE MODE" URC. USIM remains accessible. Accordingly, AT commands whose execution requires a radio connection will return an error result code or reflect the limited operating state.

NORMAL

public static final FunctionalityLevel NORMAL

Normal functionality level.

Method Detail

get

public static FunctionalityLevel get()
                              throws ATCommandFailedException

Gets the current functionality level.

Returns:

the functionality level.

Throws:

ATCommandFailedException - if an ATC exception occurs.

reset

public static void reset()
                  throws ATCommandFailedException

Resets and restarts the module.

The current functionality level will be retained.

Throws:

ATCommandFailedException - if an ATC exception occurs.

set

public static void set(FunctionalityLevel level)
                throws ATCommandFailedException

Gets the current functionality level.

Parameters:

level - the functionality level to set.

Throws:

ATCommandFailedException - if an ATC exception occurs.

valueOf

public static FunctionalityLevel valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

values

public static FunctionalityLevel[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (FunctionalityLevel c : FunctionalityLevel.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared