|
JNISpice version 2.0.0 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |
java.lang.Objectjava.lang.Enum<OccultationCode>
spice.basic.OccultationCode
public enum OccultationCode
Enum OccultationCode declares parameters associated with
occultation states computed by the class OccultationState
.
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:
Enum Constant Summary | |
---|---|
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. |
Method Summary | |
---|---|
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're declared. |
Methods inherited from class java.lang.Enum |
---|
clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Enum Constant Detail |
---|
public static final OccultationCode TOTAL1
public static final OccultationCode ANNLR1
public static final OccultationCode PARTL1
public static final OccultationCode NOOCC
public static final OccultationCode PARTL2
public static final OccultationCode ANNLR2
public static final OccultationCode TOTAL2
Method Detail |
---|
public static final OccultationCode[] values()
for(OccultationCode c : OccultationCode.values()) System.out.println(c);
public static OccultationCode valueOf(java.lang.String name)
name
- the name of the enum constant to be returned.
java.lang.IllegalArgumentException
- if this enum type has no constant
with the specified namepublic int getOccultationCode()
public static OccultationCode mapIntCode(int intCode) throws SpiceException
SpiceException
|
JNISpice version 2.0.0 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |