- java.lang.Object
-
- java.lang.Enum<OccultationCode>
-
- spice.basic.OccultationCode
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<OccultationCode>
,java.lang.constant.Constable
public enum OccultationCode extends java.lang.Enum<OccultationCode>
Enum OccultationCode declares parameters associated with occultation states computed by the classOccultationState
.The values of this class designate states of occultation of one target by another, as seen from a viewing location that is external to both objects. The possible geometric states considered by this class are:
- One target completely occults the other.
- One target is in transit the other, such that the entire limb of the occulted target is visible from the viewing location. This is called an "annular occultation."
- One target partially occults the other, such that a portion of the limb of the occulted object is not visible from the viewing location. This is called a "partial occultation."
- Neither target occults the other.
Version 1.0.0 21-DEC-2016 (NJB)
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ANNLR1
Parameter indicating annular occultation of the first target by the second.ANNLR2
Parameter indicating annular occultation of the second target by the first.NOOCC
Parameter indicating that neither target occults the other.PARTL1
Parameter indicating partial occultation of the first target by the second.PARTL2
Parameter indicating partial occultation of the second target by the first.TOTAL1
Parameter indicating total occultation of the first target by the second.TOTAL2
Parameter indicating total occultation of the second target by the first.
-
Field Summary
Fields Modifier and Type Field Description private int
code
-
Constructor Summary
Constructors Modifier Constructor Description private
OccultationCode(int code)
-
Method Summary
Modifier and Type Method Description int
getOccultationCode()
For a given OccultationCode instance, return the corresponding integer occultation code used by CSPICE and SPICELIB.static OccultationCode
mapIntCode(int intCode)
Return the OccultationCode instance corresponding to a SPICE integer occultation state parameter.static OccultationCode
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static OccultationCode[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
TOTAL1
public static final OccultationCode TOTAL1
Parameter indicating total occultation of the first target by the second.
-
ANNLR1
public static final OccultationCode ANNLR1
Parameter indicating annular occultation of the first target by the second.
-
PARTL1
public static final OccultationCode PARTL1
Parameter indicating partial occultation of the first target by the second.
-
NOOCC
public static final OccultationCode NOOCC
Parameter indicating that neither target occults the other.
-
PARTL2
public static final OccultationCode PARTL2
Parameter indicating partial occultation of the second target by the first.
-
ANNLR2
public static final OccultationCode ANNLR2
Parameter indicating annular occultation of the second target by the first.
-
TOTAL2
public static final OccultationCode TOTAL2
Parameter indicating total occultation of the second target by the first.
-
-
Method Detail
-
values
public static OccultationCode[] values()
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static OccultationCode valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
getOccultationCode
public int getOccultationCode()
For a given OccultationCode instance, return the corresponding integer occultation code used by CSPICE and SPICELIB.- Returns:
- int
-
mapIntCode
public static OccultationCode mapIntCode(int intCode) throws SpiceException
Return the OccultationCode instance corresponding to a SPICE integer occultation state parameter.- Parameters:
intCode
- int- Returns:
- OccultationCode
- Throws:
SpiceException
- exception
-
-