edu.nrao.sss.electronics
Interface Digitizer

public interface Digitizer

A device that can be configured to produce digital samplings of different bit depths.

Developer's Note: This class was created after this package was completed and was shoehorned in without much thought. One could argue that a SignalSampler is a Digitizer and ought to implement this class. Fair enough. Let this note stand as a TODO marker for someone to come back and make this interface fit more naturally into this package.

Version Info:

$Revision: 1048 $

$Date: 2008-01-18 09:07:05 -0700 (Fri, 18 Jan 2008) $

$Author: dharland $ (last person to modify)

Since:

2008-01-17

Author:

David M. Harland

Method Summary

SortedSet<Integer>	getAllowableBitsPerSample() Returns the set of bit per sample values that this digitizer can produce.
int	getBitsPerSample() Returns the number of bits per sample this device is configured to produce.
String	getName() Returns the name of this digitizer.
void	setBitsPerSample(int numberOfBits) Configures this digitizer so that it produces output with the given number of bits per sample.

Method Detail

getName

String getName()

Returns the name of this digitizer.

Returns:

the name of this digitizer.

getBitsPerSample

int getBitsPerSample()

Returns the number of bits per sample this device is configured to produce.

Returns:

the number of bits per sample this device is configured to produce.

setBitsPerSample

void setBitsPerSample(int numberOfBits)

Configures this digitizer so that it produces output with the given number of bits per sample.

Most digitizers can handle only a few bit per sample values. The set of allowable values is given by getAllowableBitsPerSample(). Implementing classes are free to do one of two things with values that are not in that set:

1. Ignore the value and leave the state of this digitizer unchanged.
2. Use the closest legal value. (If two values are equally close, the implementing class may be biased toward one or the other at its discretion.)

Parameters:

numberOfBits - the type of output, expressed as bits per sample, that this digitizer should produce.

getAllowableBitsPerSample

SortedSet<Integer> getAllowableBitsPerSample()

Returns the set of bit per sample values that this digitizer can produce.

Returns:

the set of bit per sample values that this digitizer can produce.