java.lang.Object

java.lang.Enum<MetadataField>

de.pco.common.enums.MetadataField

All Implemented Interfaces:: Serializable, Comparable<MetadataField>, java.lang.constant.Constable

public enum MetadataField
extends Enum<MetadataField>

Enumerator of the fields of the MetadataBean class (Bild-Struct in SDK). Contains info about he min and max values of the numeric fields.

Author:: PCO

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
`ALIGN_UPPER`
`B_MAX`
`B_MAX2`
`B_MIN`
`B_MIN2`
`BINNING_X`
`BINNING_Y`
`BIT_RES`
`BW_LUT`
`BW_LUT2`
`BW_MAX`
`BW_MAX2`
`BW_MIN`
`BW_MIN2`
`CAMERA_SERIAL_NO`
`CAMERA_SUBTYPE`
`CAMERA_SYNC_MODE`
`CAMERA_TYPE`
`COL_LUT`
`COL_LUT2`
`COLOR_COEFF_A11`
`COLOR_COEFF_A12`
`COLOR_COEFF_A13`
`COLOR_COEFF_A21`
`COLOR_COEFF_A22`
`COLOR_COEFF_A23`
`COLOR_COEFF_A31`
`COLOR_COEFF_A32`
`COLOR_COEFF_A33`
`COLOR_PATTERN`
`COLOR_PATTERN_TYPE`
`COLOR_TEMP`
`COLOR_TINT`
`COMPRESSION`
`COMPRESSION_VERSION`
`CONTRAST`
`D_SATURATION`
`DARK_OFFSET`
`DIFF_TO_T0`
`EVENT_NUMBER`
`EXPOSURE_TIME`
`EXPOSURE_TIMEBASE`
`FRAMERATE_MILLI_HZ`
`G_MAX`
`G_MAX2`
`G_MIN`
`G_MIN2`
`GAMMA`
`GAMMA_LUT`
`GAMMA_LUT_C`
`GAMMA_LUT_C2`
`GAMMA_LUT2`
`HAS_METADATA`
`I_SATURATION`
`IMAGE_COUNTER`
`IMAGE_SIZE_X_OFFSET`
`IMAGE_SIZE_Y_OFFSET`
`IMAGE_TIME_STATUS`
`IMAGE_TIME_US`
`IMAGE_TYPE`
`IS_COLOR`
`IS_DOUBLE`
`PREDICTOR_START`
`R_MAX`
`R_MAX2`
`R_MIN`
`R_MIN2`
`RANDOM_INDEX`
`RANDOM_START`
`SENSOR_CONV_FACTOR`
`SENSOR_READOUT_FREQUENCY`
`SENSOR_TEMPERATURE`
`SYNC_STATUS`
`TEXT`
`THIS_IS_T0`
`TICKS`
`TIME_DAY`
`TIME_DAY_OF_WEEK`
`TIME_HOUR`
`TIME_MILLISECONDS`
`TIME_MINUTE`
`TIME_MONTH`
`TIME_SECOND`
`TIME_YEAR`
`TIMESTAMP_POSITION`
`TRIGGER_MODE`
`VERSION`
`VIBRANCE`
`WE_HAVE_T0`
`X_RES`
`Y_RES`

Method Summary

Modifier and Type	Method	Description
`static Object`	`getDefaultValue(MetadataField enumValue)`	Returns the default falue of a numeric field from the MetadataBean
`static Object[]`	`getEnumFieldValues(MetadataField enumValue)`	Returns the possible values of the field from the MetadataBean that is an enumerator
`static Comparable`	`getMaxValue(MetadataField enumValue)`	Returns the maximal falue of a numeric field from the MetadataBean
`static Comparable`	`getMinValue(MetadataField enumValue)`	Returns the minimal falue of a numeric field from the MetadataBean
`static Object`	`getStepValue(MetadataField enumValue)`	Returns the step value for the particular numeric field
`static Object`	`getValueOfField(MetadataBean metadata, MetadataField enumValue)`	By giving the particular field and the object of the MetadataBean class, this method returns the value of this field in this object.
`static boolean`	`isBooleanField(MetadataField enumValue)`	Returns whether the parameter is a boolean field of the MetadataBean.
`static boolean`	`isEnumField(MetadataField enumValue)`	Returns whether the parameter is an enumerator field of the MetadataBean.
`static boolean`	`isNumericField(MetadataField enumValue)`	Returns whether the parameter is a numeric field of the MetadataBean.
`static boolean`	`isTextField(MetadataField enumValue)`	Returns whether the parameter is a textual field of the MetadataBean.
`static void`	`setValueOfField(MetadataBean metadata, MetadataField field, Object value)`	Sets the value
`static MetadataField`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static MetadataField[]`	`values()`	Returns an array containing the constants of this enum type, 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
- TIME_YEAR
  
  public static final MetadataField TIME_YEAR
- TIME_MONTH
  
  public static final MetadataField TIME_MONTH
- TIME_DAY_OF_WEEK
  
  public static final MetadataField TIME_DAY_OF_WEEK
- TIME_DAY
  
  public static final MetadataField TIME_DAY
- TIME_HOUR
  
  public static final MetadataField TIME_HOUR
- TIME_MINUTE
  
  public static final MetadataField TIME_MINUTE
- TIME_SECOND
  
  public static final MetadataField TIME_SECOND
- TIME_MILLISECONDS
  
  public static final MetadataField TIME_MILLISECONDS
- TICKS
  
  public static final MetadataField TICKS
- X_RES
  
  public static final MetadataField X_RES
- Y_RES
  
  public static final MetadataField Y_RES
- TEXT
  
  public static final MetadataField TEXT
- IS_DOUBLE
  
  public static final MetadataField IS_DOUBLE
- THIS_IS_T0
  
  public static final MetadataField THIS_IS_T0
- WE_HAVE_T0
  
  public static final MetadataField WE_HAVE_T0
- BW_MIN
  
  public static final MetadataField BW_MIN
- BW_MAX
  
  public static final MetadataField BW_MAX
- BW_LUT
  
  public static final MetadataField BW_LUT
- R_MIN
  
  public static final MetadataField R_MIN
- R_MAX
  
  public static final MetadataField R_MAX
- G_MIN
  
  public static final MetadataField G_MIN
- G_MAX
  
  public static final MetadataField G_MAX
- B_MIN
  
  public static final MetadataField B_MIN
- B_MAX
  
  public static final MetadataField B_MAX
- COL_LUT
  
  public static final MetadataField COL_LUT
- IS_COLOR
  
  public static final MetadataField IS_COLOR
- VERSION
  
  public static final MetadataField VERSION
- BW_MIN2
  
  public static final MetadataField BW_MIN2
- BW_MAX2
  
  public static final MetadataField BW_MAX2
- BW_LUT2
  
  public static final MetadataField BW_LUT2
- R_MIN2
  
  public static final MetadataField R_MIN2
- R_MAX2
  
  public static final MetadataField R_MAX2
- G_MIN2
  
  public static final MetadataField G_MIN2
- G_MAX2
  
  public static final MetadataField G_MAX2
- B_MIN2
  
  public static final MetadataField B_MIN2
- B_MAX2
  
  public static final MetadataField B_MAX2
- COL_LUT2
  
  public static final MetadataField COL_LUT2
- ALIGN_UPPER
  
  public static final MetadataField ALIGN_UPPER
- GAMMA_LUT
  
  public static final MetadataField GAMMA_LUT
- GAMMA_LUT_C
  
  public static final MetadataField GAMMA_LUT_C
- GAMMA_LUT2
  
  public static final MetadataField GAMMA_LUT2
- GAMMA_LUT_C2
  
  public static final MetadataField GAMMA_LUT_C2
- COLOR_PATTERN_TYPE
  
  public static final MetadataField COLOR_PATTERN_TYPE
- BIT_RES
  
  public static final MetadataField BIT_RES
- D_SATURATION
  
  public static final MetadataField D_SATURATION
- I_SATURATION
  
  public static final MetadataField I_SATURATION
- VIBRANCE
  
  public static final MetadataField VIBRANCE
- COLOR_TEMP
  
  public static final MetadataField COLOR_TEMP
- COLOR_TINT
  
  public static final MetadataField COLOR_TINT
- CONTRAST
  
  public static final MetadataField CONTRAST
- GAMMA
  
  public static final MetadataField GAMMA
- COLOR_COEFF_A11
  
  public static final MetadataField COLOR_COEFF_A11
- COLOR_COEFF_A12
  
  public static final MetadataField COLOR_COEFF_A12
- COLOR_COEFF_A13
  
  public static final MetadataField COLOR_COEFF_A13
- COLOR_COEFF_A21
  
  public static final MetadataField COLOR_COEFF_A21
- COLOR_COEFF_A22
  
  public static final MetadataField COLOR_COEFF_A22
- COLOR_COEFF_A23
  
  public static final MetadataField COLOR_COEFF_A23
- COLOR_COEFF_A31
  
  public static final MetadataField COLOR_COEFF_A31
- COLOR_COEFF_A32
  
  public static final MetadataField COLOR_COEFF_A32
- COLOR_COEFF_A33
  
  public static final MetadataField COLOR_COEFF_A33
- TIMESTAMP_POSITION
  
  public static final MetadataField TIMESTAMP_POSITION
- HAS_METADATA
  
  public static final MetadataField HAS_METADATA
- SENSOR_CONV_FACTOR
  
  public static final MetadataField SENSOR_CONV_FACTOR
- CAMERA_TYPE
  
  public static final MetadataField CAMERA_TYPE
- DARK_OFFSET
  
  public static final MetadataField DARK_OFFSET
- IMAGE_COUNTER
  
  public static final MetadataField IMAGE_COUNTER
- IMAGE_TIME_US
  
  public static final MetadataField IMAGE_TIME_US
- IMAGE_TIME_STATUS
  
  public static final MetadataField IMAGE_TIME_STATUS
- EXPOSURE_TIMEBASE
  
  public static final MetadataField EXPOSURE_TIMEBASE
- SENSOR_TEMPERATURE
  
  public static final MetadataField SENSOR_TEMPERATURE
- EXPOSURE_TIME
  
  public static final MetadataField EXPOSURE_TIME
- FRAMERATE_MILLI_HZ
  
  public static final MetadataField FRAMERATE_MILLI_HZ
- BINNING_X
  
  public static final MetadataField BINNING_X
- BINNING_Y
  
  public static final MetadataField BINNING_Y
- TRIGGER_MODE
  
  public static final MetadataField TRIGGER_MODE
- CAMERA_SYNC_MODE
  
  public static final MetadataField CAMERA_SYNC_MODE
- SENSOR_READOUT_FREQUENCY
  
  public static final MetadataField SENSOR_READOUT_FREQUENCY
- CAMERA_SERIAL_NO
  
  public static final MetadataField CAMERA_SERIAL_NO
- SYNC_STATUS
  
  public static final MetadataField SYNC_STATUS
- IMAGE_TYPE
  
  public static final MetadataField IMAGE_TYPE
- COLOR_PATTERN
  
  public static final MetadataField COLOR_PATTERN
- CAMERA_SUBTYPE
  
  public static final MetadataField CAMERA_SUBTYPE
- EVENT_NUMBER
  
  public static final MetadataField EVENT_NUMBER
- IMAGE_SIZE_X_OFFSET
  
  public static final MetadataField IMAGE_SIZE_X_OFFSET
- IMAGE_SIZE_Y_OFFSET
  
  public static final MetadataField IMAGE_SIZE_Y_OFFSET
- COMPRESSION
  
  public static final MetadataField COMPRESSION
- COMPRESSION_VERSION
  
  public static final MetadataField COMPRESSION_VERSION
- PREDICTOR_START
  
  public static final MetadataField PREDICTOR_START
- RANDOM_START
  
  public static final MetadataField RANDOM_START
- RANDOM_INDEX
  
  public static final MetadataField RANDOM_INDEX
- DIFF_TO_T0
  
  public static final MetadataField DIFF_TO_T0
Method Details
- values
  
  public static MetadataField[] values()
  
  Returns an array containing the constants of this enum type, in the order they are declared.
  
  Returns:
  
  an array containing the constants of this enum type, in the order they are declared
- valueOf
  
  public static MetadataField valueOf(String name)
  
  Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name
  
  NullPointerException - if the argument is null
- getMinValue
  
  public static Comparable getMinValue(MetadataField enumValue)
  
  Returns the minimal falue of a numeric field from the MetadataBean
  
  Parameters:
  
  enumValue -
  
  Returns:
- getMaxValue
  
  public static Comparable getMaxValue(MetadataField enumValue)
  
  Returns the maximal falue of a numeric field from the MetadataBean
  
  Parameters:
  
  enumValue -
  
  Returns:
- getDefaultValue
  
  public static Object getDefaultValue(MetadataField enumValue)
  
  Returns the default falue of a numeric field from the MetadataBean
  
  Parameters:
  
  enumValue -
  
  Returns:
- getStepValue
  
  public static Object getStepValue(MetadataField enumValue)
  
  Returns the step value for the particular numeric field
  
  Parameters:
  
  enumValue -
  
  Returns:
- getEnumFieldValues
  
  public static Object[] getEnumFieldValues(MetadataField enumValue)
  
  Returns the possible values of the field from the MetadataBean that is an enumerator
  
  Parameters:
  
  enumValue -
  
  Returns:
- isNumericField
  
  public static boolean isNumericField(MetadataField enumValue)
  
  Returns whether the parameter is a numeric field of the MetadataBean.
  
  Parameters:
  
  enumValue -
  
  Returns:
- isTextField
  
  public static boolean isTextField(MetadataField enumValue)
  
  Returns whether the parameter is a textual field of the MetadataBean.
  
  Parameters:
  
  enumValue -
  
  Returns:
- isEnumField
  
  public static boolean isEnumField(MetadataField enumValue)
  
  Returns whether the parameter is an enumerator field of the MetadataBean.
  
  Parameters:
  
  enumValue -
  
  Returns:
- isBooleanField
  
  public static boolean isBooleanField(MetadataField enumValue)
  
  Returns whether the parameter is a boolean field of the MetadataBean.
  
  Parameters:
  
  enumValue -
  
  Returns:
- getValueOfField
  
  public static Object getValueOfField(MetadataBean metadata, MetadataField enumValue)
  
  By giving the particular field and the object of the MetadataBean class, this method returns the value of this field in this object.
  
  Parameters:
  
  enumValue -
  
  Returns:
- setValueOfField
  
  public static void setValueOfField(MetadataBean metadata, MetadataField field, Object value)
  
  Sets the value
  
  Parameters:
  
  metadata -
  
  field -
  
  value -

Enum MetadataField

Nested Class Summary

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

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Details

Method Details