jAER project on SourceForge

net.sf.jaer.eventio
Interface InputDataFileInterface

All Known Subinterfaces:
AEFileInputStreamInterface
All Known Implementing Classes:
AEFileInputStream, AEViewer.AEPlayer, MotionInputStream, MotionViewer.Player

public interface InputDataFileInterface

A general interface for input data files of finite length that can be rewound, positioned, marked, etc. A data file has units of data, e.g. events for AE data, frames for frame-based data.

Author:
tobi

Method Summary
 float getFractionalPosition()
           
 void mark()
          mark the current position.
 int position()
          return position in events
 void position(int n)
          set position in units of the file, e.g.
 void rewind()
          rewind to the start, or to the marked position, if it has been set
 void setFractionalPosition(float frac)
          Sets fractional position in units of the file
 long size()
           
 void unmark()
          clear any marked position
 

Method Detail

getFractionalPosition

float getFractionalPosition()
Returns:
fractional position in total events

mark

void mark()
          throws java.io.IOException
mark the current position.

Throws:
java.io.IOException - if there is some error in reading the data

position

int position()
return position in events


position

void position(int n)
set position in units of the file, e.g. events or frames

Parameters:
n - the number to position to

rewind

void rewind()
            throws java.io.IOException
rewind to the start, or to the marked position, if it has been set

Throws:
java.io.IOException

setFractionalPosition

void setFractionalPosition(float frac)
Sets fractional position in units of the file

Parameters:
frac - 0-1 float range, 0 at start, 1 at end

size

long size()
Returns:
size in units of the file

unmark

void unmark()
clear any marked position


jAER project on SourceForge