nl.lxtreme.ols.api.data
Interface Channel

All Superinterfaces:
Comparable<Channel>

public interface Channel
extends Comparable<Channel>

Denotes a single channel in the data set.


Method Summary
 void addAnnotation(Annotation<?> aAnnotation)
          Adds a new annotation to this channel.
 void clearAnnotations()
          Clears all annotations from this channel.
 Collection<Annotation<?>> getAnnotations()
          Returns all available annotations for this channel.
 int getIndex()
          Returns the index of this channel.
 String getLabel()
          Returns the (user defined) label for this channel.
 int getMask()
          Returns the bit-mask to use for this channel.
 boolean hasName()
          Returns whether or not this channel has a name.
 boolean isEnabled()
          Returns whether or not this channel is "enabled".
 void setEnabled(boolean aEnabled)
          Sets enabled to the given value.
 void setLabel(String aName)
          Sets name to the given value.
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Method Detail

addAnnotation

void addAnnotation(Annotation<?> aAnnotation)
Adds a new annotation to this channel.

Parameters:
aAnnotation - the annotation to add, cannot be null.

clearAnnotations

void clearAnnotations()
Clears all annotations from this channel.


getAnnotations

Collection<Annotation<?>> getAnnotations()
Returns all available annotations for this channel.

Returns:
an immutable collection of this channel's annotations, never null, never null.

getIndex

int getIndex()
Returns the index of this channel.

Returns:
a channel index, >= 0 && < .

getLabel

String getLabel()
Returns the (user defined) label for this channel. If no label is set for this channel, this method will return a default name.

Returns:
a label, can be null.

getMask

int getMask()
Returns the bit-mask to use for this channel.

Returns:
a bit-mask (= always a power of two), >= 1.

hasName

boolean hasName()
Returns whether or not this channel has a name.

Returns:
true if a name is given to this channel, false otherwise.

isEnabled

boolean isEnabled()
Returns whether or not this channel is "enabled".

When a channel is enabled, it is visible in the signal diagram. When disabled, it is masked out from the signal diagram.

Returns:
the enabled

setEnabled

void setEnabled(boolean aEnabled)
Sets enabled to the given value.

Parameters:
aEnabled - the enabled to set.

setLabel

void setLabel(String aName)
Sets name to the given value.

Parameters:
aName - the name to set.


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