Package com.cognex.cmbsdk.resultcollector

Class ResultCollector

java.lang.Object

com.cognex.cmbsdk.resultcollector.ResultCollector

All Implemented Interfaces:

DataManSystem.OnCodeQualityDataArrivedListener, DataManSystem.OnImageDataArrivedListener, DataManSystem.OnImageGraphicsArrivedListener, DataManSystem.OnReadStringArrivedListener, DataManSystem.OnTrainingResultArrivedListener, DataManSystem.OnXmlResultArrivedListener, DataManSystem.OnXmlStatisticsArrivedListener

public class ResultCollector
extends Object
implements DataManSystem.OnCodeQualityDataArrivedListener, DataManSystem.OnImageDataArrivedListener, DataManSystem.OnImageGraphicsArrivedListener, DataManSystem.OnXmlResultArrivedListener, DataManSystem.OnReadStringArrivedListener, DataManSystem.OnXmlStatisticsArrivedListener, DataManSystem.OnTrainingResultArrivedListener

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ResultCollector.ResultCollectorListener

Constructor Summary

Constructors

Constructor	Description
ResultCollector(DataManSystem system, EnumSet<ResultType> expectedResultTypes, Executor executor)

Method Summary

Modifier and Type	Method	Description
void	clearCachedResults()
void	emptyResultQueue()
int	getResultCacheLength()
long	getResultTimeOut()
void	onCodeQualityDataArrived(DataManSystem dataManSystem, String codeQualityData)	Called when the code quality data has been arrived.
void	onImageDataArrived(DataManSystem dataManSystem, int resultId, byte[] imageData)	Called when an image has been arrived.
void	onImageGraphicsArrived(DataManSystem dataManSystem, int resultId, String imageGraphics)	Called when the image graphics has been arrived.
void	onReadStringArrived(DataManSystem dataManSystem, int resultId, String readString)	Called when a read string has been arrived.
void	onTrainingResultArrived(DataManSystem dataManSystem, String trainingResult)	Called when the training result has been arrived.
void	onXmlResultArrived(DataManSystem dataManSystem, int resultId, String xmlResult)	Called when the XML result has been arrived.
void	onXmlStatisticsArrived(DataManSystem dataManSystem, String xmlStatistics)	Called when the XML statistics has been arrived.
void	parseAndStoreResponse(ResultType dataType, int responseId, Object data)
void	release()
void	setResultCacheLength(int resultCacheLength)
void	setResultCollectorListener(ResultCollector.ResultCollectorListener listener)
void	setResultTimeOut(long resultTimeOut)

Methods inherited from class java.lang.Object

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

Constructor Details

ResultCollector

public ResultCollector(DataManSystem system,
 EnumSet<ResultType> expectedResultTypes,
 Executor executor)

Method Details

setResultCollectorListener

public void setResultCollectorListener(ResultCollector.ResultCollectorListener listener)

release

public void release()

setResultTimeOut

public void setResultTimeOut(long resultTimeOut)

getResultTimeOut

public long getResultTimeOut()

getResultCacheLength

public int getResultCacheLength()

setResultCacheLength

public void setResultCacheLength(int resultCacheLength)

clearCachedResults

public void clearCachedResults()

emptyResultQueue

public void emptyResultQueue()

parseAndStoreResponse

public void parseAndStoreResponse(ResultType dataType,
 int responseId,
 Object data)

onTrainingResultArrived

public void onTrainingResultArrived(DataManSystem dataManSystem,
 String trainingResult)

Description copied from interface: DataManSystem.OnTrainingResultArrivedListener

Called when the training result has been arrived.

Specified by:

onTrainingResultArrived in interface DataManSystem.OnTrainingResultArrivedListener

Parameters:

dataManSystem - The DataManSystem object that invoked the callback.

trainingResult - The training result in XML format that arrived from the reader.

onXmlStatisticsArrived

public void onXmlStatisticsArrived(DataManSystem dataManSystem,
 String xmlStatistics)

Description copied from interface: DataManSystem.OnXmlStatisticsArrivedListener

Called when the XML statistics has been arrived.

Specified by:

onXmlStatisticsArrived in interface DataManSystem.OnXmlStatisticsArrivedListener

Parameters:

dataManSystem - The DataManSystem object that invoked the callback.

xmlStatistics - The read statistics in XML format.

onXmlResultArrived

public void onXmlResultArrived(DataManSystem dataManSystem,
 int resultId,
 String xmlResult)

Description copied from interface: DataManSystem.OnXmlResultArrivedListener

Called when the XML result has been arrived.

Specified by:

onXmlResultArrived in interface DataManSystem.OnXmlResultArrivedListener

Parameters:

dataManSystem - The DataManSystem object that invoked the callback.

resultId - The identifier of the result. This value can be used to match the read string with the other result types like images, image graphics or XML results.

xmlResult - The result of a read in XML format.

onReadStringArrived

public void onReadStringArrived(DataManSystem dataManSystem,
 int resultId,
 String readString)

Description copied from interface: DataManSystem.OnReadStringArrivedListener

Called when a read string has been arrived.

Specified by:

onReadStringArrived in interface DataManSystem.OnReadStringArrivedListener

Parameters:

dataManSystem - The DataManSystem object that invoked the callback.

resultId - The identifier of the result. This value can be used to match the read string with the other result types like images, image graphics or XML results.

readString - The string read by the system.

onImageGraphicsArrived

public void onImageGraphicsArrived(DataManSystem dataManSystem,
 int resultId,
 String imageGraphics)

Description copied from interface: DataManSystem.OnImageGraphicsArrivedListener

Called when the image graphics has been arrived.

Specified by:

onImageGraphicsArrived in interface DataManSystem.OnImageGraphicsArrivedListener

Parameters:

dataManSystem - The DataManSystem object that invoked the callback.

resultId - The identifier of the result. This value can be used to match the read string with the other result types like images, image graphics or XML results.

imageGraphics - The image graphics in XML format that arrived from the reader.

onImageDataArrived

public void onImageDataArrived(DataManSystem dataManSystem,
 int resultId,
 byte[] imageData)

Description copied from interface: DataManSystem.OnImageDataArrivedListener

Called when an image has been arrived.

Specified by:

onImageDataArrived in interface DataManSystem.OnImageDataArrivedListener

Parameters:

dataManSystem - The DataManSystem object that invoked the callback.

resultId - The identifier of the result. This value can be used to match the read string with the other result types like images, image graphics or XML results.

imageData - The image as byte array that arrived from the reader.

onCodeQualityDataArrived

public void onCodeQualityDataArrived(DataManSystem dataManSystem,
 String codeQualityData)

Description copied from interface: DataManSystem.OnCodeQualityDataArrivedListener

Called when the code quality data has been arrived.

Specified by:

onCodeQualityDataArrived in interface DataManSystem.OnCodeQualityDataArrivedListener

Parameters:

dataManSystem - The DataManSystem object that invoked the callback.

codeQualityData - The code quality data in XML format that arrived from the reader.