edu.nrao.sss.model.resource
Interface CorrelationProductGroup

All Superinterfaces:

Identifiable

All Known Implementing Classes:

CorrelationProductGroupAbs, WidarCorrelationProductGroup

public interface CorrelationProductGroup
extends Identifiable

A grouping of correlation products that share certain properties.

Version Info:

$Revision: 2200 $

$Date: 2009-04-15 16:00:47 -0600 (Wed, 15 Apr 2009) $

$Author: dharland $ (last person to modify)

Since:

2008-11-21

Author:

David M. Harland

Field Summary

Fields inherited from interface edu.nrao.sss.util.Identifiable

UNIDENTIFIED

Method Summary

boolean	addPolarizationProduct(StokesParameter stokes) Attempts to add the given product to this group.
void	clearId() Resets this instance's ID, and the IDs of all its components, to a value that represents the unidentified state.
SortedSet<StokesParameter>	getAllowablePolarizationProducts() Returns a set of the polarization products that may be obtained from this group.
TimeDuration	getMinimumTotalIntegrationTime() Returns the minimum total integration time for this product.
int	getSpectralChannels() Returns the total number of spectral channels, summed over all correlation products, for this group.
int	getSpectralChannels(StokesParameter stokes) Returns the number of spectral channels of this group that are allocated to the given product.
TimeDuration	getTotalIntegrationTime() Returns the total integration time for this product.
String	getUUID() Returns an ID that attempts to be universally unique.
void	removeAllPolarizationProducts() Removes all polarization products from this group.
int	removePolarizationProduct(StokesParameter stokes) Removes the given product from this group, if present.
void	setTotalIntegrationTime(TimeDuration totalDuration) Sets the total integration time for this product.

Methods inherited from interface edu.nrao.sss.util.Identifiable

getId

Method Detail

clearId

void clearId()

Resets this instance's ID, and the IDs of all its components, to a value that represents the unidentified state.

This method is useful for preparing an instance for storage in a database. The ID property (as of now, though this may change in the future) is used by our persistence mechanism to identify objects. If you are persisting this instance for the first time, you may need to call this method before performing a save. This is especially true if you have created this instance from XML, as the XML unmarshalling brings along the ID property.

getUUID

String getUUID()

Returns an ID that attempts to be universally unique. This ID will be unique for a given group within its containing subband.

Returns:

an ID that attempts to be universally unique.

getAllowablePolarizationProducts

SortedSet<StokesParameter> getAllowablePolarizationProducts()

Returns a set of the polarization products that may be obtained from this group.

Returns:

a set of the polarization products that may be obtained from this group.

addPolarizationProduct

boolean addPolarizationProduct(StokesParameter stokes)

Attempts to add the given product to this group. The product will be added only if it is an allowable product. This method returns true if it already contained stokes or if this method successfully added it.

Parameters:

stokes - the product to be added to this group.

Returns:

true if this group contains stokes after a call to this method.

removePolarizationProduct

int removePolarizationProduct(StokesParameter stokes)

Removes the given product from this group, if present.

Parameters:

stokes - the product to be removed to this group.

Returns:

the number of channels that had been allocated to the given product.

removeAllPolarizationProducts

void removeAllPolarizationProducts()

Removes all polarization products from this group.

getSpectralChannels

int getSpectralChannels()

Returns the total number of spectral channels, summed over all correlation products, for this group.

Returns:

the total number of spectral channels for this group.

getSpectralChannels

int getSpectralChannels(StokesParameter stokes)

Returns the number of spectral channels of this group that are allocated to the given product.

Parameters:

stokes - the product for which a number of channels is requested.

Returns:

the number of channels in this group for stokes.

setTotalIntegrationTime

void setTotalIntegrationTime(TimeDuration totalDuration)

Sets the total integration time for this product. Concrete implementations of this interface may break this duration into several component times.

Parameters:

totalDuration - the total integration duration for this product.

getTotalIntegrationTime

TimeDuration getTotalIntegrationTime()

Returns the total integration time for this product.

Returns:

the total integration time for this product.

getMinimumTotalIntegrationTime

TimeDuration getMinimumTotalIntegrationTime()

Returns the minimum total integration time for this product.

Returns:

the minimum total integration time for this product.