org.mbari.siam.operations.portal
Class PortalEvent

java.lang.Object
  java.util.EventObject
      org.mbari.siam.operations.portal.PortalEvent

All Implemented Interfaces:

java.io.Serializable

public class PortalEvent
extends java.util.EventObject

PortalEvent

Author:

Kent Headley

See Also:

Serialized Form

Field Summary

protected boolean	_consumed
protected int	_id Event ID
protected long	_time timestamp
static int	CONNECT_NODE_END
static int	CONNECT_NODE_START CONNECT_NODE event ID
static int	DEVICE_LIST_END
static int	DEVICE_LIST_START
static int	DISCONNECT_NODE_END
static int	DISCONNECT_NODE_START DISCONNECT_NODE event ID
static int	DISTRIBUTE_DATA_END
static int	DISTRIBUTE_DATA_START
static int	EXCEPTION EXCEPTION event ID
static int	GET_DATA_END END_DOWNLOAD event ID
static int	GET_DATA_START START_DOWNLOAD event ID
static int	NODE_LIST_END
static int	NODE_LIST_START
static int	NULL_ID
static int	PROCESS_NODE_END
static int	PROCESS_NODE_START
static int	PROCESS_PACKET_SET_END
static int	PROCESS_PACKET_SET_START
static int	PUBLISH_DATA_END
static int	PUBLISH_DATA_START
static int	RESET_WDT_END
static int	RESET_WDT_START RESET_WDT event ID
static int	RETRIEVE_DISTRIBUTE_DATA_END
static int	RETRIEVE_DISTRIBUTE_DATA_START
static int	RX_PACKET_SET_END
static int	RX_PACKET_SET_START RX_PACKET_SET event ID
static int	SAVE_DATA_END
static int	SAVE_DATA_START
static int	SEND_COMMANDS_END
static int	SEND_COMMANDS_START
static int	SESSION_END SESSION_END event ID
static int	SESSION_START SESSION_START event ID
static int	START_SESSION_END
static int	START_SESSION_START
static int	SYNC_NTP_END
static int	SYNC_NTP_START
static int	UNSPECIFIED_END
static int	UNSPECIFIED_START
static int	WAKE_SUBNODE_END
static int	WAKE_SUBNODE_START

Fields inherited from class java.util.EventObject

source

Constructor Summary

PortalEvent()
Constructs a PortalEvent with the specified source and type

PortalEvent(java.lang.Object source)
Constructs a PortalEvent with the specified source and type

PortalEvent(java.lang.Object source, int id)
Constructs a PortalEvent with the specified source and type

PortalEvent(java.lang.Object source, int id, DevicePacketSet packetSet)
Constructs a PortalEvent with the specified source and type and PacketSet

PortalEvent(java.lang.Object source, int id, java.lang.Exception exception)
Constructs a PortalEvent with the specified source and type and Exception

PortalEvent(java.lang.Object source, int id, java.lang.String message)
Constructs a PortalEvent with the specified source and type and message

Method Summary

protected void	consume() Consume event
protected void	finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
java.lang.Exception	getException() getException
int	getID() Returns the event type
java.lang.String	getMessage() get the message attached to this event
DevicePacketSet	getPacketSet() get the DevicePacketSet attached to this event
long	getTime() Returns the event timestamp
protected boolean	isConsumed() Returns current value of consumed member
java.lang.String	paramString() Returns a string representing the state of this event
void	setException(java.lang.Exception exception) getException
void	setPacketSet(DevicePacketSet packetSet) Attach a DevicePacketSet to this event
java.lang.String	toString() Returns a string representation this event object

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Field Detail

NULL_ID

public static final int NULL_ID

See Also:

Constant Field Values

_id

protected int _id

Event ID

_time

protected long _time

timestamp

_consumed

protected boolean _consumed

SESSION_START

public static final int SESSION_START

SESSION_START event ID

See Also:

Constant Field Values

SESSION_END

public static final int SESSION_END

SESSION_END event ID

See Also:

Constant Field Values

EXCEPTION

public static final int EXCEPTION

EXCEPTION event ID

See Also:

Constant Field Values

CONNECT_NODE_START

public static final int CONNECT_NODE_START

CONNECT_NODE event ID

See Also:

Constant Field Values

CONNECT_NODE_END

public static final int CONNECT_NODE_END

See Also:

Constant Field Values

RESET_WDT_START

public static final int RESET_WDT_START

RESET_WDT event ID

See Also:

Constant Field Values

RESET_WDT_END

public static final int RESET_WDT_END

See Also:

Constant Field Values

SYNC_NTP_START

public static final int SYNC_NTP_START

See Also:

Constant Field Values

SYNC_NTP_END

public static final int SYNC_NTP_END

See Also:

Constant Field Values

DEVICE_LIST_START

public static final int DEVICE_LIST_START

See Also:

Constant Field Values

DEVICE_LIST_END

public static final int DEVICE_LIST_END

See Also:

Constant Field Values

RX_PACKET_SET_START

public static final int RX_PACKET_SET_START

RX_PACKET_SET event ID

See Also:

Constant Field Values

RX_PACKET_SET_END

public static final int RX_PACKET_SET_END

See Also:

Constant Field Values

GET_DATA_START

public static final int GET_DATA_START

START_DOWNLOAD event ID

See Also:

Constant Field Values

GET_DATA_END

public static final int GET_DATA_END

END_DOWNLOAD event ID

See Also:

Constant Field Values

SAVE_DATA_START

public static final int SAVE_DATA_START

See Also:

Constant Field Values

SAVE_DATA_END

public static final int SAVE_DATA_END

See Also:

Constant Field Values

DISTRIBUTE_DATA_START

public static final int DISTRIBUTE_DATA_START

See Also:

Constant Field Values

DISTRIBUTE_DATA_END

public static final int DISTRIBUTE_DATA_END

See Also:

Constant Field Values

PUBLISH_DATA_START

public static final int PUBLISH_DATA_START

See Also:

Constant Field Values

PUBLISH_DATA_END

public static final int PUBLISH_DATA_END

See Also:

Constant Field Values

NODE_LIST_START

public static final int NODE_LIST_START

See Also:

Constant Field Values

NODE_LIST_END

public static final int NODE_LIST_END

See Also:

Constant Field Values

DISCONNECT_NODE_START

public static final int DISCONNECT_NODE_START

DISCONNECT_NODE event ID

See Also:

Constant Field Values

DISCONNECT_NODE_END

public static final int DISCONNECT_NODE_END

See Also:

Constant Field Values

WAKE_SUBNODE_START

public static final int WAKE_SUBNODE_START

See Also:

Constant Field Values

WAKE_SUBNODE_END

public static final int WAKE_SUBNODE_END

See Also:

Constant Field Values

START_SESSION_START

public static final int START_SESSION_START

See Also:

Constant Field Values

START_SESSION_END

public static final int START_SESSION_END

See Also:

Constant Field Values

PROCESS_NODE_START

public static final int PROCESS_NODE_START

See Also:

Constant Field Values

PROCESS_NODE_END

public static final int PROCESS_NODE_END

See Also:

Constant Field Values

PROCESS_PACKET_SET_START

public static final int PROCESS_PACKET_SET_START

See Also:

Constant Field Values

PROCESS_PACKET_SET_END

public static final int PROCESS_PACKET_SET_END

See Also:

Constant Field Values

RETRIEVE_DISTRIBUTE_DATA_START

public static final int RETRIEVE_DISTRIBUTE_DATA_START

See Also:

Constant Field Values

RETRIEVE_DISTRIBUTE_DATA_END

public static final int RETRIEVE_DISTRIBUTE_DATA_END

See Also:

Constant Field Values

SEND_COMMANDS_START

public static final int SEND_COMMANDS_START

See Also:

Constant Field Values

SEND_COMMANDS_END

public static final int SEND_COMMANDS_END

See Also:

Constant Field Values

UNSPECIFIED_START

public static final int UNSPECIFIED_START

See Also:

Constant Field Values

UNSPECIFIED_END

public static final int UNSPECIFIED_END

See Also:

Constant Field Values

Constructor Detail

PortalEvent

public PortalEvent()

Constructs a PortalEvent with the specified source and type

PortalEvent

public PortalEvent(java.lang.Object source)

Constructs a PortalEvent with the specified source and type

PortalEvent

public PortalEvent(java.lang.Object source,
                   int id,
                   DevicePacketSet packetSet)

Constructs a PortalEvent with the specified source and type and PacketSet

PortalEvent

public PortalEvent(java.lang.Object source,
                   int id,
                   java.lang.Exception exception)

Constructs a PortalEvent with the specified source and type and Exception

PortalEvent

public PortalEvent(java.lang.Object source,
                   int id,
                   java.lang.String message)

Constructs a PortalEvent with the specified source and type and message

PortalEvent

public PortalEvent(java.lang.Object source,
                   int id)

Constructs a PortalEvent with the specified source and type

Method Detail

getTime

public long getTime()

Returns the event timestamp

getID

public int getID()

Returns the event type

getException

public java.lang.Exception getException()

getException

setException

public void setException(java.lang.Exception exception)

getException

setPacketSet

public void setPacketSet(DevicePacketSet packetSet)

Attach a DevicePacketSet to this event

getPacketSet

public DevicePacketSet getPacketSet()

get the DevicePacketSet attached to this event

getMessage

public java.lang.String getMessage()

get the message attached to this event

paramString

public java.lang.String paramString()

Returns a string representing the state of this event

toString

public java.lang.String toString()

Returns a string representation this event object

Overrides:

toString in class java.util.EventObject

consume

protected void consume()

Consume event

isConsumed

protected boolean isConsumed()

Returns current value of consumed member

finalize

protected void finalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

Overrides:

finalize in class java.lang.Object