JNISpice
version 2.0.0

spice.basic
Class KernelVarDescriptor

java.lang.Object
  extended by spice.basic.KernelVarDescriptor

public class KernelVarDescriptor
extends java.lang.Object

Class KernelVarDescriptor packages attributes of kernel variables.

Version 1.0.0 03-DEC-2009 (NJB)


Field Summary
static int CHARACTER
           
static java.lang.String CSPICE_CHARACTER
           
static java.lang.String CSPICE_NUMERIC
           
static int NUMERIC
           
 
Constructor Summary
KernelVarDescriptor()
          Zero-arguments constructor.
KernelVarDescriptor(boolean exists, java.lang.String name, int size, int dataType)
          Construct a descriptor from a kernel variable's attributes.
KernelVarDescriptor(KernelVarDescriptor descr)
          Copy constructor.
 
Method Summary
 boolean exists()
          Return a boolean indicating whether a specified kernel variable exists (is present in the kernel pool).
 int getDataType()
          Return the data type of the kernel variable, if any, associated with this instance.
 java.lang.String getName()
          Return the name of the kernel variable associated with this instance.
 int getSize()
          Return the size of the kernel variable, if any, associated with this instance.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CHARACTER

public static final int CHARACTER
See Also:
Constant Field Values

NUMERIC

public static final int NUMERIC
See Also:
Constant Field Values

CSPICE_CHARACTER

public static final java.lang.String CSPICE_CHARACTER
See Also:
Constant Field Values

CSPICE_NUMERIC

public static final java.lang.String CSPICE_NUMERIC
See Also:
Constant Field Values
Constructor Detail

KernelVarDescriptor

public KernelVarDescriptor()
Zero-arguments constructor.


KernelVarDescriptor

public KernelVarDescriptor(KernelVarDescriptor descr)
Copy constructor.


KernelVarDescriptor

public KernelVarDescriptor(boolean exists,
                           java.lang.String name,
                           int size,
                           int dataType)
Construct a descriptor from a kernel variable's attributes.

Method Detail

exists

public boolean exists()
Return a boolean indicating whether a specified kernel variable exists (is present in the kernel pool).

User applications should call this method to determine whether the variable's size and data type can be fetched.


getName

public java.lang.String getName()
Return the name of the kernel variable associated with this instance. The variable need not exist in the kernel pool.


getSize

public int getSize()
            throws KernelVarNotFoundException
Return the size of the kernel variable, if any, associated with this instance. This method throws an exception of the variable does not exist.

Throws:
KernelVarNotFoundException

getDataType

public int getDataType()
                throws KernelVarNotFoundException
Return the data type of the kernel variable, if any, associated with this instance. This method throws an exception of the variable does not exist.

Throws:
KernelVarNotFoundException

JNISpice
version 2.0.0

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