Module JNISpice
Package spice.basic

Class BodyCode


  • public class BodyCode
    extends IDMap
    Class BodyCode represents body-name mappings that are initialized by specification of a body ID code.

    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)

    Added deepCopy method.

    Version 1.0.0 24-AUG-2009 (NJB)

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private int IDcode  
    • Constructor Summary

      Constructors 
      Constructor Description
      BodyCode​(int code)
      Create a new BodyCode from an int ID code.
    • Method Summary

      Modifier and Type Method Description
      BodyCode 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 the body name associated with this ID code.The name is that associated with the ID code at the time of the call.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • IDcode

        private int IDcode
    • Constructor Detail

      • BodyCode

        public BodyCode​(int code)
        Create a new BodyCode from an int ID code.
        Parameters:
        code - BodyCode
    • Method Detail

      • getIDCode

        public int getIDCode()
        Return the integer Body ID code of this BodyCode instance.
        Specified by:
        getIDCode in class IDMap
        Returns:
        IDcode
      • getName

        public java.lang.String getName()
                                 throws SpiceException
        Return the body 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
        Returns:
        name
        Throws:
        SpiceException - exception