- java.lang.Object
-
- spice.basic.IDMap
-
- spice.basic.SurfaceIDMap
-
- spice.basic.SurfaceCode
-
public class SurfaceCode extends SurfaceIDMap
Class SurfaceCode represents surface-name mappings that are initialized by specification of a surface ID code 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
Constructors Constructor Description SurfaceCode(int code, Body body)
Create a new SurfaceCode from an int surface ID code and a Body.
-
Method Summary
Modifier and Type Method Description SurfaceCode
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.java.lang.String
getName()
Return the surface name associated with this ID code.The name is that associated with the ID code at the time of the call.
-
-
-
Field Detail
-
IDcode
private int IDcode
-
body
private Body body
-
-
Constructor Detail
-
SurfaceCode
public SurfaceCode(int code, Body body) throws SpiceException
Create a new SurfaceCode from an int surface ID code and a Body.- Parameters:
code
-body
-- Throws:
SpiceException
-
-
Method Detail
-
getIDCode
public int getIDCode()
Return the integer Surface ID code of this SurfaceCode instance.
-
getName
public java.lang.String getName() throws SpiceException
Return the surface 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 classIDMap
- Returns:
- 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 classSurfaceIDMap
- Returns:
- Throws:
SpiceException
-
deepCopy
public SurfaceCode deepCopy() throws SpiceException
Return a deep copy of this instance.- Specified by:
deepCopy
in classSurfaceIDMap
- Returns:
- Throws:
SpiceException
-
-