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

Interface BeltInterface

All Superinterfaces:

JposBaseInterface

All Known Implementing Classes:

BeltProperties

public interface BeltInterface
extends JposBaseInterface

Interface for methods that implement property setter and method calls for the Belt device category. For details about properties, methods and method parameters, see UPOS specification, chapter Belt. Further details about error handling can be found in introduction - Device Behavior Models - Errors.

Method Summary

Modifier and Type	Method	Description
void	adjustItemCount(int direction, int count)	Final part of AdjustItemCount method.
void	autoStopBackward(boolean flag)	Final part of setting AutoStopBackward.
void	autoStopBackwardDelayTime(int delay)	Final part of setting AutoStopBackwardDelayTime.
void	autoStopForward(boolean flag)	Final part of setting AutoStopForward.
void	autoStopForwardDelayTime(int delay)	Final part of setting AutoStopForwardDelayTime.
void	moveBackward(int speed)	Final part of MoveBackward method.
void	moveForward(int speed)	Final part of MoveForward method.
void	resetBelt()	Final part of ResetBelt method.
void	resetItemCount(int direction)	Final part of ResetItemCount method.
void	stopBelt()	Final part of StopBelt method.

Methods inherited from interface de.gmxhome.conrad.jpos.jpos_base.JposBaseInterface

asyncMode, autoDisable, checkHealth, claim, clearInput, clearOutput, close, compareFirmwareVersion, dataEventEnabled, deviceEnabled, directIO, directIO, flagWhenIdle, freezeEvents, handlePowerStateOnEnable, newJposOutputRequest, open, powerNotify, release, removeFromPropertySetList, resetStatistics, retrieveStatistics, retryInput, retryOutput, unitDataCount, updateFirmware, updateFirmware, updateStatistics

Method Details

autoStopBackward

void autoStopBackward(boolean flag)
               throws jpos.JposException

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.

Parameters:

flag - New value for AutoStopBackward property.

Throws:

jpos.JposException - If an error occurs.

autoStopBackwardDelayTime

void autoStopBackwardDelayTime(int delay)
                        throws jpos.JposException

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.

Parameters:

delay - Time delay in milliseconds for automatic stop in backward direction.

Throws:

jpos.JposException - If an error occurs.

autoStopForward

void autoStopForward(boolean flag)
              throws jpos.JposException

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.

Parameters:

flag - New value for AutoStopForward property.

Throws:

jpos.JposException - If an error occurs.

autoStopForwardDelayTime

void autoStopForwardDelayTime(int delay)
                       throws jpos.JposException

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.

Parameters:

delay - Time delay in milliseconds for automatic stop in forward direction.

Throws:

jpos.JposException - If an error occurs.

adjustItemCount

void adjustItemCount(int direction,
 int count)
              throws jpos.JposException

Final part of AdjustItemCount 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 direction is AIC_BACKWARD or AIC_FORWARD,
• If direction is AIC_FORWARD, CapAutoStopForwardItemCount is true,
• If direction is AIC_BACKWARD, CapAutoStopBackwardItemCount is true.

Parameters:

direction - Affected direction, one of AIC_BACKWARD and AIC_FORWARD.

count - Number of items to be added to current item count. Max be positive or negative.

Throws:

jpos.JposException - If an error occurs.

moveBackward

void moveBackward(int speed)
           throws jpos.JposException

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.

Parameters:

speed - New belt speed.

Throws:

jpos.JposException - If an error occurs.

moveForward

void moveForward(int speed)
          throws jpos.JposException

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.

Parameters:

speed - New belt speed.

Throws:

jpos.JposException - If an error occurs.

resetBelt

void resetBelt()
        throws jpos.JposException

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.

Throws:

jpos.JposException - If an error occurs.

resetItemCount

void resetItemCount(int direction)
             throws jpos.JposException

Final part of ResetItemCount 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 direction is RIC_BACKWARD or RIC_FORWARD,
• If direction is RIC_FORWARD, CapAutoStopForwardItemCount is true,
• If direction is RIC_BACKWARD, CapAutoStopBackwardItemCount is true.

Parameters:

direction - Affected direction, one of RIC_BACKWARD and RIC_FORWARD.

Throws:

jpos.JposException - If an error occurs.

stopBelt

void stopBelt()
       throws jpos.JposException

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.

Throws:

jpos.JposException - If an error occurs.