com.integpg.system

Class Iolog

java.lang.Object

com.integpg.system.Iolog

public class Iolog
extends Object

Provides programmatic access to IO logging. Allows for historical processing of IO signal activity.

Field Summary

Fields

Modifier and Type	Field and Description
static int	EDGE_ANY EDGE_ANY A flag indicating that any change of state is of interest.
static int	EDGE_FALLING EDGE_FALLING A flag indicating that the falling edge (transition from ON to OFF) is of interest.
static int	EDGE_RISING EDGE_RISING A flag indicating that the rising edge (transition from OFF to ON) is of interest.

Constructor Summary

Constructors

Constructor and Description
Iolog() Creates an instance of the IOLOG.

Method Summary

Modifier and Type	Method and Description
protected void	finalize() Releases the log snapshot.
IoEvent	getInputEvent(long timestamp) Fetch the Input event associated with a specific timestamp.
IoEvent[]	getInputEvents() Obtain an array of all Input events.
IoEvent[]	getInputEvents(int limit) Obtain an array of recent Input events.
long[]	getInputPeriod(int chan) Obtain one or more input signal periods
long[]	getInputPeriod(int chan, int limit) Obtain one or more input signal periods
long[]	getInputTransitions(int chan) Returns array of Input transition timestamps for the specified channel.
long[]	getInputTransitions(int chan, int edge, int limit) Returns array of Input transition timestamps for the specified channel.
long[]	getInputWidth(int chan, boolean invert) Obtain one or more pulse widths.
long[]	getInputWidth(int chan, boolean invert, int limit) Obtain one or more pulse widths.
IoEvent	getOutputEvent(long timestamp) Fetch the Output event associated with a specific timestamp.
IoEvent[]	getOutputEvents() Obtain an array of all Output events.
IoEvent[]	getOutputEvents(int limit) Obtain an array of recent Output events.
long[]	getOutputTransitions(int chan) Returns array of Output transition timestamps for the specified channel.
long[]	getOutputTransitions(int chan, int edge, int limit) Returns array of Output transition timestamps for the specified channel.
long	gettime() Obtains the timestamp associated with the snapshot.
void	refresh() Updates the log snapshot.
void	refresh(long timestamp) Updates the log snapshot.

Methods inherited from class java.lang.Object

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

Field Detail

EDGE_FALLING

public static final int EDGE_FALLING

EDGE_FALLING A flag indicating that the falling edge (transition from ON to OFF) is of interest.

See Also:

Constant Field Values

EDGE_RISING

public static final int EDGE_RISING

EDGE_RISING A flag indicating that the rising edge (transition from OFF to ON) is of interest.

See Also:

Constant Field Values

EDGE_ANY

public static final int EDGE_ANY

EDGE_ANY A flag indicating that any change of state is of interest.

See Also:

Constant Field Values

Constructor Detail

Iolog

public Iolog()

Creates an instance of the IOLOG. This is initialized with a snapshot of both the Input and Output IO log. The Iolog object will represent the IO history as of instantiation.

Method Detail

refresh

public void refresh()

Updates the log snapshot. The Iolog object will now reflect the IO history as of this moment.

refresh

public void refresh(long timestamp)

Updates the log snapshot. The Iolog object will reflect only the events occurring since the provided timestamp. If the parameter is 0 then only new events that have occurred since the previous snapshot are captured.

Parameters:

timestamp - include events since this time (incremental if 0)

gettime

public long gettime()

Obtains the timestamp associated with the snapshot. This is the precise time of the snapshot in real time.

Returns:

long value representing the time of the snapshot

getInputEvents

public IoEvent[] getInputEvents()

Obtain an array of all Input events.

Returns:

array of IoEvent objects in order from the most recent

getInputEvents

public IoEvent[] getInputEvents(int limit)

Obtain an array of recent Input events.

Parameters:

limit - maximum number of events to return

Returns:

array of IoEvent objects in order from the most recent

getOutputEvents

public IoEvent[] getOutputEvents()

Obtain an array of all Output events.

Returns:

array of IoEvent objects in order from the most recent

getOutputEvents

public IoEvent[] getOutputEvents(int limit)

Obtain an array of recent Output events.

Parameters:

limit - maximum number of events to return

Returns:

array of IoEvent objects in order from the most recent

getInputTransitions

public long[] getInputTransitions(int chan)

Returns array of Input transition timestamps for the specified channel.

Parameters:

chan - selected channel (0-N)

Returns:

array of long timestamps in order from the most recent

getOutputTransitions

public long[] getOutputTransitions(int chan,
                                   int edge,
                                   int limit)

Returns array of Output transition timestamps for the specified channel.

Parameters:

chan - selected channel (0-N)

edge - filters by edge specified (EDGE_ALL, EDGE_RISING or EDGE_FALLING)

limit - maximum number of transitions to return

Returns:

array of long timestamps in order from the most recent

getOutputTransitions

public long[] getOutputTransitions(int chan)

Returns array of Output transition timestamps for the specified channel.

Parameters:

chan - selected channel (0-N)

Returns:

array of long timestamps in order from the most recent

getInputTransitions

public long[] getInputTransitions(int chan,
                                  int edge,
                                  int limit)

Returns array of Input transition timestamps for the specified channel.

Parameters:

chan - selected channel (0-N)

edge - selected transition type (EDGE_ANY, EDGE_RISING or EDGE_FALLING)

limit - maximum number of transitions to return

Returns:

array of long timestamps in order from the most recent

getInputEvent

public IoEvent getInputEvent(long timestamp)

Fetch the Input event associated with a specific timestamp.

Parameters:

timestamp - precise timestamp of an event

Returns:

IoEvent object if one exists, null otherwise

getOutputEvent

public IoEvent getOutputEvent(long timestamp)

Fetch the Output event associated with a specific timestamp.

Parameters:

timestamp - precise timestamp of an event

Returns:

IoEvent object if one exists, null otherwise

getInputPeriod

public long[] getInputPeriod(int chan)

Obtain one or more input signal periods

Parameters:

chan - specified input channel

Returns:

long[] containing periods in milliseconds in order from the most recent

getInputPeriod

public long[] getInputPeriod(int chan,
                             int limit)

Obtain one or more input signal periods

Parameters:

chan - specified input channel

limit - maximum number of periods to return

Returns:

long[] containing periods in milliseconds in order from the most recent

getInputWidth

public long[] getInputWidth(int chan,
                            boolean invert)

Obtain one or more pulse widths.

Parameters:

chan - selected channel

invert - TRUE returns width for LOW pulse

Returns:

long[] containing periods in milliseconds in order from the most recent

getInputWidth

public long[] getInputWidth(int chan,
                            boolean invert,
                            int limit)

Obtain one or more pulse widths.

Parameters:

chan - selected channel

invert - TRUE returns width for LOW pulse

limit - maximum number of widths to return

Returns:

long[] containing periods in milliseconds in order from the most recent

finalize

protected void finalize()
                 throws Throwable

Releases the log snapshot.

Overrides:

finalize in class Object

Throws:

Throwable - with any exception