edu.nrao.sss.model.resource
Class ReceiverSelection

java.lang.Object
  edu.nrao.sss.model.resource.ReceiverSelection

public class ReceiverSelection
extends Object

A selection of receivers, typically created by a ReceiverSelector. Instances of this class are immutable.

Version Info:

$Revision: 1096 $

$Date: 2008-02-12 11:01:13 -0700 (Tue, 12 Feb 2008) $

$Author: dharland $

Since:

2007-01-11

Author:

David M. Harland

Method Summary

double	getFractionalBandwidthCoverage() Returns the fraction of the bandwidth requested in the original specifications that can be satisfied by the selected receivers.
ResourceSpecification	getModifiedSpecifications() Returns the resource specifications that represent the intersection between the original specifications and the bandwidth covered by the selected receivers.
ResourceSpecification	getOriginalSpecifications() Returns the resource specifications that were used to create this selection.
List<ReceiverBand>	getReceivers() Returns the selected receivers.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getReceivers

public List<ReceiverBand> getReceivers()

Returns the selected receivers. The returned list is a copy, but the references to the receivers in the returned list are the same as those held by this object's list.

Returns:

the selected receivers.

getOriginalSpecifications

public ResourceSpecification getOriginalSpecifications()

Returns the resource specifications that were used to create this selection.

Note that the returned specification is a copy of that held by this receiver selection. That means that any changes made to the returned specification will not be reflected in this object.

Returns:

the specifications that were used to create this selection.

getModifiedSpecifications

public ResourceSpecification getModifiedSpecifications()

Returns the resource specifications that represent the intersection between the original specifications and the bandwidth covered by the selected receivers.

Note that the returned specification is a copy of that held by this receiver selection. That means that any changes made to the returned specification will not be reflected in this object.

Returns:

a modification to the original resource specifications that reflects the capabilities of the selected receivers.

getFractionalBandwidthCoverage

public double getFractionalBandwidthCoverage()

Returns the fraction of the bandwidth requested in the original specifications that can be satisfied by the selected receivers. The value will returned will be between zero and one, inclusive.

Returns:

the fraction of the requested bandwidth covered by the selected receivers.