JNISpice
version 2.0.0

spice.basic
Enum OccultationCode

java.lang.Object
  extended by java.lang.Enum<OccultationCode>
      extended by spice.basic.OccultationCode
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<OccultationCode>

public enum OccultationCode
extends java.lang.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:

Version 1.0.0 21-DEC-2016 (NJB)


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

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 final OccultationCode[] values()
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:
for(OccultationCode c : OccultationCode.values())
        System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they're 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 name

getOccultationCode

public int getOccultationCode()
For a given OccultationCode instance, return the corresponding integer occultation code used by CSPICE and SPICELIB.


mapIntCode

public static OccultationCode mapIntCode(int intCode)
                                  throws SpiceException
Return the OccultationCode instance corresponding to a SPICE integer occultation state parameter.

Throws:
SpiceException

JNISpice
version 2.0.0

JNISpice Alpha Test Version 2.0.0 28-JAN-2017 (NJB)