triana.types.clipins

Class GEODataClipIn

java.lang.Object

triana.types.clipins.GEODataClipIn

All Implemented Interfaces:

java.io.Serializable, ClipIn

public class GEODataClipIn
extends java.lang.Object
implements ClipIn

GEODataClipIn is an Object containing information about data derived from the GEO or other gravitational wave detector. The data fields are: detector name, channel name, GPS time of first data element, UTC calendar date String of the time of the first data element, orginal precision of data (in bits), whether the data has been calibrated or de-whitened, and a quality indicator for the data. These data supplement the data that are held in data sets that this ClipIn may be attached to.

There are methods for setting and getting the two data. The dates are inter-convertible, and when one is changed by a set method then the other is automatically updated.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GEODataClipIn() Constructs an empty GEODataClipIn.
GEODataClipIn(java.lang.String det, java.lang.String name, int prec, boolean cal, boolean dewhite, int yr, int mo, int da, int hr, int min, int sec) Constructs a GEODataClipIn using the desired input data, with the time given by calendar arguments.
GEODataClipIn(java.lang.String det, java.lang.String name, int prec, boolean cal, boolean dewhite, long gpsMs) Constructs a GEODataClipIn using the desired input data, with the time given in GPS milliseconds.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	clone() Clones the ClipIn to an identical one.
void	finalizeAttach(AttachInfo info) This method is called when the clip-in is removed from a task's clip-in bucket.
boolean	getCalibrated() Returns the calibration state of the data
java.lang.String	getChannel() Returns the channel name.
java.lang.String	getDetector() Returns the detector name.
boolean	getDewhitened() Returns the dewhitening state of the data
java.lang.String	getGPSDateString() Returns the GPS time of the first sample of the data by giving calendar information
long	getGPSMs() Returns the GPS time in milliseconds of the first sample of the data
int	getPrecision() Returns the precision of the acquired data, in bits.
void	initializeAttach(AttachInfo info) This method is called before the clip-in enters a task's clip-in bucket.
void	setCalibrated(boolean cal) Sets the calibration state of the data
void	setChannel(java.lang.String chan) Sets the channel name.
void	setDetector(java.lang.String name) Sets the detector name.
void	setDewhitened(boolean dewhite) Sets the dewhitening state of the data
void	setGPS(int yr, int mo, int da, int hr, int min, int sec) Sets the GPS time of the first sample of the data by giving calendar information
void	setGPS(long gps) Sets the GPS time in milliseconds of the first sample of the data
void	setPrecision(int bits) Sets the precision of the acquired data, in bits.

Methods inherited from class java.lang.Object

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

Constructor Detail

GEODataClipIn

public GEODataClipIn()

Constructs an empty GEODataClipIn.

GEODataClipIn

public GEODataClipIn(java.lang.String det,
             java.lang.String name,
             int prec,
             boolean cal,
             boolean dewhite,
             long gpsMs)

Constructs a GEODataClipIn using the desired input data, with the time given in GPS milliseconds.

GEODataClipIn

public GEODataClipIn(java.lang.String det,
             java.lang.String name,
             int prec,
             boolean cal,
             boolean dewhite,
             int yr,
             int mo,
             int da,
             int hr,
             int min,
             int sec)

Constructs a GEODataClipIn using the desired input data, with the time given by calendar arguments.

Method Detail

initializeAttach

public void initializeAttach(AttachInfo info)

This method is called before the clip-in enters a task's clip-in bucket. This occurs when either the data it is attached to is input by the task, or when the unit directly adds the clip-in to its bucket.

Specified by:

initializeAttach in interface ClipIn

Parameters:

info - info about the task the clip-in is being attached to

finalizeAttach

public void finalizeAttach(AttachInfo info)

This method is called when the clip-in is removed from a task's clip-in bucket. This occurs when either the data it is attached to is output by the task, or when the unit directly remove the clip-in from its bucket.

Specified by:

finalizeAttach in interface ClipIn

Parameters:

info - info about the task the clip-in is being removed from

clone

public java.lang.Object clone()

Clones the ClipIn to an identical one. This is a copy by value, not by reference. This method must be implemented for each class in a way that depends on the contents of the ClipIn.

Specified by:

clone in interface ClipIn

Overrides:

clone in class java.lang.Object

Returns:

a copy by value of the current ClipIn

setDetector

public void setDetector(java.lang.String name)

Sets the detector name.

Parameters:

name - The new detector name

setChannel

public void setChannel(java.lang.String chan)

Sets the channel name.

Parameters:

chan - The new channel name

setPrecision

public void setPrecision(int bits)

Sets the precision of the acquired data, in bits.

Parameters:

bits - The new precision

setCalibrated

public void setCalibrated(boolean cal)

Sets the calibration state of the data

Parameters:

cal - The new calibration state

setDewhitened

public void setDewhitened(boolean dewhite)

Sets the dewhitening state of the data

Parameters:

dewhite - The new whitening state

setGPS

public void setGPS(long gps)

Sets the GPS time in milliseconds of the first sample of the data

Parameters:

gps - The new first sample time in milliseconds

setGPS

public void setGPS(int yr,
          int mo,
          int da,
          int hr,
          int min,
          int sec)

Sets the GPS time of the first sample of the data by giving calendar information

Parameters:

yr - The year of the first sample (4 digits)

mo - The month of the first sample (January = 0)

da - The day of the month of the first sample (starting at 1)

hr - The hour of the day of the first sample

min - The minute of the hour of the first sample

sec - The second of the minute of the first sample

getDetector

public java.lang.String getDetector()

Returns the detector name.

Returns:

String The detector name

getChannel

public java.lang.String getChannel()

Returns the channel name.

Returns:

String The channel name

getPrecision

public int getPrecision()

Returns the precision of the acquired data, in bits.

Returns:

int The precision

getCalibrated

public boolean getCalibrated()

Returns the calibration state of the data

Returns:

boolean The calibration state: true if calibrated

getDewhitened

public boolean getDewhitened()

Returns the dewhitening state of the data

Returns:

boolean The dewhitening state: true if de-whitened

getGPSMs

public long getGPSMs()

Returns the GPS time in milliseconds of the first sample of the data

Returns:

long The first sample time in milliseconds

getGPSDateString

public java.lang.String getGPSDateString()

Returns the GPS time of the first sample of the data by giving calendar information

Returns:

String The time of the first sample of the data as a UTC calendar date String