com.oracle.deviceaccess.dac

Class GenerationEvent

java.lang.Object

com.oracle.deviceaccess.PeripheralEvent

com.oracle.deviceaccess.dac.GenerationEvent

public class GenerationEvent
extends PeripheralEvent

The GenerationEvent class encapsulates DAC channel analog output generation completion conditions. A GenerationEvent may indicate that:

• all the values to output have been converted and the designated buffer section is available for more values to output
• or, in case of double buffering, half of the values to output have been converted and the designated buffer section is available for more values to output.

When handling a GenerationEvent, the application may copy more output values to be converted in the buffer section designated by getValues(), getOffset() and getNumber(). The application must set the actual number of output values copied by calling setActualNumber(int). If the actual number is set to a value smaller than the length of the designated buffer section (as given by getNumber()) the current asynchronous analog output generation will stop after these last provided output values have been converted as if from a call to DACChannel.stopGeneration().

This kind of events is never coalesced.

See Also:

DACChannel.startGeneration(int[], int, int, boolean, com.oracle.deviceaccess.dac.GenerationListener), GenerationListener

Field Summary

Fields inherited from class com.oracle.deviceaccess.PeripheralEvent

count, lastTimeStamp, lastTimeStampMicros, peripheral, timeStamp, timeStampMicros

Constructor Summary

Constructors

Constructor and Description
GenerationEvent(DACChannel channel, int[] values, int offset, int number) Creates a new GenerationEvent with the specified raw output value buffer and time-stamped with the current time.
GenerationEvent(DACChannel channel, int[] values, int offset, int number, long timeStamp, int timeStampMicros) Creates a new GenerationEvent with the specified raw output value buffer and timestamp.

Method Summary

Methods

Modifier and Type	Method and Description
int	getActualNumber() Returns the actual number of values to output that were copied to the values buffer.
int	getNumber() Returns the maximum number of values to output that can be copied to the values buffer.
int	getOffset() Returns the offset in the values buffer where to start copying the values to output.
int[]	getValues() Returns the buffer where the values to output must be copied.
void	setActualNumber(int actualNumber) Sets the actual number of values to output that were copied to the values buffer.

Methods inherited from class com.oracle.deviceaccess.PeripheralEvent

getCount, getLastTimeStamp, getLastTimeStampMicros, getPeripheral, getTimeStamp, getTimeStampMicros

Methods inherited from class java.lang.Object

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

Constructor Detail

GenerationEvent

public GenerationEvent(DACChannel channel,
               int[] values,
               int offset,
               int number)

Creates a new GenerationEvent with the specified raw output value buffer and time-stamped with the current time.

Parameters:

channel - the source DAC channel.

values - the buffer where the values to output must be copied.

offset - the offset in the values buffer where to start copying the values to output.

number - the maximum number of values to output that can be copied to the values buffer.

Throws:

java.lang.NullPointerException - if channel or values is null.

java.lang.IndexOutOfBoundsException - if offset and/or number would result in pointing outside of values.

GenerationEvent

public GenerationEvent(DACChannel channel,
               int[] values,
               int offset,
               int number,
               long timeStamp,
               int timeStampMicros)

Creates a new GenerationEvent with the specified raw output value buffer and timestamp.

Parameters:

channel - the source DAC channel.

values - the buffer where the values to output must be copied.

offset - the offset in the values buffer where to start copying the values to output.

number - the maximum number of values to output that can be copied to the values buffer.

timeStamp - the timestamp (in milliseconds).

timeStampMicros - the additional microseconds to the timestamp.

Throws:

java.lang.NullPointerException - if channel or values is null.

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

java.lang.IndexOutOfBoundsException - if offset and/or number would result in pointing outside of values.

Method Detail

getActualNumber

public int getActualNumber()

Returns the actual number of values to output that were copied to the values buffer.

Returns:

the actual number of values to output that were copied to the values buffer.

getNumber

public int getNumber()

Returns the maximum number of values to output that can be copied to the values buffer.

Returns:

the maximum number of values to output that can be copied to the values buffer.

getOffset

public int getOffset()

Returns the offset in the values buffer where to start copying the values to output. This offset is within the range defined by the parameters passed to DACChannel.startGeneration(int[], int, int, boolean, com.oracle.deviceaccess.dac.GenerationListener).

Returns:

the offset in the values buffer where to start copying the values to output.

getValues

public int[] getValues()

Returns the buffer where the values to output must be copied. This buffer is the same buffer that was passed as parameter to DACChannel.startGeneration(int[], int, int, boolean, com.oracle.deviceaccess.dac.GenerationListener).

Returns:

the buffer where the values to output must be copied.

setActualNumber

public void setActualNumber(int actualNumber)

Sets the actual number of values to output that were copied to the values buffer. If the provided value is smaller than the length of the designated buffer section as given by getNumber() then the current asynchronous analog output generation will be stopped as if from a call to DACChannel.stopGeneration().

Parameters:

actualNumber - the actual number of values to output that were copied to the values buffer.

Throws:

java.lang.IndexOutOfBoundsException - if actualNumber is negative or is larger than the number returned by getNumber().