Module JNISpice
Package spice.basic

Class SurfaceName


  • public class SurfaceName
    extends SurfaceIDMap
    Class SurfaceName represents surface-name mappings that are initialized by specification of a surface name and a Body.

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

    Version 1.0.0 26-DEC-2016 (NJB)

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private Body body  
      private java.lang.String surfaceName  
    • Constructor Summary

      Constructors 
      Constructor Description
      SurfaceName​(java.lang.String name, Body body)
      Create a new SurfaceName from a name string and a Body.
    • Method Summary

      Modifier and Type Method Description
      SurfaceName deepCopy()
      Return a deep copy of this instance.
      Body getBody()
      Return the Body associated with this surface.This method returns a deep copy.
      int getIDCode()
      Return the integer Surface ID code of this SurfaceCode instance.The code is that associated with the name at the time of the call.
      java.lang.String getName()
      Return the surface name associated with this ID code.This method returns a deep copy of the object's `surfaceName' field.
      • Methods inherited from class java.lang.Object

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

      • surfaceName

        private java.lang.String surfaceName
      • body

        private Body body
    • Constructor Detail

      • SurfaceName

        public SurfaceName​(java.lang.String name,
                           Body body)
                    throws SpiceException
        Create a new SurfaceName from a name string and a Body.
        Parameters:
        name -
        body -
        Throws:
        SpiceException