Package com.cognex.cmbsdk.enums

Enum Class ImageFormat

java.lang.Object

java.lang.Enum<ImageFormat>

com.cognex.cmbsdk.enums.ImageFormat

All Implemented Interfaces:

Serializable, Comparable<ImageFormat>, Constable

public enum ImageFormat
extends Enum<ImageFormat>

Indicates the image format type for live displays or process monitor images.

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
BITMAP	Bitmap format.
JPEG	Jpeg format.

Method Summary

Modifier and Type	Method	Description
int	getValue()	Gets the integer value of the current ImageFormat object.
static ImageFormat	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ImageFormat[]	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

BITMAP

public static final ImageFormat BITMAP

Bitmap format.

JPEG

public static final ImageFormat JPEG

Jpeg format.

Method Details

values

public static ImageFormat[] 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 ImageFormat 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 ImageFormat object.

Returns:

The integer value of the current ImageFormat object.