Package de.gmxhome.conrad.jpos.jpos_base.gate

Class GateProperties

java.lang.Object

de.gmxhome.conrad.jpos.jpos_base.JposCommonProperties

de.gmxhome.conrad.jpos.jpos_base.gate.GateProperties

All Implemented Interfaces:

GateInterface, JposBaseInterface

public class GateProperties
extends JposCommonProperties
implements GateInterface

Class containing the gate specific properties, their default values and default implementations of GateInterface. For details about properties, methods and method parameters, see UPOS specification, chapter Gate.

Field Summary

Fields

Modifier and Type	Field	Description
boolean	CapGateStatus	UPOS property CapStatus.
int	GateStatus	UPOS property GateStatus.

Fields inherited from class de.gmxhome.conrad.jpos.jpos_base.JposCommonProperties

AllowAlwaysSetProperties, AllowDeprecatedMethods, AsyncInputActive, AsyncMode, AutoDisable, CapStatisticsReporting, CapUpdateStatistics, CheckHealthText, Claimed, Claiming, ClaimWaiters, CurrentCommands, CurrentUnitID, DataCount, DataEventEnabled, DataEventList, Device, DeviceEnabled, DeviceServiceDescription, DeviceServiceVersion, DevProps, ErrorString, ErrorUnits, EventCB, EventList, EventSource, EventString, EventUnitID, EventUnits, ExclusiveAllowed, ExclusiveNo, ExclusiveUse, ExclusiveYes, FirstEnableHappened, FlagWhenIdle, FlagWhenIdleStatusValue, FreezeEvents, Index, LogicalName, MaximumConfirmationEventWaitingTime, OutputID, PowerNotify, PowerState, SerializedRequestRunner, SerializedRequests, State, StrictFIFOEventHandling, SuspendedCommands, SuspendedConcurrentCommands, UnitsOnline, UsesSubsystemUnits

Constructor Summary

Constructors

Constructor	Description
GateProperties(int dev)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	initOnOpen()	Initialization of properties that must be initialized during open.
void	openGate()	Final part of OpenGate method.
void	waitForGateClose(int timeout)	Final part of WaitForGateClose method.

Methods inherited from class de.gmxhome.conrad.jpos.jpos_base.JposCommonProperties

addProperties, asyncMode, attachWaiter, autoDisable, checkForDeprecation, checkHealth, checkProperties, claim, clearDataProperties, clearErrorProperties, clearInput, clearOutput, clearOutputErrorProperties, close, compareFirmwareVersion, dataEventEnabled, deviceEnabled, directIO, directIO, flagWhenIdle, freezeEvents, getClaimingInstance, handlePowerStateOnEnable, initOnClaim, initOnEnable, initOnFirstEnable, newJposOutputRequest, open, powerNotify, release, releaseWaiter, removeFromPropertySetList, resetStatistics, retrieveStatistics, retryInput, retryOutput, signalWaiter, unitDataCount, updateFirmware, updateFirmware, updateStatistics, waitWaiter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

Field Details

CapGateStatus

public boolean CapGateStatus

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

GateStatus

public int GateStatus

UPOS property GateStatus. Must be overwritten in the individual initOnEnable method.

Constructor Details

GateProperties

public GateProperties(int dev)

Constructor. Sets ExclusiveUse to ExclusiveAllowed to match the Gate device model.

Parameters:

dev - Device index

Method Details

initOnOpen

public void initOnOpen()

Description copied from class: JposCommonProperties

Initialization of properties that must be initialized during open.

Overrides:

initOnOpen in class JposCommonProperties

openGate

public void openGate()
              throws jpos.JposException

Description copied from interface: GateInterface

Final part of OpenGate 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,
• Device has not been claimed by other instance.

Specified by:

openGate in interface GateInterface

Throws:

jpos.JposException - If an error occurs.

waitForGateClose

public void waitForGateClose(int timeout)
                      throws jpos.JposException

Description copied from interface: GateInterface

Final part of WaitForGateClose 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,
• CapStatus is true,
• timeout is a positive value or FOREVER.

Specified by:

waitForGateClose in interface GateInterface

Parameters:

timeout - Number of milliseconds to wait before firing an exception with JPOS_E_TIMEOUT.

Throws:

jpos.JposException - If an error or a timeout occurs.