com.symbol.emdk.simulscan

Class SimulScanReader

java.lang.Object

com.symbol.emdk.simulscan.SimulScanReader

public class SimulScanReader
extends java.lang.Object

SimulScanReader class will represent and provides access to the physical Reader device.

 
 	Example Usage:
 	List<SimulScanReaderInfo> readerInfoList = simulscanManager.getSupportedDevicesInfo();
 	SimulScanReader reader = simulscanManager.getDevice(readerInfoList.get(0));
 	reader.addDataListener(callbackObj);
 	reader.addStatusListener(callbackObj);
 	reader.enable();
 	// Set template before calling read
 	reader.read();
 	reader.cancelRead();
 	reader.disable();
 

When using SimulScanReader consider the following:

• Calling SimulScanReader.read() with any unlicensed features in the selected template, an ERROR state is returned with extended status as "UNLICENSED_FEATURE" for each unlicensed feature in the template. Use SimulScanStatusData.getStatusDescription() to view the name of the unlicensed feature(s).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SimulScanReader.DataListerner An interface for notifying client applications when the scan data is available.
static interface	SimulScanReader.StatusListerner An interface for notifying client applications to notify scan events.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SimulScanReader(SimulScanReaderInfo readerInfo, android.content.Context context, EMDKServiceConnection emdkServiceConnection)

Method Summary

Modifier and Type	Method and Description
void	addDataListener(SimulScanReader.DataListerner dataListener) The client can register to get data notification via callbacks.
void	addStatusListener(SimulScanReader.StatusListerner statusListener) The client can register to get status notification via callbacks.
void	cancelRead() This cancels any pending read() calls
void	disable() Disables the reader hardware.
void	enable() Enables the reader hardware.
void	fetchTemplate(java.lang.String userName, java.lang.String password) Fetch templates from an external server and place them in the template directory.
SimulScanConfig	getConfig() Gets the current configuration settings for this reader device.
SimulScanReaderInfo	getReaderInfo() Returns information about the reader device.
boolean	isEnabled() Returns reader enabled state
java.lang.Boolean	isReadPending() Another read() cannot be submitted while a read is pending.
void	read() This method initiates a SimulScan read() request.
protected void	release()
void	removeDataListener(SimulScanReader.DataListerner dataListener) The client can unregister to not get data notification via callbacks.
void	removeStatusListener(SimulScanReader.StatusListerner statusListener) The client can unregister to not get status notification via callbacks.
void	setConfig(SimulScanConfig config) Changes the settings for this reader device.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimulScanReader

protected SimulScanReader(SimulScanReaderInfo readerInfo,
                          android.content.Context context,
                          EMDKServiceConnection emdkServiceConnection)

Method Detail

getReaderInfo

public SimulScanReaderInfo getReaderInfo()

Returns information about the reader device.

Returns:

Returns the SimulScanReaderInfo object.

isReadPending

public java.lang.Boolean isReadPending()

Another read() cannot be submitted while a read is pending.

Returns:

boolean Returns true if a read is pending.

enable

public void enable()
            throws SimulScanException

Enables the reader hardware. This method does not make the reader to scan. If another reader is already enabled, this will throw a SimulScanException. You must call disable() when you are done, otherwise all readers will remain locked and will be unavailable for this and any other application that uses SimulScan.

 
 Example Usage:
 reader.enable();
 
 

Throws:

SimulScanException - The exception will thrown if the reader enable fails.

disable

public void disable()
             throws SimulScanException

Disables the reader hardware. Any pending scanned data will be lost. This method releases the reader hardware resources so that other readers can be enabled. You must call this as soon as you're done with the scanning. Other applications will not be able to access SimulScan related functions till this function is called.

 
 Example Usage:
 reader.disable();
 
 

Throws:

SimulScanException - The exception will thrown if the reader disable fails.

isEnabled

public boolean isEnabled()

Returns reader enabled state

Returns:

boolean Returns true if reader is enabled.

getConfig

public SimulScanConfig getConfig()
                          throws SimulScanException

Gets the current configuration settings for this reader device. The reader must be enabled before the calling this function. If modifications are made to the returned SimulScanConfig object, the Reader.setConfig(SimulScanConfig) must be called to take effect.

 
 Example Usage:
 reader.enable();
 SimulScanConfig config = reader.getConfig();
 
 

Returns:

SimulScanConfig The valid reader configuration object will be returned on successful get.

Throws:

SimulScanException - Exception will be throw if any error occurs

setConfig

public void setConfig(SimulScanConfig config)
               throws SimulScanException

Changes the settings for this reader device. The reader must be enabled and must not have a read pending to call this method. This method skips the unsupported parameters and continues with setting the supported values.

 
 Example Usage:
 SimulScanMultiTemplate template1 = new SimulScanMultiTemplate(fileUri);//fileUri points to the template
 SimulScanReader reader = simulscanManager.getDevice(template1.deviceIdentifier);
 reader.enable();
 SimulScanConfig config = reader.getConfig();
 config.multiTemplate = template1;
 reader.setConfig(config);
 
 
 

Parameters:

config - The Parameters to use for this reader device.

Throws:

SimulScanException - Exception will be throw if any error occurs while setting the parameters.

read

public void read()
          throws SimulScanException

This method initiates a SimulScan read() request. This is an asynchronous call, the data and status will be returned through the registered callbacks. If a read() is submitted while another read is pending, the method call will fail. The read request can be cancelled by issuing a cancelRead(). It is recommended to check whether a read is pending by calling isReadPending() before submitting a read().

 
 Example Usage:
 reader.read();
 
 

Throws:

SimulScanException - Exception will be throw if any error occurs during the read request

cancelRead

public void cancelRead()
                throws SimulScanException

This cancels any pending read() calls

 
 Example Usage:
 reader.cancelRead();
 
 

Throws:

SimulScanException - The exception will thrown if error occurs during the cancelRead request.

addDataListener

public void addDataListener(SimulScanReader.DataListerner dataListener)

The client can register to get data notification via callbacks.

Parameters:

dataListener - The DataListerner callabck object.

Throws:

SimulScanException - Exception will be throw if any error occurs

removeDataListener

public void removeDataListener(SimulScanReader.DataListerner dataListener)

The client can unregister to not get data notification via callbacks.

Parameters:

dataListener - The DataListerner callback object to be unregistered

addStatusListener

public void addStatusListener(SimulScanReader.StatusListerner statusListener)

The client can register to get status notification via callbacks.

Parameters:

statusListener - The StatusListerner callback object

Throws:

SimulScanException - Exception will be throw if any error occurs

removeStatusListener

public void removeStatusListener(SimulScanReader.StatusListerner statusListener)

The client can unregister to not get status notification via callbacks.

Parameters:

statusListener - The StatusListerner callback object to be unregistered

release

protected void release()

fetchTemplate

public void fetchTemplate(java.lang.String userName,
                          java.lang.String password)
                   throws SimulScanException

Fetch templates from an external server and place them in the template directory. FETCH_TEMPLATE_COMPLETED status will be notified once the fetching is completed.

Parameters:

userName - Username for SimulScan Template Builder

password - Password for SimulScan Template Builder

Throws:

SimulScanException - The exception will be thrown if a read is in progress