java.lang.Object
- nl.tno.imb.TEventEntry

```
public class TEventEntry
extends java.lang.Object
```
This class implements the events that can be send and received over the IMB framework.
Handlers can be attached to events that get called when specified events are received.

Author:

hans.cornelissen@tno.nl

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`TEventEntry.TLogLevel`	defines the type of log entry to send
`static interface`	`TEventEntry.TOnBuffer`	Override dispatch to implement a buffer event handler
`static interface`	`TEventEntry.TOnChangeFederation`	Override dispatch to implement a federation change handler
`static interface`	`TEventEntry.TOnChangeObject`	Override dispatch to implement a change object event handler
`static interface`	`TEventEntry.TOnChangeObjectData`	Override dispatch to implement a change object data event handler
`static interface`	`TEventEntry.TOnChildEvent`	Override dispatch to implement a handler for hub child event creation events
`static interface`	`TEventEntry.TOnFocus`	Override dispatch to implement a focus event handler
`static interface`	`TEventEntry.TOnNormalEvent`	Override dispatch to implement a normal event handler
`static interface`	`TEventEntry.TOnOtherEvent`	Override dispatch to implement a event handler for non-standard events
`static interface`	`TEventEntry.TOnStreamCreate`	Override dispatch to implement a handler of received streams, creating the local stream
`static interface`	`TEventEntry.TOnStreamEnd`	Override dispatch to implement a handler of received streams, action on end of stream
`static interface`	`TEventEntry.TOnSubAndPubEvent`
`static interface`	`TEventEntry.TOnTimerCmd`	Override dispatch to implement a timer command handler for commands reset/start/stop
`static interface`	`TEventEntry.TOnTimerTick`	Override dispatch to implement a timer tick handler

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`ACTION_CHANGE`	signal an object change: an existing object has changed
`static int`	`ACTION_DELETE`	signal an object change: an object is deleted
`static int`	`ACTION_NEW`	signal an object change: a new object is created
`static int`	`EK_BUFFER`	event kind: buffer event
`static int`	`EK_CHANGE_OBJECT_DATA_EVENT`	event kind: change object including changed data
`static int`	`EK_CHANGE_OBJECT_EVENT`	event kind: change object
`static int`	`EK_CHILD_EVENT_ADD`	event kind: a child event was created
`static int`	`EK_CHILD_EVENT_REMOVE`	event kind: a child event was removed
`static int`	`EK_LOG_WRITELN`	event kind: send a line to the log
`static int`	`EK_NORMAL_EVENT`	event kind: normal event
`static int`	`EK_STREAM_BODY`	event kind: body of a stream
`static int`	`EK_STREAM_HEADER`	event kind: header of a stream
`static int`	`EK_STREAM_TAIL`	event kind: end of a stream
`static int`	`EK_TIMER_ACKNOWLEDGE`	event kind: acknowledge timer tick
`static int`	`EK_TIMER_ACKNOWLEDGE_LIST_ADD`	event kind: add client to the acknowledge list of a timer
`static int`	`EK_TIMER_ACKNOWLEDGE_LIST_REMOVE`	event kind: remove client from the acknowledge list of a timer
`static int`	`EK_TIMER_CANCEL`	event kind: cancel/remove a running timer
`static int`	`EK_TIMER_PREPARE`	event kind: reset a timer
`static int`	`EK_TIMER_SET_SPEED`	event kind: set the relative speed of the timer
`static int`	`EK_TIMER_START`	event kind: start or continue a timer
`static int`	`EK_TIMER_STATUS_REQUEST`	event kind: request status update of a timer
`static int`	`EK_TIMER_STOP`	event kind: stop a running timer
`static int`	`EK_TIMER_TICK`	event kind: timer tick
`int`	`ID`	The local ID related to this event
`TEventEntry.TOnBuffer`	`onBuffer`	Handler to be called on receive of a buffer event
`TEventEntry.TOnChangeFederation`	`onChangeFederation`	Handler to be called on receive of a federation change event
`TEventEntry.TOnChangeObject`	`onChangeObject`	Handler to be called on receive of a change object event
`TEventEntry.TOnChangeObjectData`	`onChangeObjectData`	Handler to be called on receive of a change object with data event
`TEventEntry.TOnChildEvent`	`onChildEvent`	Handler to be called on receive of a child add/remove event
`TEventEntry.TOnFocus`	`onFocus`	Handler to be called on receive of a focus event
`TEventEntry.TOnNormalEvent`	`onNormalEvent`	Handler to be called on receive of a normal event
`TEventEntry.TOnOtherEvent`	`onOtherEvent`	Handler to be called on receive of an unhandled event
`TEventEntry.TOnStreamCreate`	`onStreamCreate`	Handler to be called on receive of a stream header event
`TEventEntry.TOnStreamEnd`	`onStreamEnd`	Handler to be called on receive of a stream tail event
`TEventEntry.TOnSubAndPubEvent`	`onSubAndPub`
`TEventEntry.TOnTimerCmd`	`onTimerCmd`	Handler to be called on receive of a timer command reset/start/stop
`TEventEntry.TOnTimerTick`	`onTimerTick`	Handler to be called on receive of a timer tick event
`static int`	`TRC_INFINITE`	no limit on the number of timer events to send

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`copyHandlersFrom(TEventEntry aEventEntry)`
`java.lang.String`	`getEventName()`	Returns the fully qualified name of this event
`java.lang.String`	`getShortEventName()`
`boolean`	`isPublished()`	Returns true if this event is published
`boolean`	`isSubscribed()`	Returns true if this event is subscribed
`int`	`logWriteLn(java.lang.String aLine, TEventEntry.TLogLevel aLevel)`	Send a line to the central framework log
`boolean`	`publishers()`
`int`	`signalBuffer(int aBufferID, byte[] aBuffer)`	Send a buffer event to the framework
`int`	`signalBuffer(int aBufferID, byte[] aBuffer, int aEventFlags)`	Send a buffer event to the framework
`int`	`signalChangeObject(int aAction, int aObjectID, java.lang.String aAttribute)`	Send a change object event to the framework
`int`	`signalEvent(int aEventKind, byte[] aEventPayload)`	Send an event to the framework
`int`	`signalStream(java.lang.String aStreamName, java.io.InputStream aStream)`	Send a stream to the framework
`boolean`	`subscribers()`
`int`	`timerAcknowledge(java.lang.String aTimerName, java.lang.String aClientName, int aProposedTimeStep)`	Acknowledge a timer tick. All clients on the timer acknowledge list must send an acknowledge on each timer tick for the timer to advance.
`int`	`timerAcknowledgeAdd(java.lang.String aTimerName, java.lang.String aClientName)`	Add a client name to the acknowledge list of a timer. All entries in this list must send an acknowledge on each timer tick for the timer to advance.
`int`	`timerAcknowledgeRemove(java.lang.String aTimerName, java.lang.String aClientName)`	Remove a client name from the acknowledge list of a timer. All entries in this list must send an acknowledge on each timer tick for the timer to advance.
`int`	`timerCancel(java.lang.String aTimerName)`	Cancel a running timer; the timer is destroyed.
`int`	`timerCreate(java.lang.String aTimerName, long aStartTimeUTCorRelFT, int aResolutionms, double aSpeedFactor)`	Create a timer on the connected HUB
`int`	`timerCreate(java.lang.String aTimerName, long aStartTimeUTCorRelFT, int aResolutionms, double aSpeedFactor, int aRepeatCount)`	Create a timer on the connected HUB
`int`	`timerPrepare(java.lang.String aTimerName)`	Prepare a timer; the timer is stopped and reset to an initial state
`int`	`timerSetSpeed(java.lang.String aTimerName, double aSpeedFactor)`	Set the relative running speed of the timer
`int`	`timerStart(java.lang.String aTimerName)`	Start or continue the timer
`int`	`timerStop(java.lang.String aTimerName)`	Stop or pause the timer

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - EK_CHANGE_OBJECT_EVENT
```
public static final int EK_CHANGE_OBJECT_EVENT
```
    event kind: change object
    
    See Also:
    
    Constant Field Values
  - EK_STREAM_HEADER
```
public static final int EK_STREAM_HEADER
```
    event kind: header of a stream
    
    See Also:
    
    Constant Field Values
  - EK_STREAM_BODY
```
public static final int EK_STREAM_BODY
```
    event kind: body of a stream
    
    See Also:
    
    Constant Field Values
  - EK_STREAM_TAIL
```
public static final int EK_STREAM_TAIL
```
    event kind: end of a stream
    
    See Also:
    
    Constant Field Values
  - EK_BUFFER
```
public static final int EK_BUFFER
```
    event kind: buffer event
    
    See Also:
    
    Constant Field Values
  - EK_NORMAL_EVENT
```
public static final int EK_NORMAL_EVENT
```
    event kind: normal event
    
    See Also:
    
    Constant Field Values
  - EK_CHANGE_OBJECT_DATA_EVENT
```
public static final int EK_CHANGE_OBJECT_DATA_EVENT
```
    event kind: change object including changed data
    
    See Also:
    
    Constant Field Values
  - EK_CHILD_EVENT_ADD
```
public static final int EK_CHILD_EVENT_ADD
```
    event kind: a child event was created
    
    See Also:
    
    Constant Field Values
  - EK_CHILD_EVENT_REMOVE
```
public static final int EK_CHILD_EVENT_REMOVE
```
    event kind: a child event was removed
    
    See Also:
    
    Constant Field Values
  - EK_LOG_WRITELN
```
public static final int EK_LOG_WRITELN
```
    event kind: send a line to the log
    
    See Also:
    
    Constant Field Values
  - EK_TIMER_CANCEL
```
public static final int EK_TIMER_CANCEL
```
    event kind: cancel/remove a running timer
    
    See Also:
    
    Constant Field Values
  - EK_TIMER_PREPARE
```
public static final int EK_TIMER_PREPARE
```
    event kind: reset a timer
    
    See Also:
    
    Constant Field Values
  - EK_TIMER_START
```
public static final int EK_TIMER_START
```
    event kind: start or continue a timer
    
    See Also:
    
    Constant Field Values
  - EK_TIMER_STOP
```
public static final int EK_TIMER_STOP
```
    event kind: stop a running timer
    
    See Also:
    
    Constant Field Values
  - EK_TIMER_ACKNOWLEDGE_LIST_ADD
```
public static final int EK_TIMER_ACKNOWLEDGE_LIST_ADD
```
    event kind: add client to the acknowledge list of a timer
    
    See Also:
    
    Constant Field Values
  - EK_TIMER_ACKNOWLEDGE_LIST_REMOVE
```
public static final int EK_TIMER_ACKNOWLEDGE_LIST_REMOVE
```
    event kind: remove client from the acknowledge list of a timer
    
    See Also:
    
    Constant Field Values
  - EK_TIMER_SET_SPEED
```
public static final int EK_TIMER_SET_SPEED
```
    event kind: set the relative speed of the timer
    
    See Also:
    
    Constant Field Values
  - EK_TIMER_TICK
```
public static final int EK_TIMER_TICK
```
    event kind: timer tick
    
    See Also:
    
    Constant Field Values
  - EK_TIMER_ACKNOWLEDGE
```
public static final int EK_TIMER_ACKNOWLEDGE
```
    event kind: acknowledge timer tick
    
    See Also:
    
    Constant Field Values
  - EK_TIMER_STATUS_REQUEST
```
public static final int EK_TIMER_STATUS_REQUEST
```
    event kind: request status update of a timer
    
    See Also:
    
    Constant Field Values
  - TRC_INFINITE
```
public static final int TRC_INFINITE
```
    no limit on the number of timer events to send
    
    See Also:
    
    Constant Field Values
  - ID
```
public final int ID
```
    The local ID related to this event
  - onChangeObject
```
public TEventEntry.TOnChangeObject onChangeObject
```
    Handler to be called on receive of a change object event
  - onFocus
```
public TEventEntry.TOnFocus onFocus
```
    Handler to be called on receive of a focus event
  - onNormalEvent
```
public TEventEntry.TOnNormalEvent onNormalEvent
```
    Handler to be called on receive of a normal event
  - onBuffer
```
public TEventEntry.TOnBuffer onBuffer
```
    Handler to be called on receive of a buffer event
  - onStreamCreate
```
public TEventEntry.TOnStreamCreate onStreamCreate
```
    Handler to be called on receive of a stream header event
  - onStreamEnd
```
public TEventEntry.TOnStreamEnd onStreamEnd
```
    Handler to be called on receive of a stream tail event
  - onChangeFederation
```
public TEventEntry.TOnChangeFederation onChangeFederation
```
    Handler to be called on receive of a federation change event
  - onTimerTick
```
public TEventEntry.TOnTimerTick onTimerTick
```
    Handler to be called on receive of a timer tick event
  - onTimerCmd
```
public TEventEntry.TOnTimerCmd onTimerCmd
```
    Handler to be called on receive of a timer command reset/start/stop
  - onChildEvent
```
public TEventEntry.TOnChildEvent onChildEvent
```
    Handler to be called on receive of a child add/remove event
  - onChangeObjectData
```
public TEventEntry.TOnChangeObjectData onChangeObjectData
```
    Handler to be called on receive of a change object with data event
  - onSubAndPub
```
public TEventEntry.TOnSubAndPubEvent onSubAndPub
```
  - onOtherEvent
```
public TEventEntry.TOnOtherEvent onOtherEvent
```
    Handler to be called on receive of an unhandled event
  - ACTION_NEW
```
public static final int ACTION_NEW
```
    signal an object change: a new object is created
    
    See Also:
    
    Constant Field Values
  - ACTION_DELETE
```
public static final int ACTION_DELETE
```
    signal an object change: an object is deleted
    
    See Also:
    
    Constant Field Values
  - ACTION_CHANGE
```
public static final int ACTION_CHANGE
```
    signal an object change: an existing object has changed
    
    See Also:
    
    Constant Field Values
- Method Detail
  - subscribers
```
public boolean subscribers()
```
  - publishers
```
public boolean publishers()
```
  - getEventName
```
public java.lang.String getEventName()
```
    Returns the fully qualified name of this event
  - getShortEventName
```
public java.lang.String getShortEventName()
```
  - isPublished
```
public boolean isPublished()
```
    Returns true if this event is published
  - isSubscribed
```
public boolean isSubscribed()
```
    Returns true if this event is subscribed
  - copyHandlersFrom
```
public void copyHandlersFrom(TEventEntry aEventEntry)
```
  - signalEvent
```
public int signalEvent(int aEventKind,
                       byte[] aEventPayload)
```
    Send an event to the framework
    
    Parameters:
    
    aEventKind - int;
    
    aEventPayload - byte[];
    
    Returns:
    
    status of the request (TConnection.ICE_* constants)
  - signalBuffer
```
public int signalBuffer(int aBufferID,
                        byte[] aBuffer)
```
    Send a buffer event to the framework
    
    Parameters:
    
    aBufferID - int; self chosen ID to separate streams of buffer events
    
    aBuffer - byte[];
    
    Returns:
    
    status of the request (TConnection.ICE_* constants)
  - signalBuffer
```
public int signalBuffer(int aBufferID,
                        byte[] aBuffer,
                        int aEventFlags)
```
    Send a buffer event to the framework
    
    Parameters:
    
    aBufferID - int; self chosen ID to separate streams of buffer events
    
    aBuffer - byte[];
    
    aEventFlags - flags for special processing within the hub; not fully implemented, use 0
    
    Returns:
    
    status of the request (TConnection.ICE_* constants)
  - signalStream
```
public int signalStream(java.lang.String aStreamName,
                        java.io.InputStream aStream)
```
    Send a stream to the framework
    
    Parameters:
    
    aStreamName - String;
    
    aStream - InputStream;
    
    Returns:
    
    status of the request (TConnection.ICE_* constants)
  - signalChangeObject
```
public int signalChangeObject(int aAction,
                              int aObjectID,
                              java.lang.String aAttribute)
```
    Send a change object event to the framework
    
    Parameters:
    
    aAction - int; see ACTION_* constants
    
    aObjectID - int; ID of the object that has changed
    
    aAttribute - String; optional name of the attribute that has changed
    
    Returns:
    
    status of the request (TConnection.ICE_* constants)
  - timerCreate
```
public int timerCreate(java.lang.String aTimerName,
                       long aStartTimeUTCorRelFT,
                       int aResolutionms,
                       double aSpeedFactor)
```
    Create a timer on the connected HUB
    
    Parameters:
    
    aTimerName - String; unique name of the timer within this event
    
    aStartTimeUTCorRelFT - long; 0 means now<br> larger than 0 means in absolute system time (UTC)
    less than 0 means system timer relative to now
    
    aResolutionms - int; the resolution of a timer tick (step) in milliseconds
    
    aSpeedFactor - double; 1 means same speed as real time, 0 means the timer runs in simulation time
    
    Returns:
    
    status of the request (TConnection.ICE_* constants)
  - timerCreate
```
public int timerCreate(java.lang.String aTimerName,
                       long aStartTimeUTCorRelFT,
                       int aResolutionms,
                       double aSpeedFactor,
                       int aRepeatCount)
```
    Create a timer on the connected HUB
    
    Parameters:
    
    aTimerName - String; unique name of the timer within this event
    
    aStartTimeUTCorRelFT - long; 0 means now<br> larger than 0 means in absolute system time (UTC)
    less than 0 means system timer relative to now
    
    aResolutionms - int; the resolution of a timer tick (step) in milliseconds
    
    aSpeedFactor - double; 1 means same speed as real time, 0 means the timer runs in simulation time
    
    aRepeatCount - int; number of timer the timer must send a timer tick (TRC_INFINITE for infinite)
    
    Returns:
    
    status of the request (TConnection.ICE_* constants)
  - timerCancel
```
public int timerCancel(java.lang.String aTimerName)
```
    Cancel a running timer; the timer is destroyed.
    
    Parameters:
    
    aTimerName - String;
    
    Returns:
    
    status of the request (TConnection.ICE_* constants)
  - timerPrepare
```
public int timerPrepare(java.lang.String aTimerName)
```
    Prepare a timer; the timer is stopped and reset to an initial state
    
    Parameters:
    
    aTimerName - String;
    
    Returns:
    
    status of the request (TConnection.ICE_* constants)
  - timerStart
```
public int timerStart(java.lang.String aTimerName)
```
    Start or continue the timer
    
    Parameters:
    
    aTimerName - String;
    
    Returns:
    
    status of the request (TConnection.ICE_* constants)
  - timerStop
```
public int timerStop(java.lang.String aTimerName)
```
    Stop or pause the timer
    
    Parameters:
    
    aTimerName - String;
    
    Returns:
    
    status of the request (TConnection.ICE_* constants)
  - timerSetSpeed
```
public int timerSetSpeed(java.lang.String aTimerName,
                         double aSpeedFactor)
```
    Set the relative running speed of the timer
    
    Parameters:
    
    aTimerName - String;
    
    aSpeedFactor - double; 1 means the timer is running in real time, 0 means the timer runs in simulation time
    
    Returns:
    
    status of the request (TConnection.ICE_* constants)
  - timerAcknowledgeAdd
```
public int timerAcknowledgeAdd(java.lang.String aTimerName,
                               java.lang.String aClientName)
```
    Add a client name to the acknowledge list of a timer.
    All entries in this list must send an acknowledge on each timer tick for the timer to advance.
    
    Parameters:
    
    aTimerName - String;
    
    aClientName - String;
    
    Returns:
    
    status of the request (TConnection.ICE_* constants)
  - timerAcknowledgeRemove
```
public int timerAcknowledgeRemove(java.lang.String aTimerName,
                                  java.lang.String aClientName)
```
    Remove a client name from the acknowledge list of a timer.
    All entries in this list must send an acknowledge on each timer tick for the timer to advance.
    
    Parameters:
    
    aTimerName - String;
    
    aClientName - String;
    
    Returns:
    
    status of the request (TConnection.ICE_* constants)
  - timerAcknowledge
```
public int timerAcknowledge(java.lang.String aTimerName,
                            java.lang.String aClientName,
                            int aProposedTimeStep)
```
    Acknowledge a timer tick.
    All clients on the timer acknowledge list must send an acknowledge on each timer tick for the timer to advance.
    
    Parameters:
    
    aTimerName - String;
    
    aClientName - String;
    
    aProposedTimeStep - int; clients can specify the next step that they wish. The overall lowest next step is used if the timer is not running in real time
    
    Returns:
    
    status of the request (TConnection.ICE_* constants)
  - logWriteLn
```
public int logWriteLn(java.lang.String aLine,
                      TEventEntry.TLogLevel aLevel)
```
    Send a line to the central framework log
    
    Parameters:
    
    aLine - String; text to enter into the log
    
    aLevel - TLogLevel; severity of the entry to log. See TLogLevel for values.
    
    Returns:
    
    status of the request (TConnection.ICE_* constants)

Class TEventEntry

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EK_CHANGE_OBJECT_EVENT

EK_STREAM_HEADER

EK_STREAM_BODY

EK_STREAM_TAIL

EK_BUFFER

EK_NORMAL_EVENT

EK_CHANGE_OBJECT_DATA_EVENT

EK_CHILD_EVENT_ADD

EK_CHILD_EVENT_REMOVE

EK_LOG_WRITELN

EK_TIMER_CANCEL

EK_TIMER_PREPARE

EK_TIMER_START

EK_TIMER_STOP

EK_TIMER_ACKNOWLEDGE_LIST_ADD

EK_TIMER_ACKNOWLEDGE_LIST_REMOVE

EK_TIMER_SET_SPEED

EK_TIMER_TICK

EK_TIMER_ACKNOWLEDGE

EK_TIMER_STATUS_REQUEST

TRC_INFINITE

ID

onChangeObject

onFocus

onNormalEvent

onBuffer

onStreamCreate

onStreamEnd

onChangeFederation

onTimerTick

onTimerCmd

onChildEvent

onChangeObjectData

onSubAndPub

onOtherEvent

ACTION_NEW

ACTION_DELETE

ACTION_CHANGE

Method Detail

subscribers

publishers

getEventName

getShortEventName

isPublished

isSubscribed

copyHandlersFrom

signalEvent

signalBuffer

signalBuffer

signalStream

signalChangeObject

timerCreate

timerCreate

timerCancel

timerPrepare

timerStart

timerStop

timerSetSpeed

timerAcknowledgeAdd

timerAcknowledgeRemove

timerAcknowledge

logWriteLn