MsgEventType

java.lang.Object
- java.lang.Enum<MsgEventType>
- - org.ka2ddo.yaac.ax25.MsgEventType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MsgEventType>
```
public enum MsgEventType
extends java.lang.Enum<MsgEventType>
```
Enumeration of event typeMask that can request appropriate sound effects.

Since:

PROVIDER_API_VERSION == 7

Author:

Andrew Pavlin, KA2DDO

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ALARM` Generic alarm not associated with any particular message or precedence.
`ANNOUNCEMENT` A non-critical announcement of an arbitrary event.
`BEL` Terminal session received an ASCII/Unicode BEL control character.
`CRITICAL_ERROR` Critical error message that the user should be informed about.
`DX_BAND_OPENING` A DX band opening report has been received.
`EMERGENCY` Message reporting emergency precedence.
`GPS_LOCK_ACQUIRED` GPS lock has been acquired.
`GPS_LOCK_LOST` GPS lock has been lost.
`INTERNET_LOST` Internet connection has been lost.
`INTERNET_RESTORED` Internet connection has been restored.
`MESSAGE_CQ` APRS text message calling CQ.
`MESSAGE_TO` APRS text message received addressed explicitly to this station.
`MESSAGE_WEATHER_WARN` APRS text message from a government weather office warning of severe weather.
`MSG_ACKNOWLEDGED` An APRS text message sent by this station was acknowledged (accepted) by the recipient.
`MSG_REJECTED` An APRS text message sent by this station was rejected by the recipient.
`NEW_BULLETIN` A new bulletin message has been received.
`NEW_IN_RANGE` A station has sent a position report indicating it is newly within defined maximum range.
`NEW_OBJECT` New object added to local knowledge base.
`NEW_OBJECT_IN_RANGE` An object position report has been sent indicating it is newly within defined maximum range.
`NEW_REPEATER_IN_RANGE` A new station or object identifying itself as a repeater has been discovered.
`NEW_STATION` New station added to local knowledge base.
`OBJ_TAKEOVER` Someone else took over one of our Objects/Items.
`OBJECT_OUT_OF_RANGE` Known object moved out of defined maximum range.
`PRIORITY` Message reporting priority precedence.
`SPECIAL` Message reporting special precedence.
`STATION_OUT_OF_RANGE` Known station moved out of defined maximum range.
`STATION_TIMED_OUT` A specially-tagged station has not been heard from in the specified period of time.
`TRACKED_STATION` A station or object being explicitly tracked has moved.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Class<?>`	`getParamClass()` Get the Class of the primary parameter expected for this event type.
`static MsgEventType`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static MsgEventType[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - MESSAGE_TO
```
public static final MsgEventType MESSAGE_TO
```
    APRS text message received addressed explicitly to this station. Parameter is MessageMessage.
  - MESSAGE_CQ
```
public static final MsgEventType MESSAGE_CQ
```
    APRS text message calling CQ. Parameter is MessageMessage.
  - MESSAGE_WEATHER_WARN
```
public static final MsgEventType MESSAGE_WEATHER_WARN
```
    APRS text message from a government weather office warning of severe weather. Parameter is MessageMessage.
  - EMERGENCY
```
public static final MsgEventType EMERGENCY
```
    Message reporting emergency precedence. Parameter is AX25Message specifying the precedence.
  - PRIORITY
```
public static final MsgEventType PRIORITY
```
    Message reporting priority precedence. Parameter is AX25Message specifying the precedence.
  - SPECIAL
```
public static final MsgEventType SPECIAL
```
    Message reporting special precedence. Parameter is AX25Message specifying the precedence.
  - ALARM
```
public static final MsgEventType ALARM
```
    Generic alarm not associated with any particular message or precedence. Parameter is text String.
  - NEW_IN_RANGE
```
public static final MsgEventType NEW_IN_RANGE
```
    A station has sent a position report indicating it is newly within defined maximum range. Parameter is StationState of station.
  - NEW_OBJECT_IN_RANGE
```
public static final MsgEventType NEW_OBJECT_IN_RANGE
```
    An object position report has been sent indicating it is newly within defined maximum range. Parameter is StationState of object.
  - DX_BAND_OPENING
```
public static final MsgEventType DX_BAND_OPENING
```
    A DX band opening report has been received. Parameter is DXRecord record.
  - BEL
```
public static final MsgEventType BEL
```
    Terminal session received an ASCII/Unicode BEL control character. No parameter.
    
    See Also:
    
    Terminal
  - OBJ_TAKEOVER
```
public static final MsgEventType OBJ_TAKEOVER
```
    Someone else took over one of our Objects/Items. Parameter is ObjectReport of the takeover.
  - NEW_STATION
```
public static final MsgEventType NEW_STATION
```
    New station added to local knowledge base. Parameter is StationState of the new station.
  - NEW_OBJECT
```
public static final MsgEventType NEW_OBJECT
```
    New object added to local knowledge base. Parameter is StationState of the new Object.
  - STATION_OUT_OF_RANGE
```
public static final MsgEventType STATION_OUT_OF_RANGE
```
    Known station moved out of defined maximum range. Parameter is StationState of the moved station.
  - INTERNET_LOST
```
public static final MsgEventType INTERNET_LOST
```
    Internet connection has been lost. Text is String hostname of network server, other is PortConnector object.
  - INTERNET_RESTORED
```
public static final MsgEventType INTERNET_RESTORED
```
    Internet connection has been restored. Text is String hostname of network server, other is PortConnector object.
  - GPS_LOCK_LOST
```
public static final MsgEventType GPS_LOCK_LOST
```
    GPS lock has been lost. Other is GpsFix object containing latest GPS report.
  - GPS_LOCK_ACQUIRED
```
public static final MsgEventType GPS_LOCK_ACQUIRED
```
    GPS lock has been acquired. Other is GpsFix object containing latest GPS report.
  - NEW_BULLETIN
```
public static final MsgEventType NEW_BULLETIN
```
    A new bulletin message has been received. Msg is MessageMessage containing new (or modified, not exact duplicate) bulletin line.
  - OBJECT_OUT_OF_RANGE
```
public static final MsgEventType OBJECT_OUT_OF_RANGE
```
    Known object moved out of defined maximum range. Ss is StationState of the moved object.
  - CRITICAL_ERROR
```
public static final MsgEventType CRITICAL_ERROR
```
    Critical error message that the user should be informed about. Text is String of error message.
  - NEW_REPEATER_IN_RANGE
```
public static final MsgEventType NEW_REPEATER_IN_RANGE
```
    A new station or object identifying itself as a repeater has been discovered. Ss is StationState of the station or object.
  - TRACKED_STATION
```
public static final MsgEventType TRACKED_STATION
```
    A station or object being explicitly tracked has moved. Ss is StationState of the station or object.
  - ANNOUNCEMENT
```
public static final MsgEventType ANNOUNCEMENT
```
    A non-critical announcement of an arbitrary event. Text is String of announcement text. Only makes sense when used with speech synthesizer mode.
  - STATION_TIMED_OUT
```
public static final MsgEventType STATION_TIMED_OUT
```
    A specially-tagged station has not been heard from in the specified period of time. Ss is StationState of old station.
  - MSG_ACKNOWLEDGED
```
public static final MsgEventType MSG_ACKNOWLEDGED
```
    An APRS text message sent by this station was acknowledged (accepted) by the recipient. Msg is MessageMessage that was acknowledged.
    
    Since:
    
    PROVIDER_API_VERSION == 44
  - MSG_REJECTED
```
public static final MsgEventType MSG_REJECTED
```
    An APRS text message sent by this station was rejected by the recipient. Msg is MessageMessage that was rejected.
    
    Since:
    
    PROVIDER_API_VERSION == 44
- Method Detail
  - values
```
public static MsgEventType[] 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 (MsgEventType c : MsgEventType.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static MsgEventType valueOf(java.lang.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:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - getParamClass
```
public java.lang.Class<?> getParamClass()
```
    Get the Class of the primary parameter expected for this event type.
    
    Returns:
    
    Class of expected parameter type

Enum MsgEventType

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

MESSAGE_TO

MESSAGE_CQ

MESSAGE_WEATHER_WARN

EMERGENCY

PRIORITY

SPECIAL

ALARM

NEW_IN_RANGE

NEW_OBJECT_IN_RANGE

DX_BAND_OPENING

BEL

OBJ_TAKEOVER

NEW_STATION

NEW_OBJECT

STATION_OUT_OF_RANGE

INTERNET_LOST

INTERNET_RESTORED

GPS_LOCK_LOST

GPS_LOCK_ACQUIRED

NEW_BULLETIN

OBJECT_OUT_OF_RANGE

CRITICAL_ERROR

NEW_REPEATER_IN_RANGE

TRACKED_STATION

ANNOUNCEMENT

STATION_TIMED_OUT

MSG_ACKNOWLEDGED

MSG_REJECTED

Method Detail

values

valueOf

getParamClass