com.oracle.deviceaccess.pwm

Class GenerationEvent

java.lang.Object

com.oracle.deviceaccess.PeripheralEvent<PWMChannel>

com.oracle.deviceaccess.pwm.GenerationEvent

public class GenerationEvent
extends PeripheralEvent<PWMChannel>

The GenerationEvent class encapsulates pulse a generation completion condition (i.e. generated pulse count value reached).
This kind of events is never coalesced.

See Also:

PWMChannel, GenerationListener

Field Summary

Fields inherited from class com.oracle.deviceaccess.PeripheralEvent

count, lastTimeStamp, lastTimeStampMicros, peripheral, timeStamp, timeStampMicros

Constructor Summary

Constructors

Constructor and Description
GenerationEvent(PWMChannel channel, int count) Creates a new GenerationEvent with the specified type, pulse count and time-stamped with the current time.
GenerationEvent(PWMChannel channel, int count, long timeStamp, int timeStampMicros) Creates a new GenerationEvent with the specified type, pulse count and timestamp.

Method Summary

Methods

Modifier and Type	Method and Description
int	getPulseCount() Returns the generated pulse count value.

Methods inherited from class com.oracle.deviceaccess.PeripheralEvent

getCount, getLastTimeStamp, getLastTimeStampMicros, getPeripheral, getTimeStamp, getTimeStampMicros

Methods inherited from class java.lang.Object

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

Constructor Detail

GenerationEvent

public GenerationEvent(PWMChannel channel,
               int count)

Creates a new GenerationEvent with the specified type, pulse count and time-stamped with the current time.

Parameters:

channel - the source PWM channel.

count - the generated pulse count.

Throws:

java.lang.NullPointerException - if channel is null.

java.lang.IllegalArgumentException - if count is negative.

GenerationEvent

public GenerationEvent(PWMChannel channel,
               int count,
               long timeStamp,
               int timeStampMicros)

Creates a new GenerationEvent with the specified type, pulse count and timestamp.

Parameters:

channel - the source pulse channel.

count - the generated pulse count.

timeStamp - the timestamp (in milliseconds).

timeStampMicros - the additional microseconds to the timestamp.

Throws:

java.lang.NullPointerException - if channel is null.

java.lang.IllegalArgumentException - if count, timeStamp or timeStampMicros is negative.

Method Detail

getPulseCount

public int getPulseCount()

Returns the generated pulse count value.

Returns:

the generated pulse count value.