JNISpice
version 2.0.0

spice.basic
Class BodyName

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

public class BodyName
extends IDMap

Class BodyName represents body-name mappings that are initialized by specification of a body name.

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

Version 2.0.0 26-DEC-2016 (NJB)

Functional change: getName now returns the original string used to create the BodyName instance. Formerly the returned name was generated by converting the input name to an ID code, then translating that ID code to a name.

Added deepCopy method.

Version 1.0.0 24-AUG-2009 (NJB)


Constructor Summary
BodyName(java.lang.String name)
          Create a new BodyName from a name string.
 
Method Summary
 BodyName deepCopy()
          Return a deep copy of this instance.
 int getIDCode()
          Return the integer Body ID code of this BodyCode instance.
 java.lang.String getName()
          Return a deep copy of the body 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

BodyName

public BodyName(java.lang.String name)
Create a new BodyName from a name string.

Method Detail

getIDCode

public int getIDCode()
              throws SpiceException
Return the integer Body ID code of this BodyCode instance. The code is that associated with the name at the time of the call.

Specified by:
getIDCode in class IDMap
Throws:
SpiceException

getName

public java.lang.String getName()
                         throws SpiceException
Return a deep copy of the body name associated with this ID code.

Specified by:
getName in class IDMap
Throws:
SpiceException

deepCopy

public BodyName 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)