Package de.gmxhome.conrad.jpos.jpos_base.belt

Class BeltProperties

java.lang.Object
de.gmxhome.conrad.jpos.jpos_base.JposCommonProperties
de.gmxhome.conrad.jpos.jpos_base.belt.BeltProperties
All Implemented Interfaces:
BeltInterface, JposBaseInterface
public class BeltProperties extends JposCommonProperties implements BeltInterface
Class containing the belt specific properties, their default values and default implementations of BeltInterface. For details about properties, methods and method parameters, see UPOS specification, chapter Belt.

  • Field Details

    • AutoStopBackward

      public boolean AutoStopBackward
      UPOS property AutoStopBackward. Default: false.

    • AutoStopBackwardDelayTime

      public int AutoStopBackwardDelayTime
      UPOS property AutoStopBackwardDelayTime. Default: 0.

    • AutoStopBackwardItemCount

      public int AutoStopBackwardItemCount
      UPOS property AutoStopBackwardItemCount. Default: 0.

    • AutoStopForward

      public boolean AutoStopForward
      UPOS property AutoStopForward. Default: false.

    • AutoStopForwardDelayTime

      public int AutoStopForwardDelayTime
      UPOS property AutoStopForwardDelayTime. Default: 0.

    • AutoStopForwardItemCount

      public int AutoStopForwardItemCount
      UPOS property AutoStopBackwardItemCount. Default: 0.

    • CapAutoStopBackward

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

    • CapAutoStopBackwardItemCount

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

    • CapAutoStopForward

      public boolean CapAutoStopForward
      UPOS property CapAutoStopForward. Default: true. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • CapAutoStopForwardItemCount

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

    • CapLightBarrierBackward

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

    • CapLightBarrierForward

      public boolean CapLightBarrierForward
      UPOS property CapLightBarrierForward. Default: true. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • CapMoveBackward

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

    • CapSecurityFlapBackward

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

    • CapSecurityFlapForward

      public boolean CapSecurityFlapForward
      UPOS property CapSecurityFlapForward. Default: true. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • CapSpeedStepsBackward

      public int CapSpeedStepsBackward
      UPOS property CapSpeedStepsBackward. Default: 0. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • CapSpeedStepsForward

      public int CapSpeedStepsForward
      UPOS property CapSpeedStepsForward. Default: 1. Can be overwritten by objects derived from JposDevice within the changeDefaults method.

    • LightBarrierBackwardInterrupted

      public boolean LightBarrierBackwardInterrupted
      UPOS property LightBarrierBackwardInterrupted. Default: false. Must be initialized and kept current while device is enabled.

    • LightBarrierForwardInterrupted

      public boolean LightBarrierForwardInterrupted
      UPOS property LightBarrierForwardInterrupted. Default: false. Must be initialized and kept current while device is enabled.

    • MotionStatus

      public int MotionStatus
      UPOS property MotionStatus. Default: MT_STOPPED. Must be initialized and kept current while device is enabled.

    • SecurityFlapBackwardOpened

      public boolean SecurityFlapBackwardOpened
      UPOS property SecurityFlapBackwardOpened. Default: false. Must be initialized and kept current while device is enabled.

    • SecurityFlapForwardOpened

      public boolean SecurityFlapForwardOpened
      UPOS property SecurityFlapForwardOpened. Default: false. Must be initialized and kept current while device is enabled.

  • Constructor Details

    • BeltProperties

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

  • Method Details

    • autoStopBackward

      public void autoStopBackward​(boolean flag)
      Description copied from interface: BeltInterface
      Final part of setting AutoStopBackward. 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,
      • CapAutoStopBackward is true or flag is false,
      • internal property AllowAlwaysSetProperties is true or flag equals the previous value of AutoStopBackward.
      Specified by:
      autoStopBackward in interface BeltInterface
      Parameters:
      flag - New value for AutoStopBackward property.

    • autoStopBackwardDelayTime

      public void autoStopBackwardDelayTime​(int delay) throws jpos.JposException
      Description copied from interface: BeltInterface
      Final part of setting AutoStopBackwardDelayTime. 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,
      • CapAutoStopBackward is true,
      • delay is FOREVER or positive,
      • internal property AllowAlwaysSetProperties is true or delay equals the previous value of AutoStopBackwardDelayTime.
      Specified by:
      autoStopBackwardDelayTime in interface BeltInterface
      Parameters:
      delay - Time delay in milliseconds for automatic stop in backward direction.
      Throws:
      jpos.JposException - If an error occurs.

    • autoStopForward

      public void autoStopForward​(boolean flag) throws jpos.JposException
      Description copied from interface: BeltInterface
      Final part of setting AutoStopForward. 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,
      • CapAutoStopForward is true or flag is false,
      • internal property AllowAlwaysSetProperties is true or flag equals the previous value of AutoStopForward.
      Specified by:
      autoStopForward in interface BeltInterface
      Parameters:
      flag - New value for AutoStopForward property.
      Throws:
      jpos.JposException - If an error occurs.

    • autoStopForwardDelayTime

      public void autoStopForwardDelayTime​(int delay) throws jpos.JposException
      Description copied from interface: BeltInterface
      Final part of setting AutoStopForwardDelayTime. 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,
      • CapAutoStopForward is true,
      • delay is FOREVER or positive,
      • internal property AllowAlwaysSetProperties is true or delay equals the previous value of AutoStopForwardDelayTime.
      Specified by:
      autoStopForwardDelayTime in interface BeltInterface
      Parameters:
      delay - Time delay in milliseconds for automatic stop in forward direction.
      Throws:
      jpos.JposException - If an error occurs.

    • adjustItemCount

      public void adjustItemCount​(int direction, int count) throws jpos.JposException
      The default implementation increments the corresponding property, AutoStopBackwardItemCount or AutoStopForwardItemCount, by the specified count.
      Specified by:
      adjustItemCount in interface BeltInterface
      Parameters:
      direction - Affected direction, one of RIC_BACKWARD and RIC_FORWARD.
      count - Item count to be added to the specified auto-stop property.
      Throws:
      jpos.JposException - If an error occurs.

    • moveBackward

      public void moveBackward​(int speed) throws jpos.JposException
      Description copied from interface: BeltInterface
      Final part of MoveBackward 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,
      • CapMoveBackward is true,
      • Specified speed is between 1 and CapSpeedStepsBackward.
      Specified by:
      moveBackward in interface BeltInterface
      Parameters:
      speed - New belt speed.
      Throws:
      jpos.JposException - If an error occurs.

    • moveForward

      public void moveForward​(int speed) throws jpos.JposException
      Description copied from interface: BeltInterface
      Final part of MoveForward 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,
      • Specified speed is between 1 and CapSpeedStepsForward.
      Specified by:
      moveForward in interface BeltInterface
      Parameters:
      speed - New belt speed.
      Throws:
      jpos.JposException - If an error occurs.

    • resetBelt

      public void resetBelt() throws jpos.JposException
      Description copied from interface: BeltInterface
      Final part of ResetBelt 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.
      Specified by:
      resetBelt in interface BeltInterface
      Throws:
      jpos.JposException - If an error occurs.

    • resetItemCount

      public void resetItemCount​(int direction) throws jpos.JposException
      The default implementation sets the corresponding property, AutoStopBackwardItemCount or AutoStopForwardItemCount, to 0.
      Specified by:
      resetItemCount in interface BeltInterface
      Parameters:
      direction - Affected direction, one of RIC_BACKWARD and RIC_FORWARD.
      Throws:
      jpos.JposException - If an error occurs.

    • stopBelt

      public void stopBelt() throws jpos.JposException
      Description copied from interface: BeltInterface
      Final part of StopBelt 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.
      Specified by:
      stopBelt in interface BeltInterface
      Throws:
      jpos.JposException - If an error occurs.