EventsAbstract

java.lang.Object
- rfid.api.EventsAbstract

Direct Known Subclasses:: Events, PixieEvents

public abstract class EventsAbstract
extends java.lang.Object

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`EventsAbstract.AccessStartEventData` Represents Access start event data.
`static class`	`EventsAbstract.AccessStopEventData` Represents Access stop event data.
`static class`	`EventsAbstract.AntennaEventData` Contains the Antenna Event Data.
`static class`	`EventsAbstract.BufferFullWarningEventData` Represents Buffer Full warning event data.
`static class`	`EventsAbstract.DisconnectionEventData` Represents Reader Disconnect event data.
`static class`	`EventsAbstract.GPIEventData` Represents GPI Event Data (port and the current state)
`static class`	`EventsAbstract.HandheldTriggerEventData` Represents Hand held Trigger Event Data (current state)
`static class`	`EventsAbstract.InventoryStartEventData` Represents Inventory start event data.
`static class`	`EventsAbstract.InventoryStopEventData` Represents Inventory stop event data.
`static class`	`EventsAbstract.NXPEASAlarmEventData` Gives the ID of the antenna which found an NXP tag with EAS bit set during EAS Scanning Also gives the alarm code returned by the tag during EAS scanning
`static class`	`EventsAbstract.ReaderExceptionEventData` Represents Reader Disconnect event data.
`static class`	`EventsAbstract.ReadEventData` Represents RFID Tag Data on read.
`static class`	`EventsAbstract.StatusEventData`
`static class`	`EventsAbstract.TemperatureAlarmData` Contains Temperature Alarm Event Data

Field Summary

Fields
Modifier and Type Field and Description

boolean m_IsUTCClockSupported

java.lang.String m_sHostName

Fields
Modifier and Type	Field and Description
`boolean`	`m_IsUTCClockSupported`
`java.lang.String`	`m_sHostName`

Constructor Summary

Constructors
Constructor and Description

EventsAbstract()

Constructors
Constructor and Description
`EventsAbstract()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract void`	`addEventsListener(RfidEventsListener rfidEventListener)` Adds the Event Listener for reporting Tag Read and status notification
`abstract void`	`dispose()`
`API3Abstract`	`getApi3Abstract()`
`abstract int`	`getEventHandle(RFID_EVENT_TYPE eventType)`
`java.lang.String`	`getHostName()`
`abstract int`	`getReaderHandle()`
`abstract rfid.api.RfidConnectionState`	`getRfidConnectionState()`
`abstract int[]`	`initNotificationWaitHandles()`
`abstract boolean`	`isAccessStartEventSet()` Checks if Access Start Event Notification is enabled/disabled.
`abstract boolean`	`isAccessStopEventSet()` Checks if Access Stop Event Notification is enabled/disabled.
`abstract boolean`	`isAntennaEventSet()` Checks if Antenna Event Notification is enabled/disabled.
`abstract boolean`	`isAttachTagDataWithReadEventSet()` Checks whether Attach Tag Data with Read Event is enabled/disabled
`abstract boolean`	`isBufferFullEventSet()` Checks if Buffer Full Event is enabled or not
`abstract boolean`	`isBufferFullWarningEventSet()` Checks if Buffer full warning Event Notification is enabled/disabled.
`abstract boolean`	`isEASAlarmEventSet()` Checks NXP EAS Alarm Event Notification is enabled/disabled
`abstract boolean`	`isEventRegistered(RFID_EVENT_TYPE eventType)`
`abstract boolean`	`isGPIEventSet()` Checks if GPI Event Notification is enabled/disabled.
`abstract boolean`	`isHandheldEventSet()` Checks Hand held Gun/Button event is enabled/disabled
`abstract boolean`	`isInventoryStartEventSet()` Checks if Inventory Start Event Notification is enabled/disabled.
`abstract boolean`	`isInventoryStopEventSet()` Checks if Inventory Stop Event Notification is enabled/disabled.
`abstract boolean`	`isReaderDisconnectEventSet()` Checks if Reader Disconnection Event Notification is enabled/disabled.
`abstract boolean`	`isReaderExceptionEventSet()` Event notifying that an exception has occurred in the Reader.
`abstract boolean`	`isTagReadEventSet()` Checks Tag Read Event is enabled/disabled
`abstract boolean`	`isTemperatureAlarmEventSet()` Checks if Temperature Event Notification is enabled/disabled.
`abstract void`	`notifyReadEvent()`
`abstract void`	`notifyStatusEvent(EventsAbstract.StatusEventData statusEventData)`
`abstract void`	`processReceivedEvents()`
`abstract boolean`	`registerForNotification(RFID_EVENT_TYPE eventType)`
`abstract void`	`removeEventsListener(RfidEventsListener rfidEventListener)` Removes the Event Listener.
`abstract void`	`setAccessStartEvent(boolean notifyAccessStartEvent)` To enable/disable Access Start Event Notification.
`abstract void`	`setAccessStopEvent(boolean notifyAccessStopEvent)` To enable/disable Access Stop Event Notification.
`abstract void`	`setAntennaEvent(boolean notifyAntennaEvent)` To enable/disable Antenna Event Notification.
`void`	`setApi3Abstract(API3Abstract api3Abstract)`
`abstract void`	`setAttachTagDataWithReadEvent(boolean attachTagDataWithReadEvent)` Specified whether TagData should be reported along with the eventReadNotify method of RfidEventsListener interface.
`abstract void`	`setBufferFullEvent(boolean notifyBufferFullEvent)` To Enable Buffer full Event Notification.
`abstract void`	`setBufferFullWarningEvent(boolean notifyBufferFullWarningEvent)` To enable/disable Buffer full warning Event Notification.
`abstract void`	`setEASAlarmEvent(boolean notifyEASAlarmEvent)` To enable/disable NXP_EAS_ALARM_EVENT Notification
`abstract void`	`setGPIEvent(boolean notifyGPIEvent)` To enable/disable GPI Event Notification.
`abstract void`	`setHandheldEvent(boolean notifyHandheldEvent)` To enable/disable A Hand held Gun/Button event - Pull/Release Notification
`abstract void`	`setInventoryStartEvent(boolean notifyInventoryStartEvent)` To enable/disable Inventory Start Event Notification.
`abstract void`	`setInventoryStopEvent(boolean notifyInventoryStopEvent)` To enable/disable Inventory Stop Event Notification.
`abstract void`	`setReaderDisconnectEvent(boolean notifyReaderDisconnectEvent)` To enable/disable Reader Disconnection Event Notification.
`abstract void`	`setReaderExceptionEvent(boolean notifyReaderExceptionEvent)` Event notifying that an exception has occurred in the Reader.
`abstract void`	`setReaderHandle(int m_hReaderHandle)`
`abstract void`	`setRfidConnectionState(rfid.api.RfidConnectionState rfidConnectionState)`
`abstract void`	`setTagReadEvent(boolean notifyTagReadEvent)` Enables/Disables the Tag Read Notification If enabled, the eventReadNotify method of RfidEventsListener interface will be called to signal tag the notification.
`abstract void`	`setTemperatureAlarmEvent(boolean notifyTemperatureAlarmEvent)` To enable/disable Temperature Alarm Notification.
`abstract void`	`startEventThreads()`
`abstract boolean`	`unRegisterForNotification(RFID_EVENT_TYPE eventType)`
`abstract int`	`WaitForMultipleObjects(int eventCount, int[] eventHandles, boolean waitAll, int milliSecondsToWait)`
`abstract int`	`WaitForSingleObject(int eventHandle, int milliSecondsToWait)`

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

- Field Detail
  - m_sHostName
```
public java.lang.String m_sHostName
```
  - m_IsUTCClockSupported
```
public boolean m_IsUTCClockSupported
```
- Constructor Detail
  - EventsAbstract
```
public EventsAbstract()
```
- Method Detail
  - dispose
```
public abstract void dispose()
```
  - getApi3Abstract
```
public API3Abstract getApi3Abstract()
```
  - setApi3Abstract
```
public void setApi3Abstract(API3Abstract api3Abstract)
```
  - isBufferFullEventSet
```
public abstract boolean isBufferFullEventSet()
```
    Checks if Buffer Full Event is enabled or not
  - setBufferFullEvent
```
public abstract void setBufferFullEvent(boolean notifyBufferFullEvent)
```
    To Enable Buffer full Event Notification.
    
    Parameters:
    
    notifyBufferFullEvent - When the internal buffers are 100% full, BUFFER_FULL_EVENT will be notified every time a new tag report is received. The oldest TagData reports will be replaced by the newest in a circular FIFO manner.
  - isTagReadEventSet
```
public abstract boolean isTagReadEventSet()
```
    Checks Tag Read Event is enabled/disabled
  - setTagReadEvent
```
public abstract void setTagReadEvent(boolean notifyTagReadEvent)
```
    Enables/Disables the Tag Read Notification If enabled, the eventReadNotify method of RfidEventsListener interface will be called to signal tag the notification. If setAttachTagDataWithReadEvent is set to true, the tag data will be reported in the RfidReadEvents else user needs to call Actions.getReadTags method for getting the bulk tags by providing number of tags to fetch.
  - isEASAlarmEventSet
```
public abstract boolean isEASAlarmEventSet()
```
    Checks NXP EAS Alarm Event Notification is enabled/disabled
  - setEASAlarmEvent
```
public abstract void setEASAlarmEvent(boolean notifyEASAlarmEvent)
```
    To enable/disable NXP_EAS_ALARM_EVENT Notification
  - isHandheldEventSet
```
public abstract boolean isHandheldEventSet()
```
    Checks Hand held Gun/Button event is enabled/disabled
  - setHandheldEvent
```
public abstract void setHandheldEvent(boolean notifyHandheldEvent)
```
    To enable/disable A Hand held Gun/Button event - Pull/Release Notification
  - isReaderExceptionEventSet
```
public abstract boolean isReaderExceptionEventSet()
```
    Event notifying that an exception has occurred in the Reader.
    
    Returns:
    
    Checks the Reader Exception Event Set state
  - setReaderExceptionEvent
```
public abstract void setReaderExceptionEvent(boolean notifyReaderExceptionEvent)
```
    Event notifying that an exception has occurred in the Reader. The Application can continue to use the connection if the reader renders is usable.
    
    Parameters:
    
    notifyReaderExceptionEvent - To enable/disabled Reader Exception Event in the reader.
  - getRfidConnectionState
```
public abstract rfid.api.RfidConnectionState getRfidConnectionState()
```
    Returns:
  - setRfidConnectionState
```
public abstract void setRfidConnectionState(rfid.api.RfidConnectionState rfidConnectionState)
```
    Parameters:
    
    rfidConnectionState -
  - isAccessStartEventSet
```
public abstract boolean isAccessStartEventSet()
```
    Checks if Access Start Event Notification is enabled/disabled.
  - setAccessStartEvent
```
public abstract void setAccessStartEvent(boolean notifyAccessStartEvent)
```
    To enable/disable Access Start Event Notification.
  - isAccessStopEventSet
```
public abstract boolean isAccessStopEventSet()
```
    Checks if Access Stop Event Notification is enabled/disabled.
  - setAccessStopEvent
```
public abstract void setAccessStopEvent(boolean notifyAccessStopEvent)
```
    To enable/disable Access Stop Event Notification.
  - isAntennaEventSet
```
public abstract boolean isAntennaEventSet()
```
    Checks if Antenna Event Notification is enabled/disabled. This event is generated when the Reader detects that an antenna is connected or disconnected
  - setAntennaEvent
```
public abstract void setAntennaEvent(boolean notifyAntennaEvent)
```
    To enable/disable Antenna Event Notification. This event is generated when the Reader detects that an antenna is connected or disconnected
  - isBufferFullWarningEventSet
```
public abstract boolean isBufferFullWarningEventSet()
```
    Checks if Buffer full warning Event Notification is enabled/disabled. When the internal buffers are 90% full, BUFFER_FULL_WARNING_EVENT will be notified. When the buffers are 100% full, no more Tags can be stored in Dll or in the Reader, and further tags are discarded.
  - setBufferFullWarningEvent
```
public abstract void setBufferFullWarningEvent(boolean notifyBufferFullWarningEvent)
```
    To enable/disable Buffer full warning Event Notification. When the internal buffers are 90% full, BUFFER_FULL_WARNING_EVENT will be notified. When the buffers are 100% full, no more Tags can be stored in Dll or in the Reader, and further tags are discarded.
  - isGPIEventSet
```
public abstract boolean isGPIEventSet()
```
    Checks if GPI Event Notification is enabled/disabled. GPI_EVENT will be signaled every time an enabled GPI changes state.
  - setGPIEvent
```
public abstract void setGPIEvent(boolean notifyGPIEvent)
```
    To enable/disable GPI Event Notification. GPI_EVENT will be signaled every time an enabled GPI changes state.
  - isInventoryStartEventSet
```
public abstract boolean isInventoryStartEventSet()
```
    Checks if Inventory Start Event Notification is enabled/disabled.
  - setInventoryStartEvent
```
public abstract void setInventoryStartEvent(boolean notifyInventoryStartEvent)
```
    To enable/disable Inventory Start Event Notification.
  - isInventoryStopEventSet
```
public abstract boolean isInventoryStopEventSet()
```
    Checks if Inventory Stop Event Notification is enabled/disabled.
  - setInventoryStopEvent
```
public abstract void setInventoryStopEvent(boolean notifyInventoryStopEvent)
```
    To enable/disable Inventory Stop Event Notification.
  - isTemperatureAlarmEventSet
```
public abstract boolean isTemperatureAlarmEventSet()
```
    Checks if Temperature Event Notification is enabled/disabled. This event is generated when the Reader reaches Temperature Threshold
  - setTemperatureAlarmEvent
```
public abstract void setTemperatureAlarmEvent(boolean notifyTemperatureAlarmEvent)
```
    To enable/disable Temperature Alarm Notification. This event is generated when the Reader reaches Temperature Threshold
  - isReaderDisconnectEventSet
```
public abstract boolean isReaderDisconnectEventSet()
```
    Checks if Reader Disconnection Event Notification is enabled/disabled. The Application can call Reconnect() to manually reconnect to the Reader Or opt for auto-reconnection. To cleanup and exit the application can call Disconnect().
  - setReaderDisconnectEvent
```
public abstract void setReaderDisconnectEvent(boolean notifyReaderDisconnectEvent)
```
    To enable/disable Reader Disconnection Event Notification. The Application can call Reconnect() to manually reconnect to the Reader Or opt for auto-reconnection. To cleanup and exit the application can call Disconnect().
  - isAttachTagDataWithReadEventSet
```
public abstract boolean isAttachTagDataWithReadEventSet()
```
    Checks whether Attach Tag Data with Read Event is enabled/disabled
  - setAttachTagDataWithReadEvent
```
public abstract void setAttachTagDataWithReadEvent(boolean attachTagDataWithReadEvent)
```
    Specified whether TagData should be reported along with the eventReadNotify method of RfidEventsListener interface. If the Tag population is less, the application can fetch the tags with the attachTagDataWithReadEvent set to true. But when there is a huge tag population or when the speed of processing tags is critical it is advisable to set attachTagDataWithReadEvent to false and fetch the tags using getReadTags() method from another thread (and not directly from the registered tag read handler)
  - getReaderHandle
```
public abstract int getReaderHandle()
```
  - setReaderHandle
```
public abstract void setReaderHandle(int m_hReaderHandle)
```
  - getHostName
```
public java.lang.String getHostName()
```
  - registerForNotification
```
public abstract boolean registerForNotification(RFID_EVENT_TYPE eventType)
```
  - unRegisterForNotification
```
public abstract boolean unRegisterForNotification(RFID_EVENT_TYPE eventType)
```
  - startEventThreads
```
public abstract void startEventThreads()
```
  - initNotificationWaitHandles
```
public abstract int[] initNotificationWaitHandles()
```
  - isEventRegistered
```
public abstract boolean isEventRegistered(RFID_EVENT_TYPE eventType)
```
  - getEventHandle
```
public abstract int getEventHandle(RFID_EVENT_TYPE eventType)
```
  - addEventsListener
```
public abstract void addEventsListener(RfidEventsListener rfidEventListener)
```
    Adds the Event Listener for reporting Tag Read and status notification
  - removeEventsListener
```
public abstract void removeEventsListener(RfidEventsListener rfidEventListener)
```
    Removes the Event Listener. Reporting of Tag Read and status notifications will be stopped
    
    Parameters:
    
    rfidEventListener -
  - WaitForMultipleObjects
```
public abstract int WaitForMultipleObjects(int eventCount,
                                           int[] eventHandles,
                                           boolean waitAll,
                                           int milliSecondsToWait)
```
  - WaitForSingleObject
```
public abstract int WaitForSingleObject(int eventHandle,
                                        int milliSecondsToWait)
```
  - processReceivedEvents
```
public abstract void processReceivedEvents()
```
  - notifyReadEvent
```
public abstract void notifyReadEvent()
```
  - notifyStatusEvent
```
public abstract void notifyStatusEvent(EventsAbstract.StatusEventData statusEventData)
```

Class EventsAbstract

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

m_sHostName

m_IsUTCClockSupported

Constructor Detail

EventsAbstract

Method Detail

dispose

getApi3Abstract

setApi3Abstract

isBufferFullEventSet

setBufferFullEvent

isTagReadEventSet

setTagReadEvent

isEASAlarmEventSet

setEASAlarmEvent

isHandheldEventSet

setHandheldEvent

isReaderExceptionEventSet

setReaderExceptionEvent

getRfidConnectionState

setRfidConnectionState

isAccessStartEventSet

setAccessStartEvent

isAccessStopEventSet

setAccessStopEvent

isAntennaEventSet

setAntennaEvent

isBufferFullWarningEventSet

setBufferFullWarningEvent

isGPIEventSet

setGPIEvent

isInventoryStartEventSet

setInventoryStartEvent

isInventoryStopEventSet

setInventoryStopEvent

isTemperatureAlarmEventSet

setTemperatureAlarmEvent

isReaderDisconnectEventSet

setReaderDisconnectEvent

isAttachTagDataWithReadEventSet

setAttachTagDataWithReadEvent

getReaderHandle

setReaderHandle

getHostName

registerForNotification

unRegisterForNotification

startEventThreads

initNotificationWaitHandles

isEventRegistered

getEventHandle

addEventsListener

removeEventsListener

WaitForMultipleObjects

WaitForSingleObject

processReceivedEvents

notifyReadEvent

notifyStatusEvent