jAER project on SourceForge

net.sf.jaer.aesequencer
Interface AESequencerInterface

All Superinterfaces:
HardwareInterface, USBInterface
All Known Subinterfaces:
AEMonitorSequencerInterface
All Known Implementing Classes:
CochleaAMS1bHardwareInterface, CypressFX2AEX, CypressFX2Mapper, CypressFX2MonitorSequencer, SiLabsC8051F320_USBIO_AeSequencer

public interface AESequencerInterface
extends USBInterface

Author:
raphael

Field Summary
 
Fields inherited from interface net.sf.jaer.hardwareinterface.usb.USBInterface
PID_THESYCON_END, PID_THESYCON_START, VID_THESYCON
 
Method Summary
 int getEstimatedOutEventRate()
          Returns estimate of present out event rate on this interface
 int getMaxCapacity()
          Returns max capacity of this interface in events/sec
 int getNumEventsSent()
           
 int getNumEventsToSend()
           
 int getTimestampTickUs()
           
 boolean isEventSequencingEnabled()
           
 boolean isLoopedSequencingEnabled()
           
 void offerPacketToSequencer(AEPacketRaw packet)
          Offers a packet to be sequenced to the sequencer.
 void resetTimestamps()
          resets the timestamps to start at zero
 void setLoopedSequencingEnabled(boolean set)
          enables continuous sequencing, if enabled the AEWriter rewinds if it reaches the end of the packet and restarts sending from the beginning.
 void startSequencing(AEPacketRaw eventsToSend)
          starts sequencing of events, starts AEWriter.
 void stopSequencing()
          stops sequencing of events from the driver
 
Methods inherited from interface net.sf.jaer.hardwareinterface.usb.USBInterface
getDID, getPID, getStringDescriptors, getVID, getVIDPID
 
Methods inherited from interface net.sf.jaer.hardwareinterface.HardwareInterface
close, getTypeName, isOpen, open
 

Method Detail

getNumEventsSent

int getNumEventsSent()

getNumEventsToSend

int getNumEventsToSend()

resetTimestamps

void resetTimestamps()
resets the timestamps to start at zero


isEventSequencingEnabled

boolean isEventSequencingEnabled()
Returns:
true if event sequencing is enabled

getMaxCapacity

int getMaxCapacity()
Returns max capacity of this interface in events/sec

Returns:
max capacity in events/sec

getEstimatedOutEventRate

int getEstimatedOutEventRate()
Returns estimate of present out event rate on this interface

Returns:
estimated event rate in events/sec

getTimestampTickUs

int getTimestampTickUs()
Returns:
timestamp tick in us for this interface

offerPacketToSequencer

void offerPacketToSequencer(AEPacketRaw packet)
Offers a packet to be sequenced to the sequencer. Calling this automatically should disable looping the sequenced data.

Parameters:
packet - the packet to add to the tail of the queue.

setLoopedSequencingEnabled

void setLoopedSequencingEnabled(boolean set)
enables continuous sequencing, if enabled the AEWriter rewinds if it reaches the end of the packet and restarts sending from the beginning. otherwise it just stops sequencing.

Parameters:
set - true to loop packet, false to sequence a single packet

isLoopedSequencingEnabled

boolean isLoopedSequencingEnabled()
Returns:
true if sequencing will loop back to start at end of data

startSequencing

void startSequencing(AEPacketRaw eventsToSend)
                     throws HardwareInterfaceException
starts sequencing of events, starts AEWriter.

Parameters:
eventsToSend - the events that should be sequenced, timestamps are realtive to last event, inter spike interval must not be bigger than 2^16-1
Throws:
HardwareInterfaceException

stopSequencing

void stopSequencing()
                    throws HardwareInterfaceException
stops sequencing of events from the driver

Throws:
HardwareInterfaceException

jAER project on SourceForge