Package com.cognex.cmbsdk.enums

Enum Class ResultType

java.lang.Object

java.lang.Enum<ResultType>

com.cognex.cmbsdk.enums.ResultType

All Implemented Interfaces:

Serializable, Comparable<ResultType>, Constable

public enum ResultType
extends Enum<ResultType>

Defines the result types handled by the SDK.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CODE_QUALITY_DATA	Represents code quality information in XML format.
IMAGE	Represents a read image.
IMAGE_GRAPHICS	Represents an image graphics XML.
NONE	No result of any kind are requested from the reader.
READ_STRING	Represents a simple read result string.
READ_XML	Represents a read result in XML format.
TRAINING_RESULTS	Represents training results in XML format.
XML_CONTENT	Represents code content information in xml format.
XML_STATISTICS	Represents read statistics in XML format.

Method Summary

Modifier and Type	Method	Description
int	getValue()	Gets the integer value of the current ResultType object.
static ResultType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ResultType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NONE

public static final ResultType NONE

No result of any kind are requested from the reader.

READ_STRING

public static final ResultType READ_STRING

Represents a simple read result string.

READ_XML

public static final ResultType READ_XML

Represents a read result in XML format.

XML_STATISTICS

public static final ResultType XML_STATISTICS

Represents read statistics in XML format.

IMAGE

public static final ResultType IMAGE

Represents a read image.

IMAGE_GRAPHICS

public static final ResultType IMAGE_GRAPHICS

Represents an image graphics XML.

TRAINING_RESULTS

public static final ResultType TRAINING_RESULTS

Represents training results in XML format.

CODE_QUALITY_DATA

public static final ResultType CODE_QUALITY_DATA

Represents code quality information in XML format.

XML_CONTENT

public static final ResultType XML_CONTENT

Represents code content information in xml format.

Method Details

values

public static ResultType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ResultType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getValue

public int getValue()

Gets the integer value of the current ResultType object.

Returns:

The integer value of the current ResultType object.