jdk.dio.counter

Class CountingEvent

java.lang.Object

jdk.dio.DeviceEvent<PulseCounter>

jdk.dio.counter.CountingEvent

public class CountingEvent
extends DeviceEvent<PulseCounter>

The CountingEvent class encapsulates pulse counting conditions such as counter terminal value reached or counting session time interval expired.
When/if counting events for the same pulse counter are coalesced the count value and the type (terminal value reached or time interval expired) retained are that of the last occurrence.

Since:

1.0

See Also:

PulseCounter, CountingListener

Field Summary

Fields

Modifier and Type	Field and Description
static int	INTERVAL_EXPIRED Indicates that the pulse counting time interval has expired.
static int	TERMINAL_VALUE_REACHED Indicates that the pulse count value has reached the defined terminal value.

Fields inherited from class jdk.dio.DeviceEvent

count, device, lastTimeStamp, lastTimeStampMicros, timeStamp, timeStampMicros

Constructor Summary

Constructors

Constructor and Description
CountingEvent(PulseCounter counter, int type, int value, long interval) Creates a new CountingEvent with the specified type, pulse count value and actual counting time interval and time-stamped with the current time.
CountingEvent(PulseCounter counter, int type, int value, long interval, long timeStamp, int timeStampMicros) Creates a new CountingEvent with the specified type, pulse count value, actual counting time interval and timestamp.

Method Summary

Methods

Modifier and Type	Method and Description
long	getInterval() Returns the actual counting time interval (in microseconds).
int	getType() Returns the type of counting condition being notified.
int	getValue() Returns the pulse count value.

Methods inherited from class jdk.dio.DeviceEvent

getCount, getDevice, getLastTimeStamp, getLastTimeStampMicros, getTimeStamp, getTimeStampMicros

Methods inherited from class java.lang.Object

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

Field Detail

INTERVAL_EXPIRED

public static final int INTERVAL_EXPIRED

Indicates that the pulse counting time interval has expired.

See Also:

Constant Field Values

TERMINAL_VALUE_REACHED

public static final int TERMINAL_VALUE_REACHED

Indicates that the pulse count value has reached the defined terminal value.

See Also:

Constant Field Values

Constructor Detail

CountingEvent

public CountingEvent(PulseCounter counter,
             int type,
             int value,
             long interval)

Creates a new CountingEvent with the specified type, pulse count value and actual counting time interval and time-stamped with the current time.

Parameters:

counter - the source pulse counter.

type - the type of counting condition being notified: INTERVAL_EXPIRED or TERMINAL_VALUE_REACHED.

value - the pulse count value.

interval - the actual counting time interval (in microseconds).

Throws:

java.lang.NullPointerException - if counter is null.

java.lang.IllegalArgumentException - if type is not one of the defined types or if value or interval is negative.

CountingEvent

public CountingEvent(PulseCounter counter,
             int type,
             int value,
             long interval,
             long timeStamp,
             int timeStampMicros)

Creates a new CountingEvent with the specified type, pulse count value, actual counting time interval and timestamp.

Parameters:

counter - the source pulse counter.

type - the type of counting condition being notified: INTERVAL_EXPIRED or TERMINAL_VALUE_REACHED.

value - the pulse count value.

interval - the actual counting time interval (in microseconds).

timeStamp - the timestamp (in milliseconds).

timeStampMicros - the additional microseconds to the timestamp.

Throws:

java.lang.NullPointerException - if counter is null.

java.lang.IllegalArgumentException - if type is not one of the defined types or if value, interval or timeStamp is negative or timeStampMicros is not in the range [0 - 999].

Method Detail

getInterval

public long getInterval()

Returns the actual counting time interval (in microseconds). The actual counting time interval may be smaller than the defined counting time interval if the count terminal value has been reached.

Returns:

the actual counting time interval.

getType

public int getType()

Returns the type of counting condition being notified.

Returns:

the type of counting condition being notified: INTERVAL_EXPIRED or TERMINAL_VALUE_REACHED.

getValue

public int getValue()

Returns the pulse count value.

Returns:

the pulse count value.