Package csw.params.core.models

Class ExposureIdWithObsId

java.lang.Object

csw.params.core.models.ExposureIdWithObsId

All Implemented Interfaces:

ExposureId, java.io.Serializable, scala.Equals, scala.Product

public class ExposureIdWithObsId
extends java.lang.Object
implements ExposureId, scala.Product, java.io.Serializable

An ExposureIdWithObsId is an ExposureId with an included ObsId. Instances are created through the ExposureId object.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ExposureIdWithObsId(scala.Option<ObsId> obsId, Subsystem subsystem, java.lang.String det, TYPLevel typLevel, ExposureNumber exposureNumber)

Method Summary

Modifier and Type	Method	Description
java.lang.String	det()	The detector name associated with the exposure.
ExposureNumber	exposureNumber()	The number of the exposure in a series.
scala.Option<ObsId>	obsId()	The Observation Id for the exposure.
Subsystem	subsystem()	The Subsystem that produced the exposure.
java.lang.String	toString()
TYPLevel	typLevel()	The exposure type and calibration level

Methods inherited from class java.lang.Object

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

Methods inherited from interface scala.Equals

canEqual, equals

Methods inherited from interface scala.Product

productArity, productElement, productElementName, productElementNames, productIterator, productPrefix

Constructor Detail

ExposureIdWithObsId

public ExposureIdWithObsId(scala.Option<ObsId> obsId,
                           Subsystem subsystem,
                           java.lang.String det,
                           TYPLevel typLevel,
                           ExposureNumber exposureNumber)

Method Detail

obsId

public scala.Option<ObsId> obsId()

Description copied from interface: ExposureId

The Observation Id for the exposure.

Specified by:

obsId in interface ExposureId

Returns:

an ObsId as an option

subsystem

public Subsystem subsystem()

Description copied from interface: ExposureId

The Subsystem that produced the exposure.

Specified by:

subsystem in interface ExposureId

Returns:

a valid Subsystem

det

public java.lang.String det()

Description copied from interface: ExposureId

The detector name associated with the exposure.

Specified by:

det in interface ExposureId

Returns:

detector description as a String

typLevel

public TYPLevel typLevel()

Description copied from interface: ExposureId

The exposure type and calibration level

Specified by:

typLevel in interface ExposureId

Returns:

a TYPLevel

exposureNumber

public ExposureNumber exposureNumber()

Description copied from interface: ExposureId

The number of the exposure in a series.

Specified by:

exposureNumber in interface ExposureId

Returns:

the number as an ExposureNumber

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object