edu.nrao.sss.model.resource.vla
Class VlaSubband

java.lang.Object
  extended by edu.nrao.sss.model.resource.CorrelatorSubbandAbs
      extended by edu.nrao.sss.model.resource.vla.VlaSubband
All Implemented Interfaces:
CorrelatorSubband, HasBandwidth, Identifiable, Cloneable

public class VlaSubband
extends CorrelatorSubbandAbs

A subband of a VLA correlator baseband.

2008-Mar-11, PM: B.Butler and M.Rupen suggested that the SSS programming staff not spend a lot of time trying to put the WIDAR and VLA correlators under the same blanket. They suggested that, instead, we write special code for the short amount of time that we'll be dealing with the VLA. Therefore, this class may not see much use, if any, and has not been given the proper amount of QA attention.

Version Info:

$Revision: 2287 $
$Date: 2009-05-07 13:54:58 -0600 (Thu, 07 May 2009) $
$Author: dharland $ (last person to modify)

Since:
2008-03-11
Author:
David M. Harland

Field Summary
 
Fields inherited from class edu.nrao.sss.model.resource.CorrelatorSubbandAbs
freqRange, name, productGroups, requantizationBits
 
Fields inherited from interface edu.nrao.sss.util.Identifiable
UNIDENTIFIED
 
Constructor Summary
VlaSubband()
           
 
Method Summary
 SortedSet<Frequency> getAllowableBandwidths()
          Returns the set of bandwidths to which this object may be set.
 SortedSet<Integer> getAllowableRequantizations()
          Always returns an empty set.
 Frequency getMaximumBandwidth()
          Returns the largest bandwidth to which this object may be set.
 Frequency getMinimumBandwidth()
          Returns the smallest bandwidth to which this object may be set.
 boolean hasDiscreteBandwidths()
          Returns true if this object may be set only to pretermined bandwidths.
protected  edu.nrao.sss.model.resource.vla.VlaCorrProdGrp makeCorrelationProductGroup()
          Always returns null.
 void setRequantization(int bits)
          Does nothing.
 
Methods inherited from class edu.nrao.sss.model.resource.CorrelatorSubbandAbs
addNewCorrelationProductGroup, clearId, clone, createdProdGrpsFromPersistentStore, equals, getAllowableBandwidthClosestTo, getAllowableBandwidthFor, getBandwidth, getBaseband, getCentralFrequency, getContainer, getCorrelationProductGroups, getFrequencyRange, getId, getMaximumCentralFrequency, getMinimumCentralFrequency, getName, getProxiedRange, getRequantization, hashCode, removeCorrelationProductGroup, setBandwidth, setCentralFrequency, setCentralProxiedFrequency, setContainer, setName
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

VlaSubband

public VlaSubband()
Method Detail

getMinimumBandwidth

public Frequency getMinimumBandwidth()
Description copied from interface: HasBandwidth
Returns the smallest bandwidth to which this object may be set.

Returns:
the smallest bandwidth to which this object may be set.

getMaximumBandwidth

public Frequency getMaximumBandwidth()
Description copied from interface: HasBandwidth
Returns the largest bandwidth to which this object may be set.

Returns:
the largest bandwidth to which this object may be set.

hasDiscreteBandwidths

public boolean hasDiscreteBandwidths()
Description copied from interface: HasBandwidth
Returns true if this object may be set only to pretermined bandwidths. A return value of false indicates that this object may be set to any bandwidth in the range allowed by HasBandwidth.getMinimumBandwidth() and HasBandwidth.getMaximumBandwidth().

If the returned value is true, the method HasBandwidth.getAllowableBandwidths() will give the set of predetermined bandwidths.

Returns:
true if this object may be set only to pretermined bandwidths.

getAllowableBandwidths

public SortedSet<Frequency> getAllowableBandwidths()
Description copied from interface: HasBandwidth
Returns the set of bandwidths to which this object may be set.

If the return value of HasBandwidth.hasDiscreteBandwidths() is false all frequencies in the range allowed by HasBandwidth.getMinimumBandwidth() and HasBandwidth.getMaximumBandwidth() are valid and this method will return an empty set. Otherwise it will return the set of allowable bandwidths.

Returns:
the set of bandwidths to which this object may be set.

getAllowableRequantizations

public SortedSet<Integer> getAllowableRequantizations()
Always returns an empty set.

Returns:
the set of allowable requantization values for this subband.

setRequantization

public void setRequantization(int bits)
Does nothing.

Parameters:
bits - the number of bits to which data should be requantized.

makeCorrelationProductGroup

protected edu.nrao.sss.model.resource.vla.VlaCorrProdGrp makeCorrelationProductGroup()
Always returns null.

Specified by:
makeCorrelationProductGroup in class CorrelatorSubbandAbs


Copyright © 2009. All Rights Reserved.