JNISpice
version 2.0.0

spice.basic
Class InstrumentCode

java.lang.Object
  extended by spice.basic.IDMap
      extended by spice.basic.InstrumentCode

public class InstrumentCode
extends IDMap

Class InstrumentCode represents instrument-name mappings that are initialized by specification of a instrument ID code.

SPICE applications normally won't need to use this class directly; they should use the class Instrument instead.

Version 2.0.0 26-DEC-2016 (NJB)

Added deepCopy method.

Version 1.0.0 25-AUG-2009 (NJB)


Constructor Summary
InstrumentCode(int code)
          Create a new InstrumentCode from an int ID code.
 
Method Summary
 InstrumentCode deepCopy()
          Return a deep copy of this instance.
 int getIDCode()
          Return the integer Instrument ID code of this InstrumentCode instance.
 java.lang.String getName()
          Return the instrument name associated with this ID code.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

InstrumentCode

public InstrumentCode(int code)
Create a new InstrumentCode from an int ID code.

Method Detail

getIDCode

public int getIDCode()
Return the integer Instrument ID code of this InstrumentCode instance.

Specified by:
getIDCode in class IDMap

getName

public java.lang.String getName()
                         throws SpiceException
Return the instrument name associated with this ID code. The name is that associated with the ID code at the time of the call.

Specified by:
getName in class IDMap
Throws:
SpiceException

deepCopy

public InstrumentCode deepCopy()
                        throws SpiceException
Return a deep copy of this instance.

Specified by:
deepCopy in class IDMap
Throws:
SpiceException

JNISpice
version 2.0.0

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