DataManSystem (CMB SDK for Android)

java.lang.Object
- com.cognex.dataman.sdk.DataManSystem

public class DataManSystem
extends java.lang.Object

Represents a remote DataMan system.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DataManSystem.OnBatchCommandsCompletedListener` Interface definition for a callback to be invoked when a response for a commands is received in a bulk sending.
`static interface`	`DataManSystem.OnBinaryDataTransferProgressListener` Interface definition for a callback to be invoked when a certain amount of binary data has been transferred.
`static interface`	`DataManSystem.OnCodeQualityDataArrivedListener` Interface definition for a callback to be invoked when a code quality data XML is arrived.
`static interface`	`DataManSystem.OnConnectedListener` Interface definition for a callback to be invoked when successfully connecting to a reader.
`static interface`	`DataManSystem.OnConnectionErrorListener` Interface definition for a callback to be invoked when an error occurs while connecting to a reader.
`static interface`	`DataManSystem.OnDisconnectedListener` Interface definition for a callback to be invoked when disconnecting from a reader.
`static interface`	`DataManSystem.OnHeartbeatResponseMissedListener` Interface definition for a callback to be invoked when a response to a heartbeat command is missed.
`static interface`	`DataManSystem.OnImageArrivedListener` Interface definition for a callback to be invoked when a read image is arrived.
`static interface`	`DataManSystem.OnImageGraphicsArrivedListener` Interface definition for a callback to be invoked when an image graphics XML is arrived.
`static interface`	`DataManSystem.OnLiveImageArrivedListener` Interface definition for a callback to be invoked when a live image is arrived.
`static interface`	`DataManSystem.OnOffProtocolByteReceivedListener` Interface definition for a callback to be invoked when an off protocol byte is received.
`static interface`	`DataManSystem.OnReadStringArrivedListener` Interface definition for a callback to be invoked when a simple read string is arrived.
`static interface`	`DataManSystem.OnResponseReceivedListener` Interface definition for a callback to be invoked when a response is received.
`static interface`	`DataManSystem.OnStatusEventArrivedListener` Interface definition for a callback to be invoked when the status event is arrived.
`static interface`	`DataManSystem.OnSystemWentOfflineListener` Interface definition for a callback to be invoked when reader goes offline.
`static interface`	`DataManSystem.OnSystemWentOnlineListener` Interface definition for a callback to be invoked when reader goes online.
`static interface`	`DataManSystem.OnTrainingResultArrivedListener` Interface definition for a callback to be invoked when a training result XML is arrived.
`static interface`	`DataManSystem.OnXmlResultArrivedListener` Interface definition for a callback to be invoked when a read result in XML format is arrived.
`static interface`	`DataManSystem.OnXmlStatisticsArrivedListener` Interface definition for a callback to be invoked a the read statistics in XML format is arrived.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`connect()` Initiates a connection to the device with default user name, password and timeout.
`boolean`	`connect(java.lang.String userName, java.lang.String password)` Initiates a connection to the device with the given user name and password and with the default timeout.
`static DataManSystem`	`createDataManSystemForMXDevice(android.content.Context context)` Creates a `DataManSystem` object for a connected MX device.
`static DataManSystem`	`createDataManSystemForMXDevice(android.content.Context context, android.os.Handler handler)` Creates a `DataManSystem` object for a connected MX device.
`static DataManSystem`	`createDataManSystemOverBlutooth(android.bluetooth.BluetoothDevice device)` Creates a `DataManSystem` object to a Cognex Bluetooth device.
`static DataManSystem`	`createDataManSystemOverBlutooth(android.bluetooth.BluetoothDevice device, android.os.Handler handler)` Creates a `DataManSystem` object to a Cognex Bluetooth device.
`static DataManSystem`	`createDataManSystemOverCamera(android.content.Context context, int cameraMode, int previewOptions, android.view.ViewGroup previewContainer)` Creates a `DataManSystem` object for a Phone camera.
`static DataManSystem`	`createDataManSystemOverEthernet(java.net.InetAddress address)` Creates a `DataManSystem` object with an underlying Ethernet transport.
`static DataManSystem`	`createDataManSystemOverEthernet(java.net.InetAddress address, android.os.Handler handler)` Creates a `DataManSystem` object with an underlying Ethernet transport.
`static DataManSystem`	`createDataManSystemOverEthernet(java.net.InetAddress address, int port)` Creates a `DataManSystem` object with an underlying Ethernet transport.
`static DataManSystem`	`createDataManSystemOverEthernet(java.net.InetAddress address, int port, android.os.Handler handler)` Creates a `DataManSystem` object with an underlying Ethernet transport.
`static DataManSystem`	`createDataManSystemOverUsb(android.content.Context context, android.hardware.usb.UsbDevice device)` Deprecated. use `createDataManSystemForMXDevice`
`static DataManSystem`	`createDataManSystemOverUsb(android.content.Context context, android.hardware.usb.UsbDevice device, android.os.Handler handler)` Deprecated. use `createDataManSystemForMXDevice`
`static DataManSystem`	`createDataManSystemOverUsbAccessory(android.content.Context context, android.hardware.usb.UsbAccessory accessory)` Deprecated. use `createDataManSystemForMXDevice`
`static DataManSystem`	`createDataManSystemOverUsbAccessory(android.content.Context context, android.hardware.usb.UsbAccessory accessory, android.os.Handler handler)` Deprecated. use `createDataManSystemForMXDevice`
`void`	`disableHeartbeat()` Disables heartbeat and stops sending heartbeat commands.
`void`	`disableLiveImage()` Disables live image mode and stops requesting live images.
`void`	`disconnect()` Initiates a disconnection from the device.
`void`	`enableHeartbeat(int interval)` Enables heartbeat and start sending heartbeat commands in every `interval` milliseconds.
`void`	`enableLiveImage(com.cognex.dataman.sdk.ImageFormat imageFormat, com.cognex.dataman.sdk.ImageSize imageSize, com.cognex.dataman.sdk.ImageQuality imageQuality, DataManSystem.OnLiveImageArrivedListener listener)` Enables live image mode and start requesting live images.
`java.nio.charset.Charset`	`getCharset()` Gets the `Charset` object used when converting a series of bytes from the reader to a string.
`com.cognex.dataman.sdk.ConnectionState`	`getConnectionState()` Returns the connection state of the system.
`boolean`	`getExpectReadStringAsResponse()` Gets the value indicating whether the new syntax is expected for DMCC results arriving.
`java.lang.String`	`getExtraHeaderData()` Gets the extra header data sent with all commands.
`java.util.EnumSet<com.cognex.dataman.sdk.ResultType>`	`getResultTypes()` Gets the result types that should be handled by the SDK.
`com.cognex.dataman.sdk.ConnectionState`	`getState()` Gets the current connection state of this `DataManSystem` instance.
`int`	`getTimeout()` Gets the timeout value (in milliseconds) used in operations that can time out.
`static java.lang.String`	`getVersion()` Gets the current version of the SDK.
`boolean`	`isConnected()` Indicates the status of the connection.
`boolean`	`isFlushBufferEnabled()` Returns if buffer flushing was enabled or disabled on connecting to the device.
`boolean`	`isHeartbeatEnabled()` Indicates whether heartbeat is enabled or not.
`boolean`	`isLiveImageEnabled()` Indicates whether Live Image mode is enabled or not.
`void`	`sendBatchCommands(java.util.List<java.lang.String> commands, DataManSystem.OnBatchCommandsCompletedListener listener)` Sends the commands provided in a List to the connected device serially with the default timeout.
`void`	`sendCommand(java.lang.String command)` Sends a command to the connected device with the default timeout.
`void`	`sendCommand(java.lang.String command, byte[] data, int timeout, boolean expectBinaryResponse, DataManSystem.OnResponseReceivedListener listener)` Sends a command and the specified binary data to the connected device with the given timeout value.
`void`	`sendCommand(java.lang.String command, DataManSystem.OnResponseReceivedListener listener)` Sends a command to the connected device with the default timeout.
`com.cognex.dataman.sdk.DmccResponse`	`sendCommandSync(java.lang.String command, byte[] data, int timeout, boolean expectBinaryResponse)` Sends a command and the specified binary data to the connected device with the given timeout value.
`void`	`setCharset(java.nio.charset.Charset charset)` Sets the `Charset` object used when converting a series of bytes from the reader to a string.
`void`	`setExpectReadStringAsResponse(boolean value)` Sets the value indicating whether the new syntax should be used when handling DMCC results.
`void`	`setExtraHeaderData(java.lang.String extraHeaderData)` Sets the extra header data sent with all commands.
`void`	`setFlushBufferEnabled(boolean enabled)` Enables or disables buffer flushing on the device.
`void`	`setLogger(com.cognex.dataman.sdk.Logger logger)` Sets the optional logger which can be used for debugging purposes.
`void`	`setOnBinaryDataTransferProgressListener(DataManSystem.OnBinaryDataTransferProgressListener listener)` Register a callback to be invoked to report binary data transfer progress.
`void`	`setOnCodeQualityDataArrivedListener(DataManSystem.OnCodeQualityDataArrivedListener listener)` Register a callback to be invoked when a code quality data in XML format is arrived.
`void`	`setOnConnectedListener(DataManSystem.OnConnectedListener listener)` Registers a callback to be invoked when a connection to a reader is successfully established.
`void`	`setOnConnectionErrorListener(DataManSystem.OnConnectionErrorListener listener)` Register a callback to be invoked when a connection error occurs during connecting to a reader.
`void`	`setOnDisconnectedListener(DataManSystem.OnDisconnectedListener listener)` Register a callback to be invoked when disconnected from a reader.
`void`	`setOnHeartbeatResponseMissedListener(DataManSystem.OnHeartbeatResponseMissedListener listener)` Register a callback to be invoked when the response of a heartbeat command is missed.
`void`	`setOnImageArrivedListener(DataManSystem.OnImageArrivedListener listener)` Register a callback to be invoked when a read image is arrived.
`void`	`setOnImageGraphicsArrivedListener(DataManSystem.OnImageGraphicsArrivedListener listener)` Register a callback to be invoked when an image graphics in XML format is arrived.
`void`	`setOnOffProtocolByteReceivedListener(DataManSystem.OnOffProtocolByteReceivedListener listener)` Register a callback to be invoked when an off protocol byte is received.
`void`	`setOnReadStringArrivedListener(DataManSystem.OnReadStringArrivedListener listener)` Register a callback to be invoked when a simple read string is arrived.
`void`	`setOnStatusEventArrivedListener(DataManSystem.OnStatusEventArrivedListener listener)` Register a callback to be invoked when a status event is arrived.
`void`	`setOnSystemWentOfflineListener(DataManSystem.OnSystemWentOfflineListener listener)` Register a callback to be invoked when the reader went offline.
`void`	`setOnSystemWentOnlineListener(DataManSystem.OnSystemWentOnlineListener listener)` Register a callback to be invoked when the reader went online.
`void`	`setOnTrainingResultArrivedListener(DataManSystem.OnTrainingResultArrivedListener listener)` Register a callback to be invoked when a training result in XML format is arrived.
`void`	`setOnXmlResultArrivedListener(DataManSystem.OnXmlResultArrivedListener listener)` Register a callback to be invoked when a read result in XML format is arrived.
`void`	`setOnXmlStatisticsArrivedListener(DataManSystem.OnXmlStatisticsArrivedListener listener)` Register a callback to be invoked when a read statistics in XML format is arrived.
`void`	`setResultTypes(java.util.EnumSet<com.cognex.dataman.sdk.ResultType> resultTypes)` Sets the result types that should be handled by the SDK.
`void`	`setTimeout(int timeout)` Sets the timeout value (in milliseconds) used in operations that can time out.

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

- Method Detail
  - createDataManSystemOverEthernet
```
public static DataManSystem createDataManSystemOverEthernet(java.net.InetAddress address)
```
    Creates a DataManSystem object with an underlying Ethernet transport.
    
    Parameters:
    
    address - The IP address of the host to connect to.
    
    Returns:
    
    The newly created DataManSystem object.
  - createDataManSystemOverEthernet
```
public static DataManSystem createDataManSystemOverEthernet(java.net.InetAddress address,
                                                            android.os.Handler handler)
```
    Creates a DataManSystem object with an underlying Ethernet transport.
    
    Parameters:
    
    address - The IP address of the host to connect to.
    
    handler - The Handler object to be used to execute the listeners on its thread.
    
    Returns:
    
    The newly created DataManSystem object.
  - createDataManSystemOverEthernet
```
public static DataManSystem createDataManSystemOverEthernet(java.net.InetAddress address,
                                                            int port)
```
    Creates a DataManSystem object with an underlying Ethernet transport.
    
    Parameters:
    
    address - The IP address of the host to connect to.
    
    port - The port of the host to connect to.
    
    Returns:
    
    The newly created DataManSystem object.
  - createDataManSystemOverEthernet
```
public static DataManSystem createDataManSystemOverEthernet(java.net.InetAddress address,
                                                            int port,
                                                            android.os.Handler handler)
```
    Creates a DataManSystem object with an underlying Ethernet transport.
    
    Parameters:
    
    address - The IP address of the host to connect to.
    
    port - The port of the host to connect to.
    
    handler - The Handler object to be used to execute the listeners on its thread.
    
    Returns:
    
    The newly created DataManSystem object.
  - createDataManSystemForMXDevice
```
public static DataManSystem createDataManSystemForMXDevice(android.content.Context context)
```
    Creates a DataManSystem object for a connected MX device.
    
    Parameters:
    
    context - The application's environment.
    
    Returns:
    
    The newly created DataManSystem object.
  - createDataManSystemForMXDevice
```
public static DataManSystem createDataManSystemForMXDevice(android.content.Context context,
                                                           android.os.Handler handler)
```
    Creates a DataManSystem object for a connected MX device.
    
    Parameters:
    
    context - The application's environment.
    
    handler - The Handler object to be used to execute the listeners on its thread.
    
    Returns:
    
    The newly created DataManSystem object.
  - createDataManSystemOverCamera
```
public static DataManSystem createDataManSystemOverCamera(android.content.Context context,
                                                          int cameraMode,
                                                          int previewOptions,
                                                          android.view.ViewGroup previewContainer)
```
    Creates a DataManSystem object for a Phone camera.
    
    Parameters:
    
    context - The application's environment.
    
    cameraMode - The CameraMode when using the Mobile device camera.
    
    previewOptions - The PreviewOption when using the Mobile device camera.
    
    previewContainer - The container where the camera preview will be placed.
    
    Returns:
    
    The newly created DataManSystem object.
  - createDataManSystemOverUsb
```
@Deprecated
public static DataManSystem createDataManSystemOverUsb(android.content.Context context,
                                                                   android.hardware.usb.UsbDevice device)
```
    Deprecated. use createDataManSystemForMXDevice
    
    Creates a DataManSystem object with and underlying USB transport.
    
    Parameters:
    
    context - The application's environment.
    
    device - The UsbDevice object to connect to.
    
    Returns:
    
    The newly created DataManSystem object.
  - createDataManSystemOverUsb
```
@Deprecated
public static DataManSystem createDataManSystemOverUsb(android.content.Context context,
                                                                   android.hardware.usb.UsbDevice device,
                                                                   android.os.Handler handler)
```
    Deprecated. use createDataManSystemForMXDevice
    
    Creates a DataManSystem object with and underlying USB transport.
    
    Parameters:
    
    context - The application's environment.
    
    device - The UsbDevice object to connect to.
    
    handler - The Handler object to be used to execute the listeners on its thread.
    
    Returns:
    
    The newly created DataManSystem object.
  - createDataManSystemOverUsbAccessory
```
@Deprecated
public static DataManSystem createDataManSystemOverUsbAccessory(android.content.Context context,
                                                                            android.hardware.usb.UsbAccessory accessory)
```
    Deprecated. use createDataManSystemForMXDevice
    
    Creates a DataManSystem object with and underlying USB accessory transport.
    
    Parameters:
    
    context - The application's environment.
    
    accessory - The UsbAccessory object to connect to.
    
    Returns:
    
    The newly created DataManSystem object.
  - createDataManSystemOverUsbAccessory
```
@Deprecated
public static DataManSystem createDataManSystemOverUsbAccessory(android.content.Context context,
                                                                            android.hardware.usb.UsbAccessory accessory,
                                                                            android.os.Handler handler)
```
    Deprecated. use createDataManSystemForMXDevice
    
    Creates a DataManSystem object with and underlying USB accessory transport.
    
    Parameters:
    
    context - The application's environment.
    
    accessory - The UsbAccessory object to connect to.
    
    handler - The Handler object to be used to execute the listeners on its thread.
    
    Returns:
    
    The newly created DataManSystem object.
  - createDataManSystemOverBlutooth
```
public static DataManSystem createDataManSystemOverBlutooth(android.bluetooth.BluetoothDevice device)
```
    Creates a DataManSystem object to a Cognex Bluetooth device.
    
    Parameters:
    
    device - The BluetoothDevice object to connect to.
    
    Returns:
    
    The newly created DataManSystem object.
  - createDataManSystemOverBlutooth
```
public static DataManSystem createDataManSystemOverBlutooth(android.bluetooth.BluetoothDevice device,
                                                            android.os.Handler handler)
```
    Creates a DataManSystem object to a Cognex Bluetooth device.
    
    Parameters:
    
    device - The BluetoothDevice object to connect to.
    
    handler - The Handler object to be used to execute the listeners on its thread.
    
    Returns:
    
    The newly created DataManSystem object.
  - getVersion
```
public static java.lang.String getVersion()
```
    Gets the current version of the SDK.
    
    Returns:
    
    The current version of the SDK.
  - setFlushBufferEnabled
```
public void setFlushBufferEnabled(boolean enabled)
```
    Enables or disables buffer flushing on the device. If enabled, COM.BUFFER-START-SEND DMCC command is sent to the device after a successful connection.
    
    Parameters:
    
    enabled - enables or disables buffer flushing
  - isFlushBufferEnabled
```
public boolean isFlushBufferEnabled()
```
    Returns if buffer flushing was enabled or disabled on connecting to the device.
    
    Returns:
    
    status of buffer flushing on the device
  - getExpectReadStringAsResponse
```
public boolean getExpectReadStringAsResponse()
```
    Gets the value indicating whether the new syntax is expected for DMCC results arriving. This syntax is the default for newer device firmware versions.The new format contains the number of bytes in the first row, then the result bytes follow.
    
    Returns:
    
    The value indicating whether the new syntax is expected for DMCC results arriving.
    
    See Also:
    
    setExpectReadStringAsResponse(boolean)
  - setExpectReadStringAsResponse
```
public void setExpectReadStringAsResponse(boolean value)
```
    Sets the value indicating whether the new syntax should be used when handling DMCC results.
    
    Parameters:
    
    value - The value indicating whether the new syntax should be used when handling DMCC results.
    
    See Also:
    
    getExpectReadStringAsResponse()
  - getTimeout
```
public int getTimeout()
```
    Gets the timeout value (in milliseconds) used in operations that can time out. The default is 5000 milliseconds.
    
    Returns:
    
    The timeout value used is the operations that can time out.
    
    See Also:
    
    setTimeout(int), connect(), connect(String, String), sendCommand(String), sendCommand(String, OnResponseReceivedListener)
  - setTimeout
```
public void setTimeout(int timeout)
```
    Sets the timeout value (in milliseconds) used in operations that can time out. This is used when connecting to a reader, when sending a command (except for when the timeout can explicitly be set) and when requesting a live image.
    
    Parameters:
    
    timeout - The value to be used as timeout.
    
    See Also:
    
    getTimeout(), connect(), connect(String, String), sendCommand(String), sendCommand(String, OnResponseReceivedListener)
  - getExtraHeaderData
```
public java.lang.String getExtraHeaderData()
```
    Gets the extra header data sent with all commands.
    
    Returns:
    
    The extra header data sent with all commands.
    
    See Also:
    
    setExtraHeaderData(String)
  - setExtraHeaderData
```
public void setExtraHeaderData(java.lang.String extraHeaderData)
```
    Sets the extra header data sent with all commands.
    
    Parameters:
    
    extraHeaderData - The extra header data to be send with all commands.
    
    See Also:
    
    getExtraHeaderData()
  - getResultTypes
```
public java.util.EnumSet<com.cognex.dataman.sdk.ResultType> getResultTypes()
```
    Gets the result types that should be handled by the SDK. All other result types will be ignored.
    
    Returns:
    
    The result types which are handled by the SDK.
    
    See Also:
    
    ResultType, setResultTypes(EnumSet)
  - setResultTypes
```
public void setResultTypes(java.util.EnumSet<com.cognex.dataman.sdk.ResultType> resultTypes)
```
    Sets the result types that should be handled by the SDK. All other result types will be ignored.
    
    Parameters:
    
    resultTypes - The result types to be handled by the SDK.
    
    See Also:
    
    ResultType, getResultTypes()
  - getCharset
```
public java.nio.charset.Charset getCharset()
```
    Gets the Charset object used when converting a series of bytes from the reader to a string.
    
    Returns:
    
    The Charset object used when converting a series of bytes from the reader to a string.
    
    See Also:
    
    setCharset(Charset)
  - setCharset
```
public void setCharset(java.nio.charset.Charset charset)
```
    Sets the Charset object used when converting a series of bytes from the reader to a string.
    
    Parameters:
    
    charset - The Charset object to be used when converting a series of bytes from the reader to a string.
    
    See Also:
    
    getCharset()
  - isLiveImageEnabled
```
public boolean isLiveImageEnabled()
```
    Indicates whether Live Image mode is enabled or not.
    
    Returns:
    
    true if Live Image mode is enabled, otherwise false.
    
    See Also:
    
    enableLiveImage(ImageFormat, ImageSize, ImageQuality, OnLiveImageArrivedListener), disableLiveImage()
  - isHeartbeatEnabled
```
public boolean isHeartbeatEnabled()
```
    Indicates whether heartbeat is enabled or not.
    
    Returns:
    
    true if heartbeat is enabled, otherwise false.
    
    See Also:
    
    enableHeartbeat(int), disableHeartbeat()
  - setLogger
```
public void setLogger(com.cognex.dataman.sdk.Logger logger)
```
    Sets the optional logger which can be used for debugging purposes.
    
    Parameters:
    
    logger - The logger object to be used for logging.
  - setOnConnectedListener
```
public void setOnConnectedListener(DataManSystem.OnConnectedListener listener)
```
    Registers a callback to be invoked when a connection to a reader is successfully established.
    
    Parameters:
    
    listener - The callback that will be invoked.
    
    See Also:
    
    connect(), connect(String, String)
  - setOnConnectionErrorListener
```
public void setOnConnectionErrorListener(DataManSystem.OnConnectionErrorListener listener)
```
    Register a callback to be invoked when a connection error occurs during connecting to a reader.
    
    Parameters:
    
    listener - The callback that will be invoked.
    
    See Also:
    
    connect(), connect(String, String)
  - setOnDisconnectedListener
```
public void setOnDisconnectedListener(DataManSystem.OnDisconnectedListener listener)
```
    Register a callback to be invoked when disconnected from a reader.
    
    Parameters:
    
    listener - The callback that will be invoked.
    
    See Also:
    
    disconnect()
  - setOnBinaryDataTransferProgressListener
```
public void setOnBinaryDataTransferProgressListener(DataManSystem.OnBinaryDataTransferProgressListener listener)
```
    Register a callback to be invoked to report binary data transfer progress.
    
    Parameters:
    
    listener - The callback that will be invoked.
  - setOnOffProtocolByteReceivedListener
```
public void setOnOffProtocolByteReceivedListener(DataManSystem.OnOffProtocolByteReceivedListener listener)
```
    Register a callback to be invoked when an off protocol byte is received.
    
    Parameters:
    
    listener - The callback that will be invoked.
  - setOnReadStringArrivedListener
```
public void setOnReadStringArrivedListener(DataManSystem.OnReadStringArrivedListener listener)
```
    Register a callback to be invoked when a simple read string is arrived.
    
    Parameters:
    
    listener - The callback that will be invoked.
  - setOnXmlResultArrivedListener
```
public void setOnXmlResultArrivedListener(DataManSystem.OnXmlResultArrivedListener listener)
```
    Register a callback to be invoked when a read result in XML format is arrived.
    
    Parameters:
    
    listener - The callback that will be invoked.
  - setOnXmlStatisticsArrivedListener
```
public void setOnXmlStatisticsArrivedListener(DataManSystem.OnXmlStatisticsArrivedListener listener)
```
    Register a callback to be invoked when a read statistics in XML format is arrived.
    
    Parameters:
    
    listener - The callback that will be invoked.
  - setOnImageArrivedListener
```
public void setOnImageArrivedListener(DataManSystem.OnImageArrivedListener listener)
```
    Register a callback to be invoked when a read image is arrived.
    
    Parameters:
    
    listener - The callback that will be invoked.
  - setOnImageGraphicsArrivedListener
```
public void setOnImageGraphicsArrivedListener(DataManSystem.OnImageGraphicsArrivedListener listener)
```
    Register a callback to be invoked when an image graphics in XML format is arrived.
    
    Parameters:
    
    listener - The callback that will be invoked.
  - setOnTrainingResultArrivedListener
```
public void setOnTrainingResultArrivedListener(DataManSystem.OnTrainingResultArrivedListener listener)
```
    Register a callback to be invoked when a training result in XML format is arrived.
    
    Parameters:
    
    listener - The callback that will be invoked.
  - setOnCodeQualityDataArrivedListener
```
public void setOnCodeQualityDataArrivedListener(DataManSystem.OnCodeQualityDataArrivedListener listener)
```
    Register a callback to be invoked when a code quality data in XML format is arrived.
    
    Parameters:
    
    listener - The callback that will be invoked.
  - setOnStatusEventArrivedListener
```
public void setOnStatusEventArrivedListener(DataManSystem.OnStatusEventArrivedListener listener)
```
    Register a callback to be invoked when a status event is arrived.
    
    Parameters:
    
    listener - The callback that will be invoked.
  - setOnSystemWentOnlineListener
```
public void setOnSystemWentOnlineListener(DataManSystem.OnSystemWentOnlineListener listener)
```
    Register a callback to be invoked when the reader went online.
    
    Parameters:
    
    listener - The callback that will be invoked.
  - setOnSystemWentOfflineListener
```
public void setOnSystemWentOfflineListener(DataManSystem.OnSystemWentOfflineListener listener)
```
    Register a callback to be invoked when the reader went offline.
    
    Parameters:
    
    listener - The callback that will be invoked.
  - setOnHeartbeatResponseMissedListener
```
public void setOnHeartbeatResponseMissedListener(DataManSystem.OnHeartbeatResponseMissedListener listener)
```
    Register a callback to be invoked when the response of a heartbeat command is missed.
    
    Parameters:
    
    listener - The callback that will be invoked.
    
    See Also:
    
    enableHeartbeat(int)
  - getState
```
public com.cognex.dataman.sdk.ConnectionState getState()
```
    Gets the current connection state of this DataManSystem instance.
    
    Returns:
    
    The current connection state.
    
    See Also:
    
    ConnectionState
  - connect
```
public boolean connect()
```
    Initiates a connection to the device with default user name, password and timeout. If connecting succeeds, the user is notified via the DataManSystem.OnConnectedListener. If an error occurs during connecting, the user is notified via the DataManSystem.OnConnectionErrorListener.
    
    Returns:
    
    true if the connection could be initiated (the state of the connection was ConnectionState.Disconnected, otherwise false.
    
    See Also:
    
    setTimeout(int), setOnConnectedListener(OnConnectedListener), setOnConnectionErrorListener(OnConnectionErrorListener)
  - connect
```
public boolean connect(java.lang.String userName,
                       java.lang.String password)
```
    Initiates a connection to the device with the given user name and password and with the default timeout. If connecting succeeds, the user is notified via the DataManSystem.OnConnectedListener. If an error occurs during connecting, the user is notified via the DataManSystem.OnConnectionErrorListener.
    
    Parameters:
    
    userName - The user name to authenticate with the remote system.
    
    password - The password to authenticate with the remote system.
    
    Returns:
    
    true if the connection could be initiated (the state of the connection was ConnectionState.Disconnected, otherwise false.
    
    See Also:
    
    setTimeout(int), setOnConnectedListener(OnConnectedListener), setOnConnectionErrorListener(OnConnectionErrorListener)
  - disconnect
```
public void disconnect()
```
    Initiates a disconnection from the device. If the DataManSystem.OnDisconnectedListener is set, it will be invoked after the device is disconnected.
    
    See Also:
    
    setOnDisconnectedListener(OnDisconnectedListener)
  - isConnected
```
public boolean isConnected()
```
    Indicates the status of the connection.
    
    Returns:
    
    true if the system is connected, otherwise false.
  - getConnectionState
```
public com.cognex.dataman.sdk.ConnectionState getConnectionState()
```
    Returns the connection state of the system.
    
    Returns:
    
    the current connection state
  - sendCommand
```
public void sendCommand(java.lang.String command)
```
    Sends a command to the connected device with the default timeout. The user will not be notified about the result.
    
    Parameters:
    
    command - The command to be send.
    
    See Also:
    
    sendCommand(String, OnResponseReceivedListener), sendCommand(String, byte[], int, boolean, OnResponseReceivedListener), setTimeout(int)
  - sendCommand
```
public void sendCommand(java.lang.String command,
                        DataManSystem.OnResponseReceivedListener listener)
```
    Sends a command to the connected device with the default timeout. The user will be notified about the result in the DataManSystem.OnResponseReceivedListener.
    
    Parameters:
    
    command - The command to be send.
    
    listener - The callback to be invoked when the answer to the command arrives.
    
    See Also:
    
    DataManSystem.OnResponseReceivedListener, sendCommand(String), sendCommand(String, byte[], int, boolean, OnResponseReceivedListener), setTimeout(int)
  - sendCommand
```
public void sendCommand(java.lang.String command,
                        byte[] data,
                        int timeout,
                        boolean expectBinaryResponse,
                        DataManSystem.OnResponseReceivedListener listener)
```
    Sends a command and the specified binary data to the connected device with the given timeout value. If a binary response is expected, it also can be specified. The user will be notified about the result in the DataManSystem.OnResponseReceivedListener.
    
    Parameters:
    
    command - The command to be send.
    
    data - Binary data to be send to the remote system.
    
    timeout - Timeout for the command.
    
    expectBinaryResponse - Value to indicate if we expect binary response.
    
    listener - The callback to be invoked when the answer to the command arrives.
    
    See Also:
    
    DataManSystem.OnResponseReceivedListener, sendCommand(String), sendCommand(String, OnResponseReceivedListener)
  - sendCommandSync
```
public com.cognex.dataman.sdk.DmccResponse sendCommandSync(java.lang.String command,
                                                           byte[] data,
                                                           int timeout,
                                                           boolean expectBinaryResponse)
                                                    throws java.lang.InterruptedException,
                                                           java.util.concurrent.TimeoutException
```
    Sends a command and the specified binary data to the connected device with the given timeout value. If a binary response is expected, it also can be specified. This method will block until the response from the Reader is received or the specified timeout has reached.
    
    Parameters:
    
    command - The command to be send.
    
    data - Binary data to be send to the remote system.
    
    timeout - Timeout for the command.
    
    expectBinaryResponse - Value to indicate if we expect binary response.
    
    Returns:
    
    DmccResponse Reader response for the sent command.
    
    Throws:
    
    java.lang.InterruptedException - if the command sending is interrupted
    
    java.util.concurrent.TimeoutException - if the command has timed out
  - sendBatchCommands
```
public void sendBatchCommands(java.util.List<java.lang.String> commands,
                              DataManSystem.OnBatchCommandsCompletedListener listener)
```
    Sends the commands provided in a List to the connected device serially with the default timeout. The user will be notified about the result of each command in the DataManSystem.OnBatchCommandsCompletedListener.
    
    Parameters:
    
    commands - The List of commands to be sent to the reader.
    
    listener - The callback to be invoked when the response to a specific command arrives.
    
    See Also:
    
    DataManSystem.OnBatchCommandsCompletedListener
  - enableLiveImage
```
public void enableLiveImage(com.cognex.dataman.sdk.ImageFormat imageFormat,
                            com.cognex.dataman.sdk.ImageSize imageSize,
                            com.cognex.dataman.sdk.ImageQuality imageQuality,
                            DataManSystem.OnLiveImageArrivedListener listener)
```
    Enables live image mode and start requesting live images.
    
    Parameters:
    
    imageFormat - The ImageFormat object to specify the image type.
    
    imageSize - The ImageSize object to specify the image size.
    
    imageQuality - The ImageQuality object to specify the image quality.
    
    listener - The callback to be invoked when the live image arrives.
    
    See Also:
    
    disableLiveImage(), DataManSystem.OnLiveImageArrivedListener
  - disableLiveImage
```
public void disableLiveImage()
```
    Disables live image mode and stops requesting live images.
    
    See Also:
    
    enableLiveImage(ImageFormat, ImageSize, ImageQuality, OnLiveImageArrivedListener)
  - enableHeartbeat
```
public void enableHeartbeat(int interval)
```
    Enables heartbeat and start sending heartbeat commands in every interval milliseconds. If a response to a heartbeat command is not received, the DataManSystem.OnHeartbeatResponseMissedListener is invoked if set.
    
    Parameters:
    
    interval - The interval (in milliseconds) between heartbeat commands.
    
    See Also:
    
    disableHeartbeat(), setOnHeartbeatResponseMissedListener(OnHeartbeatResponseMissedListener)
  - disableHeartbeat
```
public void disableHeartbeat()
```
    Disables heartbeat and stops sending heartbeat commands.
    
    See Also:
    
    enableHeartbeat(int)

Class DataManSystem

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

createDataManSystemOverEthernet

createDataManSystemOverEthernet

createDataManSystemOverEthernet

createDataManSystemOverEthernet

createDataManSystemForMXDevice

createDataManSystemForMXDevice

createDataManSystemOverCamera

createDataManSystemOverUsb

createDataManSystemOverUsb

createDataManSystemOverUsbAccessory

createDataManSystemOverUsbAccessory

createDataManSystemOverBlutooth

createDataManSystemOverBlutooth

getVersion

setFlushBufferEnabled

isFlushBufferEnabled

getExpectReadStringAsResponse

setExpectReadStringAsResponse

getTimeout

setTimeout

getExtraHeaderData

setExtraHeaderData

getResultTypes

setResultTypes

getCharset

setCharset

isLiveImageEnabled

isHeartbeatEnabled

setLogger

setOnConnectedListener

setOnConnectionErrorListener

setOnDisconnectedListener

setOnBinaryDataTransferProgressListener

setOnOffProtocolByteReceivedListener

setOnReadStringArrivedListener

setOnXmlResultArrivedListener

setOnXmlStatisticsArrivedListener

setOnImageArrivedListener

setOnImageGraphicsArrivedListener

setOnTrainingResultArrivedListener

setOnCodeQualityDataArrivedListener

setOnStatusEventArrivedListener

setOnSystemWentOnlineListener

setOnSystemWentOfflineListener

setOnHeartbeatResponseMissedListener

getState

connect

connect

disconnect

isConnected

getConnectionState

sendCommand

sendCommand

sendCommand

sendCommandSync

sendBatchCommands

enableLiveImage

disableLiveImage

enableHeartbeat

disableHeartbeat