Package org.ka2ddo.ax25

Enum Class ProtocolFamily

java.lang.Object

java.lang.Enum<ProtocolFamily>

org.ka2ddo.ax25.ProtocolFamily

All Implemented Interfaces:

Serializable, Comparable<ProtocolFamily>, Constable

public enum ProtocolFamily
extends Enum<ProtocolFamily>

This enumeration categorizes AX.25 messages by what protocol they are carrying, to make it easier for YAAC I/O ports to determine if a particular AX25Frame should be sent out a particular port.

Author:

Andrew Pavlin, KA2DDO

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
APRS	APRS packets over AX.25 UI frames, PID=0xF0 (NOLVL3).
OPENTRAC	OpenTRAC packets over AX.25 UI frames, PID=0x77 (OPENTRAC).
RAW_AX25	Other level 2 AX.25 frames, including connected-mode frames, PID=0xF0 (NOLVL3).

Method Summary

Modifier and Type	Method	Description
byte	getPid()	Get the AX.25 protocol ID value associated with this ProtocolFamily.
static ProtocolFamily	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ProtocolFamily[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

APRS

public static final ProtocolFamily APRS

APRS packets over AX.25 UI frames, PID=0xF0 (NOLVL3).

OPENTRAC

public static final ProtocolFamily OPENTRAC

OpenTRAC packets over AX.25 UI frames, PID=0x77 (OPENTRAC).

RAW_AX25

public static final ProtocolFamily RAW_AX25

Other level 2 AX.25 frames, including connected-mode frames, PID=0xF0 (NOLVL3).

Method Details

values

public static ProtocolFamily[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static ProtocolFamily valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getPid

public byte getPid()

Get the AX.25 protocol ID value associated with this ProtocolFamily.

Returns:

PID value