Factory for ExposureId instances and helper functions.
Attributes
- Companion
- trait
- Graph
-
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
ExposureId.type
Members list
Type members
Inherited and Abstract types
The names of the product elements
The names of the product elements
Attributes
- Inherited from:
- Mirror
The name of the type
The name of the type
Attributes
- Inherited from:
- Mirror
Value members
Concrete methods
Create an ExposureId from a String of the 4 forms with and without an ObsId and with and without a subarray: IRIS-IMG-SCI0-0001,IRIS-IMG-SCI0-0001-02 when no ObsId is present. Or 2020A-001-123-IRIS-IMG-SCI0-0001 or 2020A-001-123-IRIS-IMG-SCI0-0001-02 when an ObsId is present.
Create an ExposureId from a String of the 4 forms with and without an ObsId and with and without a subarray: IRIS-IMG-SCI0-0001,IRIS-IMG-SCI0-0001-02 when no ObsId is present. Or 2020A-001-123-IRIS-IMG-SCI0-0001 or 2020A-001-123-IRIS-IMG-SCI0-0001-02 when an ObsId is present.
Value parameters
- exposureId
-
proper ExposureId as a String
Attributes
- Returns
-
instance of ExposureId
- Throws
-
java.lang.IllegalArgumentException
if the String does not follow the correct structure
This creates a stand-alone ExposureId for the case when there is no csw.params.core.models.ObsId available.
This creates a stand-alone ExposureId for the case when there is no csw.params.core.models.ObsId available.
Value parameters
- det
-
a valid detector String
- exposureNumber
-
the exposure's Exposure Number csw.params.core.models.ExposureNumber
- subsystem
-
csw.prefix.models.Subsystem associated with exposure
- typLevel
-
the exposure's csw.params.core.models.TYPLevel
Attributes
- Returns
-
A stand-alone ExposureId
This creates an ExposureId with an ObsId.
This creates an ExposureId with an ObsId.
Value parameters
- det
-
a valid detector String
- exposureNumber
-
the exposure's Exposure Number csw.params.core.models.ExposureNumber
- obsId
-
a valid csw.params.core.models.ObsId
- subsystem
-
csw.prefix.models.Subsystem associated with exposure
- typLevel
-
the exposure's csw.params.core.models.TYPLevel
Attributes
- Returns
-
A standalone ExposureId
A helper function that allows creating exposure id from string in java file.
A helper function that allows creating exposure id from string in java file.
Value parameters
- exposureId
-
proper ExposureId as a String
Attributes
- Returns
-
instance of ExposureId
A convenience function to create a new ExposureId with the next higher exposure number. Example: 2020A-001-123-WFOS-IMG1-SCI0-0001 => 2020A-001-123-WFOS-IMG1-SCI0-0002
A convenience function to create a new ExposureId with the next higher exposure number. Example: 2020A-001-123-WFOS-IMG1-SCI0-0001 => 2020A-001-123-WFOS-IMG1-SCI0-0002
Value parameters
- exposureId
-
current ExposureId
Attributes
- Returns
-
ExposureId with next higher exposure number
A convenience function to create a new ExposureId with the next higher sub array number. Example: 2020A-001-123-WFOS-IMG1-SCI0-0001 => 2020A-001-123-WFOS-IMG1-SCI0-0002-00. Example: 2020A-001-123-WFOS-IMG1-SCI0-0002-00 => 2020A-001-123-WFOS-IMG1-SCI0-0002-01.
A convenience function to create a new ExposureId with the next higher sub array number. Example: 2020A-001-123-WFOS-IMG1-SCI0-0001 => 2020A-001-123-WFOS-IMG1-SCI0-0002-00. Example: 2020A-001-123-WFOS-IMG1-SCI0-0002-00 => 2020A-001-123-WFOS-IMG1-SCI0-0002-01.
Value parameters
- exposureId
-
current ExposureId
Attributes
- Returns
-
ExposureId with next higher ExposureNumber
The UTC time formatted as needed for a standalone ExposureId: YYYYMMDD-HHMMSS.
The UTC time formatted as needed for a standalone ExposureId: YYYYMMDD-HHMMSS.
Attributes
- Returns
-
the UTCTime formatted String
A convenience function to create a new ExposureId with a specific exposure number. Example: 2020A-001-123-WFOS-IMG1-SCI0-0001 with 3 => 2020A-001-123-WFOS-IMG1-SCI0-0003
A convenience function to create a new ExposureId with a specific exposure number. Example: 2020A-001-123-WFOS-IMG1-SCI0-0001 with 3 => 2020A-001-123-WFOS-IMG1-SCI0-0003
Value parameters
- exposureId
-
current ExposureId
- exposureNumber
-
desired exposure number
Attributes
- Returns
-
ExposureId with specified exposure number
A convenience function to create a new ExposureId with a new ObsId object. Example: 2020A-001-123-WFOS-IMG1-SCI0-0001 => 2020A-001-228-WFOS-IMG1-SCI0-0001. Note that a standalone ExposureId will be changed to an ExposureId with an ObsId
A convenience function to create a new ExposureId with a new ObsId object. Example: 2020A-001-123-WFOS-IMG1-SCI0-0001 => 2020A-001-228-WFOS-IMG1-SCI0-0001. Note that a standalone ExposureId will be changed to an ExposureId with an ObsId
Value parameters
- exposureId
-
current ExposureId
- obsId
-
new ObsId as an csw.params.core.models.ObsId
Attributes
- Returns
-
a new ExposureId with given new ObsId
A convenience function to create a new ExposureId with a new ObsId as a String. Example: 2020A-001-123-WFOS-IMG1-SCI0-0001 => 2020A-001-228-WFOS-IMG1-SCI0-0001. Note that a standalone ExposureId will be changed to an ExposureId with an ObsId.
A convenience function to create a new ExposureId with a new ObsId as a String. Example: 2020A-001-123-WFOS-IMG1-SCI0-0001 => 2020A-001-228-WFOS-IMG1-SCI0-0001. Note that a standalone ExposureId will be changed to an ExposureId with an ObsId.
Value parameters
- exposureId
-
current ExposureId
- obsIdString
-
new ObsId as a String
Attributes
- Returns
-
ExposureId with given new csw.params.core.models.ObsId
A convenience function to create a new ExposureId with the same exposure number and specified sub array number Example: 2020A-001-123-WFOS-IMG1-SCI0-0001, 3 => 2020A-001-123-WFOS-IMG1-SCI0-0002-03. Example: 2020A-001-123-WFOS-IMG1-SCI0-0002-00, 4 => 2020A-001-123-WFOS-IMG1-SCI0-0002-04.
A convenience function to create a new ExposureId with the same exposure number and specified sub array number Example: 2020A-001-123-WFOS-IMG1-SCI0-0001, 3 => 2020A-001-123-WFOS-IMG1-SCI0-0002-03. Example: 2020A-001-123-WFOS-IMG1-SCI0-0002-00, 4 => 2020A-001-123-WFOS-IMG1-SCI0-0002-04.
Value parameters
- exposureId
-
current ExposureId
- subArrayNumber
-
specified subArray number
Attributes
- Returns
-
ExposureId with next higher ExposureNumber
A convenience function that allows creating a standalone ExposureId at a specific UTC date and time. Note than an ExposureId with an ObsId can be changed to a standalone ExposureId.
A convenience function that allows creating a standalone ExposureId at a specific UTC date and time. Note than an ExposureId with an ObsId can be changed to a standalone ExposureId.
Value parameters
- exposureId
-
current ExposureId
- utc
-
a csw.time.core.models.UTCTime for the ExposureId
Attributes
- Returns
-
a standalone ExposureId at the provided UTC