Package com.digi.android.gpio

Class GPIOSample

java.lang.Object

com.digi.android.gpio.GPIOSample

public class GPIOSample
extends java.lang.Object

This class represents a received GPIO sample.

A GPIOSample contains the GPIO object that generates the sample, its value, and the time when it was taken in milliseconds.

Use the GPIO.registerListener(IGPIOListener) method to subscribe your listener and receive GPIO samples.

See Also:

GPIO, GPIOValue, IGPIOListener

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GPIOSample(GPIO gpio, GPIOValue value, long timestamp)	Creates a GPIO sample with the given GPIO, value and timestamp.

Method Summary

Modifier and Type	Method	Description
GPIO	getGPIO()	Gets the GPIO object where this sample was taken.
long	getTimestamp()	Gets the time when this sample was taken.
GPIOValue	getValue()	Gets the GPIO value of this sample.

Methods inherited from class java.lang.Object

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

Constructor Detail

GPIOSample

protected GPIOSample(GPIO gpio,
                     GPIOValue value,
                     long timestamp)

Creates a GPIO sample with the given GPIO, value and timestamp.

Parameters:

gpio - The GPIO object where the sample was taken.

value - The value of the sample.

timestamp - The time in milliseconds when the GPIO was sampled.

Throws:

java.lang.IllegalArgumentException - If timestamp < 0.

java.lang.NullPointerException - If gpio == null or if value == null.

See Also:

GPIO, GPIOValue.HIGH, GPIOValue.LOW

Method Detail

getGPIO

public GPIO getGPIO()

Gets the GPIO object where this sample was taken.

Returns:

The source GPIO object.

See Also:

GPIO

getValue

public GPIOValue getValue()

Gets the GPIO value of this sample.

Returns:

The GPIO value of this sample.

See Also:

GPIOValue

getTimestamp

public long getTimestamp()

Gets the time when this sample was taken.

Returns:

The time when the sample was taken in milliseconds.