JNISpice
version 2.0.0

spice.basic
Class SurfaceName

java.lang.Object
  extended by spice.basic.IDMap
      extended by spice.basic.SurfaceIDMap
          extended by spice.basic.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)


Constructor Summary
SurfaceName(java.lang.String name, Body body)
          Create a new SurfaceName from a name string and a Body.
 
Method Summary
 SurfaceName deepCopy()
          Return a deep copy of this instance.
 Body getBody()
          Return the Body associated with this surface.
 int getIDCode()
          Return the integer Surface ID code of this SurfaceCode instance.
 java.lang.String getName()
          Return the surface 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

SurfaceName

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

Throws:
SpiceException
Method Detail

getIDCode

public int getIDCode()
              throws SpiceException
Return the integer Surface ID code of this SurfaceCode 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 the surface name associated with this ID code. This method returns a deep copy of the object's `surfaceName' field.

Specified by:
getName in class IDMap
Throws:
SpiceException

getBody

public Body getBody()
             throws SpiceException
Return the Body associated with this surface. This method returns a deep copy.

Specified by:
getBody in class SurfaceIDMap
Throws:
SpiceException

deepCopy

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

Specified by:
deepCopy in class SurfaceIDMap
Throws:
SpiceException

JNISpice
version 2.0.0

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