JNISpice
version 2.0.0

spice.basic
Class GFScalarQuantity

java.lang.Object
  extended by spice.basic.GFScalarQuantity
Direct Known Subclasses:
TestGFUserDefinedScalarSearch

public abstract class GFScalarQuantity
extends java.lang.Object

Abstract class GFScalarQuantity provides a template for user-defined classes representing scalar functions of time to be used in GF searches.

Code Examples

See the examples in GFUserDefinedScalarSearch.

The numerical results shown for these examples may differ across platforms. The results depend on the SPICE kernels used as input, the compiler and supporting libraries, and the machine specific arithmetic implementation.

Version 1.0.0 30-DEC-2009 (NJB)


Constructor Summary
GFScalarQuantity()
           
 
Method Summary
abstract  double getQuantity(double et)
          Return the value of a user-defined scalar quantity at a specified time.
abstract  boolean isQuantityDecreasing(double et)
          Return a boolean value indicating whether the scalar function represented by getQuantity is decreasing at a specified time.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GFScalarQuantity

public GFScalarQuantity()
Method Detail

getQuantity

public abstract double getQuantity(double et)
                            throws SpiceException
Return the value of a user-defined scalar quantity at a specified time. The time is expressed as seconds past J2000 TDB.

Throws:
SpiceException

isQuantityDecreasing

public abstract boolean isQuantityDecreasing(double et)
                                      throws SpiceException
Return a boolean value indicating whether the scalar function represented by getQuantity is decreasing at a specified time. The time is expressed as seconds past J2000 TDB.

Throws:
SpiceException

JNISpice
version 2.0.0

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