Cognex Mobile Barcode SDK SDK for supporting communication with Cognex Barcode Reader devices

Instance Methods | List of all members
<CDMDataManSystemDelegate> Protocol Reference

DataMan system delegate protocol. More...

`#import <CDMDataManSystemDelegate.h>`

Inheritance diagram for <CDMDataManSystemDelegate>:

## Instance Methods
(void) | - dataManSystemDidConnect:
| Occurs when the remote system has successfully connected. More...
(void) | - dataManSystemDidDisconnect:withError:
| Occurs when the remote system gets disconnected. More...
(void) | - dataManSystem:didReceiveReadString:withId:
| Occurs when the connected remote system sends a decoded string. More...
(void) | - dataManSystem:didReceiveImage:withId:
| Occurs when the connected remote system sends an image. More...
(void) | - dataManSystemDidMissHeartbeatResponse:
| Occurs when the connected remote system does not respond to a heartbeat request within a specified interval. More...
(void) | - dataManSystem:didReceiveXmlStatistics:
| Occurs when the connected remote system sends XML statistics. More...
(void) | - dataManSystem:didReceiveXmlResult:withId:
| Occurs when the connected remote system sends XML results. More...
(void) | - dataManSystem:didReceiveImageGraphics:withId:
| Occurs when the connected remote system sends image graphics message. More...
(void) | - dataManSystem:didReceiveTrainingResult:
| Occurs when the connected remote system reports training results. More...
(void) | - dataManSystem:didReceiveStatusEvent:
| Occurs when the connected remote system reports a status event. More...
(void) | - dataManSystem:didReceiveTransferProgress:totalSize:sizeTransferred:
| Occurs when the connected remote system reports its progress. More...
(void) | - dataManSystem:didReceiveOffProtocolByte:
| Occurs when an off protocol byte is received by the connected remote system. More...

## Detailed Description

DataMan system delegate protocol.

## Method Documentation

## ◆ dataManSystem:didReceiveImage:withId:

- (void) dataManSystem: |  | (CDMDataManSystem *) | dataManSystem
didReceiveImage: |  | (UIImage *) | image
withId: |  | (int) | resultId

Occurs when the connected remote system sends an image.

Parameters

  dataManSystem | The DataMan system that is sending the delegate
  image | Image sent by the connected system
  resultId | Identifier of the result. This value can be used to match the image with other result types, like read strings, image graphics or XML results.

Warning
  To receive this event from the device you need to change the value of the CDMDataManSystem::resultTypes property to include CDMDataManSystem::kCDMResultTypeImage value

See also
  CDMDataManSystem
  CDMResultTypes

## ◆ dataManSystem:didReceiveImageGraphics:withId:

- (void) dataManSystem: |  | (CDMDataManSystem *) | dataManSystem
didReceiveImageGraphics: |  | (NSData *) | graphics
withId: |  | (int) | resultId
| optional

Occurs when the connected remote system sends image graphics message.

Parameters

  dataManSystem | The DataMan system that is sending the delegate
  graphics | Image graphics sent by the connected system
  resultId | Identifier of the result. This value can be used to match the image graphics with other result types, like read strings, image or XML results.

Warning
  To receive this event from the device you need to change the value of the CDMDataManSystem::resultTypes property to include CDMDataManSystem::kCDMResultTypeImageGraphics value

See also
  CDMDataManSystem
  CDMResultTypes

## ◆ dataManSystem:didReceiveOffProtocolByte:

- (void) dataManSystem: |  | (CDMDataManSystem *) | dataManSystem
didReceiveOffProtocolByte: |  | (Byte) | byte
| optional

Occurs when an off protocol byte is received by the connected remote system.

Parameters

  dataManSystem | the DataMan system that is sending the delegate
  byte | The off protocol byte

## ◆ dataManSystem:didReceiveReadString:withId:

- (void) dataManSystem: |  | (CDMDataManSystem *) | dataManSystem
didReceiveReadString: |  | (NSString *) | readString
withId: |  | (int) | resultId

Occurs when the connected remote system sends a decoded string.

Parameters

  dataManSystem | The DataMan system that is sending the delegate
  readString | String sent by the connected system
  resultId | Identifier of the result. This value can be used to match the read string with other result types, like images, image graphics or XML results.

Warning
  To receive this event from the device you need to change the value of the CDMDataManSystem::resultTypes property to include CDMDataManSystem::kCDMResultTypeReadString value

See also
  CDMDataManSystem
  CDMResultTypes

## ◆ dataManSystem:didReceiveStatusEvent:

- (void) dataManSystem: |  | (CDMDataManSystem *) | dataManSystem
didReceiveStatusEvent: |  | (NSData *) | data
| optional

Occurs when the connected remote system reports a status event.

Parameters

  dataManSystem | The DataMan system that is sending the delegate
  data | Status event data

## ◆ dataManSystem:didReceiveTrainingResult:

- (void) dataManSystem: |  | (CDMDataManSystem *) | dataManSystem
didReceiveTrainingResult: |  | (NSString *) | trainingResult
| optional

Occurs when the connected remote system reports training results.

Parameters

  dataManSystem | The DataMan system that is sending the delegate
  trainingResult | Training result

Warning
  To receive this event from the device you need to change the value of the CDMDataManSystem::resultTypes property to include CDMDataManSystem::kCDMResultTypeTrainingResults value

See also
  CDMDataManSystem
  CDMResultTypes

## ◆ dataManSystem:didReceiveTransferProgress:totalSize:sizeTransferred:

- (void) dataManSystem: |  | (CDMDataManSystem *) | dataManSystem
didReceiveTransferProgress: |  | (CDMTransferDirection) | direction
totalSize: |  | (NSInteger) | total
sizeTransferred: |  | (NSInteger) | size
| optional

Occurs when the connected remote system reports its progress.

Parameters

  dataManSystem | The DataMan system that is sending the delegate
  direction | Direction of transfer
  total | Total size of the data being transferred
  size | Size of the already transferred data

## ◆ dataManSystem:didReceiveXmlResult:withId:

- (void) dataManSystem: |  | (CDMDataManSystem *) | dataManSystem
didReceiveXmlResult: |  | (NSData *) | xml
withId: |  | (int) | resultId
| optional

Occurs when the connected remote system sends XML results.

Parameters

  dataManSystem | The DataMan system that is sending the delegate
  xml | XML results sent by the connected system
  resultId | Identifier of the result. This value can be used to match the result XML with other result types, like images, image graphics or read strings.

Warning
  To receive this event from the device you need to change the value of the CDMDataManSystem::resultTypes property to include CDMDataManSystem::kCDMResultTypeReadXml value

See also
  CDMDataManSystem
  CDMResultTypes

## ◆ dataManSystem:didReceiveXmlStatistics:

- (void) dataManSystem: |  | (CDMDataManSystem *) | dataManSystem
didReceiveXmlStatistics: |  | (NSData *) | xml
| optional

Occurs when the connected remote system sends XML statistics.

Parameters

  dataManSystem | The DataMan system that is sending the delegate
  xml | XML statistics sent by the connected system

Warning
  To receive this event from the device you need to change the value of the CDMDataManSystem::resultTypes property to include CDMDataManSystem::kCDMResultTypeXmlStatistics value

See also
  CDMDataManSystem
  CDMResultTypes

## ◆ dataManSystemDidConnect:

- (void) dataManSystemDidConnect: |  | (CDMDataManSystem *) | dataManSystem |

Occurs when the remote system has successfully connected.

Parameters

  dataManSystem | The DataMan system that is sending the delegate

## ◆ dataManSystemDidDisconnect:withError:

- (void) dataManSystemDidDisconnect: |  | (CDMDataManSystem *) | dataManSystem
withError: |  | (NSError *) | error

Occurs when the remote system gets disconnected.

Parameters

  dataManSystem | The DataMan system that is sending the delegate
  error | The error object if an error has occured during disconnect, or nil if there was no error

## ◆ dataManSystemDidMissHeartbeatResponse:

- (void) dataManSystemDidMissHeartbeatResponse: |  | (CDMDataManSystem *) | dataManSystem |
| optional

Occurs when the connected remote system does not respond to a heartbeat request within a specified interval.

To enable heartbeat for the device you need to call enableHeartbeatWithInterval: (CDMDataManSystem) method.

Parameters

  dataManSystem | The DataMan system that has missed the heartbeat response

The documentation for this protocol was generated from the following file:

- CDMDataManSystemDelegate.h