nl.lxtreme.ols.api.data
Class ChannelAnnotations

java.lang.Object
  extended by nl.lxtreme.ols.api.data.ChannelAnnotations

Deprecated.

@Deprecated
public class ChannelAnnotations
extends Object

Denotes a set of channel annotations for a single channel.


Constructor Summary
ChannelAnnotations(int aChannel)
          Deprecated. Creates a new ChannelAnnotations instance.
 
Method Summary
 void addAnnotation(long aStartTimestamp, long aEndTimestamp, Object aData)
          Deprecated. Adds a new annotation to this container.
 boolean equals(Object aObject)
          Deprecated.  
 ChannelAnnotation getAnnotation(int aTimeIndex)
          Deprecated. Returns the annotation at the given time index.
 Collection<ChannelAnnotation> getAnnotations()
          Deprecated.  
 Iterator<ChannelAnnotation> getAnnotations(int aStartIdx, int aEndIdx)
          Deprecated. Returns all annotations that are "visible" in the range of the given start and end index.
 int getChannel()
          Deprecated.  
 int hashCode()
          Deprecated.  
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ChannelAnnotations

public ChannelAnnotations(int aChannel)
Deprecated. 
Creates a new ChannelAnnotations instance.

Parameters:
aChannel - the index of the sample channel, >= 0 && < 32.
Method Detail

addAnnotation

public void addAnnotation(long aStartTimestamp,
                          long aEndTimestamp,
                          Object aData)
Deprecated. 
Adds a new annotation to this container.

Parameters:
aStartIdx - the start sample index of the annotation to add;
aEndIdx - the end sample index of the annotation to add;
aData - the actual annotation data of the annotation to add.

equals

public boolean equals(Object aObject)
Deprecated. 
Overrides:
equals in class Object
See Also:
Object.equals(java.lang.Object)

getAnnotation

public ChannelAnnotation getAnnotation(int aTimeIndex)
Deprecated. 
Returns the annotation at the given time index.

Parameters:
aTimeIndex - the index of the timestamps to return the annotation for, >= 0.
Returns:
a channel annotation valid at the given time index, or null if no such annotation was present.

getAnnotations

public Collection<ChannelAnnotation> getAnnotations()
Deprecated. 
Returns:
the annotations

getAnnotations

public Iterator<ChannelAnnotation> getAnnotations(int aStartIdx,
                                                  int aEndIdx)
Deprecated. 
Returns all annotations that are "visible" in the range of the given start and end index.

Parameters:
aStartIdx - the start index of the "visible" range, >= 0;
aEndIdx - the end index of the "visible" range, >= 0.
Returns:
an iterator of all "visible" channel annotations, never null.

getChannel

public int getChannel()
Deprecated. 
Returns:
the channel

hashCode

public int hashCode()
Deprecated. 
Overrides:
hashCode in class Object
See Also:
Object.hashCode()


Copyright © 2012 L'Xtreme IT consultancy. All Rights Reserved.