Package de.gmxhome.conrad.jpos.jpos_base.imagescanner

Class ImageScannerProperties

java.lang.Object
de.gmxhome.conrad.jpos.jpos_base.JposCommonProperties
de.gmxhome.conrad.jpos.jpos_base.imagescanner.ImageScannerProperties
All Implemented Interfaces:
ImageScannerInterface, JposBaseInterface
public class ImageScannerProperties extends JposCommonProperties implements ImageScannerInterface
Class containing the image scanner specific properties, their default values and default implementations of ImageScannerInterface. For details about properties, methods and method parameters, see UPOS specification, chapter Image Scanner.

  • Field Details

    • StoredAutoDisable

      public boolean StoredAutoDisable
      Copy of AutoDisable property. This is the copy set and returned by AutoDisable getter and setter. However, since data event based standard handling must be replace by non-standard handling in case of video mode, the AutoDisabled property itself will be set to false in video mode by the framework.
      Since access to AutoDisable will always be made via getter and setter, the application does not recognize this automatism, it sees always StoredAutoDisable instead of AutoDisable.

    • CapAim

      public boolean CapAim
      UPOS property CapAim. Default: false. Can be overwritten by objects derived from JposDevice within the changeDefaults or checkProperties method.

    • CapDecodeData

      public boolean CapDecodeData
      UPOS property CapDecodeData. Default: false. Can be overwritten by objects derived from JposDevice within the changeDefaults or checkProperties method.

    • CapHostTriggered

      public boolean CapHostTriggered
      UPOS property CapHostTriggered. Default: false. Can be overwritten by objects derived from JposDevice within the changeDefaults or checkProperties method.

    • CapIlluminate

      public boolean CapIlluminate
      UPOS property CapIlluminate. Default: false. Can be overwritten by objects derived from JposDevice within the changeDefaults or checkProperties method.

    • CapImageData

      public boolean CapImageData
      UPOS property CapImageData. Default: false. Can be overwritten by objects derived from JposDevice within the changeDefaults or checkProperties method.

    • CapImageQuality

      public boolean CapImageQuality
      UPOS property CapImageQuality. Default: false. Can be overwritten by objects derived from JposDevice within the changeDefaults or checkProperties method.

    • CapVideoData

      public boolean CapVideoData
      UPOS property CapVideoData. Default: false. Can be overwritten by objects derived from JposDevice within the changeDefaults or checkProperties method.

    • AimMode

      public boolean AimMode
      UPOS property AimMode. Default: false. Can be overwritten by objects derived from JposDevice within the changeDefaults or checkProperties method.

    • BitsPerPixel

      public Integer BitsPerPixel
      UPOS property BitsPerPixel. Default: null.

    • FrameData

      public byte[] FrameData
      UPOS property FrameData. Default: null.

    • FrameType

      public Integer FrameType
      UPOS property FrameType. Default: null.

    • IlluminateMode

      public Boolean IlluminateMode
      UPOS property IlluminateMode. Default: null.

    • ImageHeight

      public Integer ImageHeight
      UPOS property ImageHeight. Default: null.

    • ImageLength

      public Integer ImageLength
      UPOS property ImageLength. Default: null.

    • ImageMode

      public int ImageMode
      UPOS property ImageMode. Default: STILL_ONLY.

    • ImageQuality

      public int ImageQuality
      UPOS property ImageQuality. Default: QUAL_HIGH.

    • ImageType

      public Integer ImageType
      UPOS property ImageType. Default: null.

    • ImageWidth

      public Integer ImageWidth
      UPOS property ImageWidth. Default: null.

    • VideoCount

      public int VideoCount
      UPOS property VideoCount. Default: 15.

    • VideoRate

      public int VideoRate
      UPOS property VideoRate. Default: 30.

  • Constructor Details

    • ImageScannerProperties

      protected ImageScannerProperties​(int dev)
      Constructor.
      Parameters:
      dev - Device index

  • Method Details

    • clearDataProperties

      public void clearDataProperties()
      Description copied from class: JposCommonProperties
      Clear data properties. Performed during ClearInput and ClearInputProperties.
      Overrides:
      clearDataProperties in class JposCommonProperties

    • autoDisable

      public void autoDisable​(boolean enable) throws jpos.JposException
      Description copied from interface: JposBaseInterface
      Final part of setting AutoDisable. Can be overwritten within derived classes. This method will be called only if the following plausibility checks lead to a positive result:
      • Device has not been closed.
      Specified by:
      autoDisable in interface JposBaseInterface
      Overrides:
      autoDisable in class JposCommonProperties
      Parameters:
      enable - New property value
      Throws:
      jpos.JposException - If an error occurs while setting the property

    • aimMode

      public void aimMode​(boolean aimMode) throws jpos.JposException
      Description copied from interface: ImageScannerInterface
      Final part of setting AimMode. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:
      • Device is open,
      • CapAim is true or aimMode equals the previous property value,
      • internal property AllowAlwaysSetProperties is true or aimMode equals the previous value of AimMode.
      Specified by:
      aimMode in interface ImageScannerInterface
      Parameters:
      aimMode - New value for AimMode property.
      Throws:
      jpos.JposException - If an error occurs.

    • illuminateMode

      public void illuminateMode​(boolean illuminateMode) throws jpos.JposException
      Description copied from interface: ImageScannerInterface
      Final part of setting IlluminateMode. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:
      • Device is open,
      • CapIlluminate is true or illuminateMode equals the previous property value,
      • internal property AllowAlwaysSetProperties is true or illuminateMode equals the previous value of IlluminateMode.
      Specified by:
      illuminateMode in interface ImageScannerInterface
      Parameters:
      illuminateMode - New value for IlluminateMode property.
      Throws:
      jpos.JposException - If an error occurs.

    • imageMode

      public void imageMode​(int imageMode) throws jpos.JposException
      Description copied from interface: ImageScannerInterface
      Final part of setting ImageMode. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:
      • Device is open,
      • imageMode is one of DECODE_ONLY, STILL_ONLY, STILL_DECODE, VIDEO_DECODE, VIDEO_STILL or ALL,
      • imageMode matches the capabilities CapDecodeData, CapImageData and CapVideoData,
      • internal property AllowAlwaysSetProperties is true or imageMode equals the previous value of ImageMode.
      Specified by:
      imageMode in interface ImageScannerInterface
      Parameters:
      imageMode - New value for ImageMode property.
      Throws:
      jpos.JposException - If an error occurs.

    • imageQuality

      public void imageQuality​(int imageQuality) throws jpos.JposException
      Description copied from interface: ImageScannerInterface
      Final part of setting ImageQuality. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:
      • Device is open,
      • imageQuality is one of QUAL_LOW, QUAL_MED or QUAL_HIGH,
      • if CapImageQuality is false, imageQuality equals the previous property value,
      • internal property AllowAlwaysSetProperties is true or imageQuality equals the previous value of ImageQuality.
      Specified by:
      imageQuality in interface ImageScannerInterface
      Parameters:
      imageQuality - New value for ImageQuality property.
      Throws:
      jpos.JposException - If an error occurs.

    • videoCount

      public void videoCount​(int videoCount) throws jpos.JposException
      Description copied from interface: ImageScannerInterface
      Final part of setting VideoCount. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:
      • Device is open,
      • videoRate is a positive value,
      • internal property AllowAlwaysSetProperties is true or videoCount equals the previous value of VideoCount.
      Specified by:
      videoCount in interface ImageScannerInterface
      Parameters:
      videoCount - New value for VideoCount property.
      Throws:
      jpos.JposException - If an error occurs.

    • videoRate

      public void videoRate​(int videoRate) throws jpos.JposException
      Description copied from interface: ImageScannerInterface
      Final part of setting VideoRate. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:
      • Device is open,
      • videoRate is a positive value,
      • internal property AllowAlwaysSetProperties is true or videoRate equals the previous value of VideoRate.
      Specified by:
      videoRate in interface ImageScannerInterface
      Parameters:
      videoRate - New value for VideoRate property.
      Throws:
      jpos.JposException - If an error occurs.

    • startSession

      public void startSession() throws jpos.JposException
      Description copied from interface: ImageScannerInterface
      Final part of StartSession method. Can be overwritten in derived class, if necessary. This method will be called only if the following plausibility checks lead to a positive result:
      • Device is enabled,
      • CapHostTriggered is true.
      Specified by:
      startSession in interface ImageScannerInterface
      Throws:
      jpos.JposException - If an error occurs or in case of a timeout.

    • stopSession

      public void stopSession() throws jpos.JposException
      Description copied from interface: ImageScannerInterface
      Final part of StopSession method. Can be overwritten in derived class, if necessary. This method will be called only if the following plausibility checks lead to a positive result:
      • Device is enabled,
      • CapHostTriggered is true.
      Specified by:
      stopSession in interface ImageScannerInterface
      Throws:
      jpos.JposException - If an error occurs or in case of a timeout.