jdk.dio.adc

Class MonitoringEvent

java.lang.Object

jdk.dio.DeviceEvent<ADCChannel>

jdk.dio.adc.MonitoringEvent

public class MonitoringEvent
extends DeviceEvent<ADCChannel>

The MonitoringEvent class encapsulates ADC channel under- and over-threshold value conditions.
When/if range events for the same ADC channel are coalesced the value and the type (in or out of range) retained are that of the last occurrence.

See Also:

ADCChannel, MonitoringListener

Field Summary

Fields

Modifier and Type	Field and Description
static int	BACK_TO_RANGE Indicates that the ADC channel value got back within the defined range.
static int	OUT_OF_RANGE Indicates that the ADC channel value exceeded the defined range.

Fields inherited from class jdk.dio.DeviceEvent

count, device, lastTimeStamp, lastTimeStampMicros, timeStamp, timeStampMicros

Constructor Summary

Constructors

Constructor and Description
MonitoringEvent(ADCChannel channel, int type, int value) Creates a new MonitoringEvent with the specified raw sampled value and time-stamped with the current time..
MonitoringEvent(ADCChannel channel, int type, int value, long timeStamp, int timeStampMicros) Creates a new MonitoringEvent with the specified raw sampled value and timestamp.

Method Summary

Methods

Modifier and Type	Method and Description
int	getType() Returns the type of range condition being notified.
int	getValue() Returns the new ADC channel's value.

Methods inherited from class jdk.dio.DeviceEvent

getCount, getDevice, getLastTimeStamp, getLastTimeStampMicros, getTimeStamp, getTimeStampMicros

Methods inherited from class java.lang.Object

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

Field Detail

BACK_TO_RANGE

public static final int BACK_TO_RANGE

Indicates that the ADC channel value got back within the defined range.

See Also:

Constant Field Values

OUT_OF_RANGE

public static final int OUT_OF_RANGE

Indicates that the ADC channel value exceeded the defined range.

See Also:

Constant Field Values

Constructor Detail

MonitoringEvent

public MonitoringEvent(ADCChannel channel,
               int type,
               int value)

Creates a new MonitoringEvent with the specified raw sampled value and time-stamped with the current time..

Parameters:

channel - the source ADC channel.

type - the type of range condition being notified: OUT_OF_RANGE or BACK_TO_RANGE.

value - the raw sampled value.

Throws:

java.lang.NullPointerException - if channel is null.

java.lang.IllegalArgumentException - if type is not one of the defined types.

MonitoringEvent

public MonitoringEvent(ADCChannel channel,
               int type,
               int value,
               long timeStamp,
               int timeStampMicros)

Creates a new MonitoringEvent with the specified raw sampled value and timestamp.

Parameters:

channel - the source ADC channel.

type - the type of range condition being notified: OUT_OF_RANGE or BACK_TO_RANGE.

value - the raw sampled value.

timeStamp - the timestamp (in milliseconds).

timeStampMicros - the additional microseconds to the timestamp.

Throws:

java.lang.NullPointerException - if channel is null.

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

Method Detail

getType

public int getType()

Returns the type of range condition being notified.

Returns:

the type of range condition being notified: OUT_OF_RANGE or BACK_TO_RANGE.

getValue

public int getValue()

Returns the new ADC channel's value.

Returns:

the new ADC channel's value.