eu.id3.face

## Enum FaceError

- java.lang.Object
- - java.lang.Enum<FaceError>
  - - eu.id3.face.FaceError

- All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<FaceError>

      public enum FaceError
      extends java.lang.Enum<FaceError>

  Enumerates the possible error codes returned by this SDK.

- - ### Enum Constant Summary

    Enum Constants
    Enum Constant and Description
    `BASE` Base error code of the Face module.
    `FUNCTION_NOT_IMPLEMENTED` This function is not implemented.
    `INDEXER_ALREADY_INITIALIZED` The face indexer object is already initialized.
    `INDEXER_FULL` Maximum template number of the Face Indexer object has been reached.
    `INDEXER_ID_ALREADY_EXISTS` The requested id already exists in the Face Indexer object.
    `INDEXER_ID_NOT_FOUND` No template with this id has been found in the Face Indexer object.
    `INDEXER_INVALID_INDEX_FILE` This index file is not valid and cannot be loaded.
    `INDEXER_INVALID_TEMPLATE_DATA` The data of the template is corrupted and cannot be added to the Face Indexer object.
    `INFERENCE_BACKEND_ERROR` The inference backend failed to infer, probably due to inconsistent input.
    `INSUFFICIENT_BUFFER` The given buffer is too small.
    `INVALID_HANDLE` The handle is invalid.
    `INVALID_IMAGE_SIZE` The input image size is invalid for this operation.
    `INVALID_LANDMARKS` The computed landmarks are invalid and do not allow to process the desired information.
    `INVALID_MODEL_PATH` The model could not be found in the given directory path.
    `INVALID_PARAMETER` The parameter is invalid.
    `INVALID_PIXEL_FORMAT` The image pixel format is invalid.
    `INVALID_TEMPLATE_FORMAT` The template format is invalid.
    `IOD_TOO_SMALL` The computed interocular distance (IOD) is too small to allow to process the desired information.
    `MINIMUM` Minimum error code of the Face module.
    `OBJECT_DOES_NOT_EXIST` The requested object does not exist; a 'null' should be returned if possible.
    `PROCESSING_UNIT_UNAVAILABLE` The requested processing unit is not available in this build.
    `SUCCESS` No error.
    `UNLOADED_MODEL` The model which is required for this operation was not loaded.

  - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `static FaceError` | `fromValue(int value)` Creates an enumeration value from int.
    `int` | `getValue()` Gets the enumeration value as int.
    `static FaceError` | `valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
    `static FaceError[]` | `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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf`

    - ### Methods inherited from class java.lang.Object

      `getClass, notify, notifyAll, wait, wait, wait`

- - ### Enum Constant Detail

    - #### SUCCESS

          public static final FaceError SUCCESS

      No error.

    - #### INSUFFICIENT_BUFFER

          public static final FaceError INSUFFICIENT_BUFFER

      The given buffer is too small.

    - #### OBJECT_DOES_NOT_EXIST

          public static final FaceError OBJECT_DOES_NOT_EXIST

      The requested object does not exist; a 'null' should be returned if possible.

    - #### BASE

          public static final FaceError BASE

      Base error code of the Face module.

    - #### MINIMUM

          public static final FaceError MINIMUM

      Minimum error code of the Face module.

    - #### INVALID_HANDLE

          public static final FaceError INVALID_HANDLE

      The handle is invalid.

    - #### INVALID_PARAMETER

          public static final FaceError INVALID_PARAMETER

      The parameter is invalid.

    - #### INVALID_PIXEL_FORMAT

          public static final FaceError INVALID_PIXEL_FORMAT

      The image pixel format is invalid.

    - #### INVALID_TEMPLATE_FORMAT

          public static final FaceError INVALID_TEMPLATE_FORMAT

      The template format is invalid.

    - #### INVALID_LANDMARKS

          public static final FaceError INVALID_LANDMARKS

      The computed landmarks are invalid and do not allow to process the desired information.

    - #### IOD_TOO_SMALL

          public static final FaceError IOD_TOO_SMALL

      The computed interocular distance (IOD) is too small to allow to process the desired information.

    - #### INVALID_MODEL_PATH

          public static final FaceError INVALID_MODEL_PATH

      The model could not be found in the given directory path.

    - #### INVALID_IMAGE_SIZE

          public static final FaceError INVALID_IMAGE_SIZE

      The input image size is invalid for this operation.

    - #### UNLOADED_MODEL

          public static final FaceError UNLOADED_MODEL

      The model which is required for this operation was not loaded.

    - #### INFERENCE_BACKEND_ERROR

          public static final FaceError INFERENCE_BACKEND_ERROR

      The inference backend failed to infer, probably due to inconsistent input.

    - #### PROCESSING_UNIT_UNAVAILABLE

          public static final FaceError PROCESSING_UNIT_UNAVAILABLE

      The requested processing unit is not available in this build.

    - #### INDEXER_ALREADY_INITIALIZED

          public static final FaceError INDEXER_ALREADY_INITIALIZED

      The face indexer object is already initialized.

    - #### INDEXER_ID_ALREADY_EXISTS

          public static final FaceError INDEXER_ID_ALREADY_EXISTS

      The requested id already exists in the Face Indexer object.

    - #### INDEXER_INVALID_TEMPLATE_DATA

          public static final FaceError INDEXER_INVALID_TEMPLATE_DATA

      The data of the template is corrupted and cannot be added to the Face Indexer object.

    - #### INDEXER_FULL

          public static final FaceError INDEXER_FULL

      Maximum template number of the Face Indexer object has been reached.

    - #### INDEXER_ID_NOT_FOUND

          public static final FaceError INDEXER_ID_NOT_FOUND

      No template with this id has been found in the Face Indexer object.

    - #### INDEXER_INVALID_INDEX_FILE

          public static final FaceError INDEXER_INVALID_INDEX_FILE

      This index file is not valid and cannot be loaded.

    - #### FUNCTION_NOT_IMPLEMENTED

          public static final FaceError FUNCTION_NOT_IMPLEMENTED

      This function is not implemented.

  - ### Method Detail

    - #### values

          public static FaceError[] values()

      Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

          for (FaceError c : FaceError.values())
              System.out.println(c);

      Returns:
        an array containing the constants of this enum type, in the order they are declared

    - #### valueOf

          public static FaceError valueOf(java.lang.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:
        `java.lang.IllegalArgumentException` - if this enum type has no constant with the specified name
        `java.lang.NullPointerException` - if the argument is null

    - #### getValue

          public int getValue()

      Gets the enumeration value as int.
      Returns:
        The value.

    - #### fromValue

          public static FaceError fromValue(int value)

      Creates an enumeration value from int.
      Parameters:
        `value` - The int value.
      Returns:
        The created FaceError.

Copyright © id3 Technologies. All rights reserved. eu.id3.face