Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

Class JsPool

java.lang.Object
  extended byJsPool
public class JsPool
extends java.lang.Object

Nested Class Summary
static class JsPool.FatType
          Determine the file architecture and file type of most SPICE kernel files
static class JsPool.KernelTypes
           
static class JsPool.PoolLimit
          Determine the file architecture and file type of most SPICE kernel files
static class JsPool.VarType
          Return Type of the variable
 
Constructor Summary
JsPool()
           
 
Method Summary
 java.lang.String bod2nc(int code)
          Translate the SPICE integer code of a body into a common name for that body
 void boddef(java.lang.String name, int code)
          Define a body name/ID code pair for later translation via bodn2 or bodc2n for that body
 boolean bodfnd(int code, java.lang.String item)
          Determine whether values exist for some item for any body in the kernel pool
 int bodn2c(java.lang.String name)
          Translate the name of a body into the SPICE integer ID code for that body
 double[] bodvar(int code, java.lang.String item)
          Translate the name of a body into the SPICE integer ID code for that body
 int cidfrmCode(int code)
          Retrieve frame ID code to associate with a frame center that body
 java.lang.String cidfrmName(int code)
          Retrieve frame Name to associate with a frame center that body
 void clear()
          Remove all variables from the kernel pool
 int cnmfrmCode(java.lang.String FrameName)
          Retrieve frame ID code to associate with a frame center that body
 java.lang.String cnmfrmName(java.lang.String FrameName)
          Retrieve frame Name to associate with a frame center that body
 void delVar(java.lang.String var)
          Delete a variable from the kernel pool.
 boolean exist(java.lang.String filename)
          Determine whether a file exists
 JsPool.FatType FatType(java.lang.String var)
           
 void furnsh(java.lang.String kernel)
          Furnish a program with the kernels and related data needed to carry out the program's computations
 java.lang.String[] gc(java.lang.String var, int start, int max)
          Return the character value of a kernel variable from the kernel pool
 double[] gd(java.lang.String var, int start, int max)
          Return the d.p.
 JsPool.KernelTypes getType(java.lang.String var)
          Determine the file architecture and file type of most SPICE kernel files
 int[] gi(java.lang.String var, int start, int max)
          Return the d.p.
 java.lang.String[] gn(java.lang.String var, int start, int max)
          Return names of kernel variables matching a specified template
 void ld(java.lang.String filename)
          Load the variables contained in a NAIF ASCII kernel file into the kernel pool
 int limit(JsPool.PoolLimit var)
           
 void pc(java.lang.String name, java.lang.String[] cvals)
          This entry point provides toolkit programmers a method for programmatically inserting character data into the kernel pool
 void pd(java.lang.String name, double[] vals)
          This entry point provides toolkit programmers a method for programmatically inserting double data into the kernel pool
 void pi(java.lang.String name, int[] vals)
          This entry point provides toolkit programmers a method for programmatically inserting double data into the kernel pool
 int total()
          Constructor
 int total(JsPool.KernelTypes typ)
          Constructor
 void unload(java.lang.String kernel)
          Unload a SPICE kernel
 void varDim(java.lang.String var)
          Return Number of values returned for name
 boolean varExist(java.lang.String var)
          Confirm the existence of a kernel variable in the kernel pool
 JsPool.VarType varType(java.lang.String var)
           
 java.lang.String version(java.lang.String var)
          Given an item such as the Toolkit or an entry point name, return the latest version string
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JsPool

public JsPool()
Method Detail

bod2nc

public java.lang.String bod2nc(int code)
                        throws java.lang.Exception
Translate the SPICE integer code of a body into a common name for that body

Parameters:
code - Integer ID code to be translated into a name
Throws:
java.lang.Exception

boddef

public void boddef(java.lang.String name,
                   int code)
            throws java.lang.Exception
Define a body name/ID code pair for later translation via bodn2 or bodc2n for that body

Parameters:
code - Integer ID code to be translated into a name
Throws:
java.lang.Exception

bodfnd

public boolean bodfnd(int code,
                      java.lang.String item)
               throws java.lang.Exception
Determine whether values exist for some item for any body in the kernel pool

Parameters:
code - Integer ID code to be translated into a name
Throws:
java.lang.Exception

bodn2c

public int bodn2c(java.lang.String name)
           throws java.lang.Exception
Translate the name of a body into the SPICE integer ID code for that body

Throws:
java.lang.Exception

bodvar

public double[] bodvar(int code,
                       java.lang.String item)
                throws java.lang.Exception
Translate the name of a body into the SPICE integer ID code for that body

Parameters:
code - Integer ID code to be translated into a name
Throws:
java.lang.Exception

cidfrmCode

public int cidfrmCode(int code)
               throws java.lang.Exception
Retrieve frame ID code to associate with a frame center that body

Parameters:
code - Integer ID code to be translated into a name
Throws:
java.lang.Exception

cidfrmName

public java.lang.String cidfrmName(int code)
                            throws java.lang.Exception
Retrieve frame Name to associate with a frame center that body

Parameters:
code - Integer ID code to be translated into a name
Throws:
java.lang.Exception

cnmfrmCode

public int cnmfrmCode(java.lang.String FrameName)
               throws java.lang.Exception
Retrieve frame ID code to associate with a frame center that body

Throws:
java.lang.Exception

cnmfrmName

public java.lang.String cnmfrmName(java.lang.String FrameName)
                            throws java.lang.Exception
Retrieve frame Name to associate with a frame center that body

Throws:
java.lang.Exception

clear

public void clear()
           throws java.lang.Exception
Remove all variables from the kernel pool

Throws:
java.lang.Exception

varDim

public void varDim(java.lang.String var)
            throws java.lang.Exception
Return Number of values returned for name

Throws:
java.lang.Exception

varType

public JsPool.VarType varType(java.lang.String var)
                       throws java.lang.Exception
Throws:
java.lang.Exception

delVar

public void delVar(java.lang.String var)
            throws java.lang.Exception
Delete a variable from the kernel pool.

Throws:
java.lang.Exception

exist

public boolean exist(java.lang.String filename)
              throws java.lang.Exception
Determine whether a file exists

Throws:
java.lang.Exception

varExist

public boolean varExist(java.lang.String var)
                 throws java.lang.Exception
Confirm the existence of a kernel variable in the kernel pool

Throws:
java.lang.Exception

furnsh

public void furnsh(java.lang.String kernel)
            throws java.lang.Exception
Furnish a program with the kernels and related data needed to carry out the program's computations

Parameters:
kernel - SPICE kernel file (text or binary).
Throws:
java.lang.Exception

gc

public java.lang.String[] gc(java.lang.String var,
                             int start,
                             int max)
                      throws java.lang.Exception
Return the character value of a kernel variable from the kernel pool

Throws:
java.lang.Exception

gd

public double[] gd(java.lang.String var,
                   int start,
                   int max)
            throws java.lang.Exception
Return the d.p. value of a kernel variable from the kernel pool

Throws:
java.lang.Exception

gi

public int[] gi(java.lang.String var,
                int start,
                int max)
         throws java.lang.Exception
Return the d.p. value of a kernel variable from the kernel pool

Throws:
java.lang.Exception

FatType

public JsPool.FatType FatType(java.lang.String var)
                       throws java.lang.Exception
Throws:
java.lang.Exception

getType

public JsPool.KernelTypes getType(java.lang.String var)
                           throws java.lang.Exception
Determine the file architecture and file type of most SPICE kernel files

Throws:
java.lang.Exception

gn

public java.lang.String[] gn(java.lang.String var,
                             int start,
                             int max)
                      throws java.lang.Exception
Return names of kernel variables matching a specified template

Parameters:
var - template which will be used when searching for variable names in the kernel pool. The characters '*' and '%' are used for the wild string and wild characters respectively.
start - is the index of the first variable name to return that matches the name template. The matching names are assigned indices ranging from 0 to NVAR-1, where NVAR is the number of matching names. The index of a name does not indicate how it compares alphabetically to another name
max - is the maximum number of variable names that should be returned for this template. If room is less than 1 the error SPICE(BADARRAYSIZE) will be signaled
Throws:
java.lang.Exception

ld

public void ld(java.lang.String filename)
        throws java.lang.Exception
Load the variables contained in a NAIF ASCII kernel file into the kernel pool

Parameters:
filename - is the name of the kernel file whose variables will be loaded into the pool
Throws:
java.lang.Exception

pc

public void pc(java.lang.String name,
               java.lang.String[] cvals)
        throws java.lang.Exception
This entry point provides toolkit programmers a method for programmatically inserting character data into the kernel pool

Throws:
java.lang.Exception

pd

public void pd(java.lang.String name,
               double[] vals)
        throws java.lang.Exception
This entry point provides toolkit programmers a method for programmatically inserting double data into the kernel pool

Throws:
java.lang.Exception

pi

public void pi(java.lang.String name,
               int[] vals)
        throws java.lang.Exception
This entry point provides toolkit programmers a method for programmatically inserting double data into the kernel pool

Throws:
java.lang.Exception

limit

public int limit(JsPool.PoolLimit var)
          throws java.lang.Exception
Throws:
java.lang.Exception

total

public int total()
          throws java.lang.Exception
Constructor

Throws:
java.lang.Exception

total

public int total(JsPool.KernelTypes typ)
          throws java.lang.Exception
Constructor

Throws:
java.lang.Exception

version

public java.lang.String version(java.lang.String var)
                         throws java.lang.Exception
Given an item such as the Toolkit or an entry point name, return the latest version string

Throws:
java.lang.Exception

unload

public void unload(java.lang.String kernel)
            throws java.lang.Exception
Unload a SPICE kernel

Parameters:
kernel - SPICE kernel file (text or binary).
Throws:
java.lang.Exception
 
Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD