edu.nrao.sss.model.resource.evla
Class WidarIntegrationTime

java.lang.Object
  edu.nrao.sss.model.resource.evla.WidarIntegrationTime

public class WidarIntegrationTime
extends Object

Components of integration time for WIDAR correlation products.

The VCI element to which this class is mapped is BlbProdIntegration.

Version Info:

$Revision: 2133 $

$Date: 2009-03-20 14:24:28 -0600 (Fri, 20 Mar 2009) $

$Author: dharland $ (last person to modify)

Since:

2008-11-26

Author:

David M. Harland

Method Summary

boolean	equals(Object o) Returns true if o is equal to this object.
int	getBackEndMultiplier() Returns the correlator back end multiplier component of this integration time.
int	getCorrelatorChipMultiplier() Returns the correlator chip multiplier component of this integration time.
TimeDuration	getLargestMinimumHardwareIntegrationTime() Returns the largest legal value for the concept called the minimum hardware integration time.
int	getLongTermAccumulatorMultiplier() Returns the long term accumulator multiplier component of this integration time.
TimeDuration	getMinimumHardwareIntegrationTime() Returns the minimum hardware integration time setting for this group of correlation products.
TimeDuration	getMinimumTotalIntegrationTime() Returns the smallest total integration time that may be used for the containing group of correlation products.
TimeDuration	getSmallestMinimumHardwareIntegrationTime() Returns the smallest legal value for the concept called the minimum hardware integration time.
TimeDuration	getTotalIntegrationTime() Returns the total integration time for the containing group of correlation products.
int	hashCode() Returns a hash code for this object.
void	setBackEndMultiplier(int newMult) Sets the correlator back end multiplier component of this integration time.
void	setCorrelatorChipMultiplier(int newMult) Sets the correlator chip multiplier component of this integration time.
void	setLongTermAccumulatorMultiplier(int newMult) Sets the long term accumulator multiplier component of this integration time.
void	setMinimumHardwareIntegrationTime(TimeDuration minHwTime) Sets the minimum hardware integration time for this group of correlation products.
BlbProdIntegration	toVci() Returns a Virtual Correlator Interface (VCI) representation of this object.

Methods inherited from class java.lang.Object

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

Method Detail

getSmallestMinimumHardwareIntegrationTime

public TimeDuration getSmallestMinimumHardwareIntegrationTime()

Returns the smallest legal value for the concept called the minimum hardware integration time.

Returns:

the smallest legal value for the minimum hardware integration time.

getLargestMinimumHardwareIntegrationTime

public TimeDuration getLargestMinimumHardwareIntegrationTime()

Returns the largest legal value for the concept called the minimum hardware integration time.

Returns:

the largest legal value for the minimum hardware integration time.

setMinimumHardwareIntegrationTime

public void setMinimumHardwareIntegrationTime(TimeDuration minHwTime)

Sets the minimum hardware integration time for this group of correlation products.

The minimum hardware integration time can take on only certain values. The maximum value is 400µs. The minimum value depends on the number of correlator chip cells per correlator chip that are being dumped, and also depends on the value of the LTA multiplier. Values in between these limits must be equal to N / 64MHz, where N is some integer.

Parameters:

minHwTime - the new minimum hardware integration time for this group of correlation products.

See Also:

getLargestMinimumHardwareIntegrationTime(), getSmallestMinimumHardwareIntegrationTime()

getMinimumHardwareIntegrationTime

public TimeDuration getMinimumHardwareIntegrationTime()

Returns the minimum hardware integration time setting for this group of correlation products. The returned value is a copy of the one held internally, so changes made to it will not be reflected in this object.

Returns:

the minimum hardware integration time setting for this group of correlation products.

setCorrelatorChipMultiplier

public void setCorrelatorChipMultiplier(int newMult)

Sets the correlator chip multiplier component of this integration time.

Parameters:

newMult - the new correlator chip multiplier value.

getCorrelatorChipMultiplier

public int getCorrelatorChipMultiplier()

Returns the correlator chip multiplier component of this integration time.

Returns:

the correlator chip multiplier component of this integration time.

See Also:

getTotalIntegrationTime()

setBackEndMultiplier

public void setBackEndMultiplier(int newMult)

Sets the correlator back end multiplier component of this integration time.

Parameters:

newMult - the new CBE multiplier value.

getBackEndMultiplier

public int getBackEndMultiplier()

Returns the correlator back end multiplier component of this integration time.

Returns:

the CBE multiplier component of this integration time.

See Also:

getTotalIntegrationTime()

setLongTermAccumulatorMultiplier

public void setLongTermAccumulatorMultiplier(int newMult)

Sets the long term accumulator multiplier component of this integration time.

Parameters:

newMult - the new LTA multiplier value.

getLongTermAccumulatorMultiplier

public int getLongTermAccumulatorMultiplier()

Returns the long term accumulator multiplier component of this integration time.

Returns:

the LTA multiplier component of this integration time.

See Also:

getTotalIntegrationTime()

getMinimumTotalIntegrationTime

public TimeDuration getMinimumTotalIntegrationTime()

Returns the smallest total integration time that may be used for the containing group of correlation products.

Returns:

smallest allowable total integration time.

getTotalIntegrationTime

public TimeDuration getTotalIntegrationTime()

Returns the total integration time for the containing group of correlation products.

The total integration time equals:

   getMinimumHardwareIntegrationTime() *
   getCorrelatorChipMultiplier() *
   getLongTermAccumulatorMultiplier() *
   getBackEndMultiplier()
 

The returned duration is not held internally by this object, so changes made to it will not be reflected herein.

Returns:

total integration time.

toVci

public BlbProdIntegration toVci()

Returns a Virtual Correlator Interface (VCI) representation of this object.

Returns:

a VCI object built from this one.

equals

public boolean equals(Object o)

Returns true if o is equal to this object.

Overrides:

equals in class Object

hashCode

public int hashCode()

Returns a hash code for this object.

Overrides:

hashCode in class Object