edu.nrao.sss.model.resource
Interface HasBandwidth

All Known Subinterfaces:

CorrelatorBaseband, CorrelatorSubband

All Known Implementing Classes:

CorrelatorBasebandAbs, CorrelatorSubbandAbs, VlaBasebandPair, VlaSubband, WidarBaseband, WidarBasebandPair, WidarBasebandSinglet, WidarSubband

public interface HasBandwidth

An object that has frequency bandwidth.

Version Info:

$Revision: 1158 $

$Date: 2008-03-14 09:26:16 -0600 (Fri, 14 Mar 2008) $

$Author: dharland $ (last person to modify)

Since:

2008-03-13

Author:

David M. Harland

Method Summary

Frequency	getAllowableBandwidthClosestTo(Frequency desiredWidth) Returns the allowable frequency that is closest to the parameter.
Frequency	getAllowableBandwidthFor(Frequency desiredWidth) Returns the smallest allowable bandwidth that is greater than desiredWidth.
SortedSet<Frequency>	getAllowableBandwidths() Returns the set of bandwidths to which this object may be set.
Frequency	getBandwidth() Returns this object's bandwidth.
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.

Method Detail

getMinimumBandwidth

Frequency getMinimumBandwidth()

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

Returns:

the smallest bandwidth to which this object may be set.

getMaximumBandwidth

Frequency getMaximumBandwidth()

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

Returns:

the largest bandwidth to which this object may be set.

hasDiscreteBandwidths

boolean hasDiscreteBandwidths()

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 getMinimumBandwidth() and getMaximumBandwidth().

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

Returns:

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

getAllowableBandwidths

SortedSet<Frequency> getAllowableBandwidths()

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

If the return value of hasDiscreteBandwidths() is false all frequencies in the range allowed by getMinimumBandwidth() and 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.

getAllowableBandwidthFor

Frequency getAllowableBandwidthFor(Frequency desiredWidth)

Returns the smallest allowable bandwidth that is greater than desiredWidth. If no allowable bandwidth is greater than desiredWidth, the maximum allowable bandwidth is returned.

Parameters:

desiredWidth - a desired bandwidth for which an allowable bandwidth is sought.

Returns:

the smallest allowable bandwidth that is greater than desiredWidth.

getAllowableBandwidthClosestTo

Frequency getAllowableBandwidthClosestTo(Frequency desiredWidth)

Returns the allowable frequency that is closest to the parameter.

Parameters:

desiredWidth - a bandwidth for which the closest allowable bandwidth is desired. If this value is below the minimum, the minimum allowable value is returned. If it is above the maximum, the maximum is returned. If this value is null, the minimum value is returned.

Returns:

the allowable bandwidth of this baseband that is closest to desiredWidth.

getBandwidth

Frequency getBandwidth()

Returns this object's bandwidth.

Returns:

this object's bandwidth.