public class Tube extends Ring
The Tube class represents the hollow tubes in a FuelAssembly which allow for the insertion of discrete poison rodlets (Guide Tubes) and instrument thimbles (Instrument Tube).
iComponentVisitor
iComponentListener
Constructor and Description |
---|
Tube()
The nullary Constructor.
|
Tube(java.lang.String name)
The parameterized Constructor.
|
Tube(java.lang.String name,
TubeType tubeType)
A parameterized Constructor.
|
Tube(java.lang.String name,
TubeType tubeType,
Material material,
double height,
double outerRadius)
A parameterized Constructor.
|
Tube(java.lang.String name,
TubeType tubeType,
Material material,
double height,
double innerRadius,
double outerRadius)
A parameterized Constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
accept(ILWRComponentVisitor visitor)
This operation accepts an ILWRComponentVisitor that can be visit the
LWRComponent to ascertain its type and perform various type-specific
operations.
|
java.lang.Object |
clone()
Deep copies and returns a newly instantiated object.
|
void |
copy(Tube otherObject)
Deep copies the contents of the object.
|
boolean |
equals(java.lang.Object otherObject)
Overrides the equals operation to check the attributes on this object
with another object of the same type.
|
TubeType |
getTubeType()
Returns the TubeType enumeration value for this Tube.
|
int |
hashCode()
Returns the hashCode of the object.
|
boolean |
readAttributes(ncsa.hdf.object.h5.H5Group h5Group)
This operation reads Attributes from h5Group and assigns their values to
class variables.
|
void |
setTubeType(TubeType tubeType)
Sets the TubeType enumeration value for this Tube.
|
boolean |
writeAttributes(ncsa.hdf.object.h5.H5File h5File,
ncsa.hdf.object.h5.H5Group h5Group)
This operation writes HDF5 Attributes to the metadata of h5Group in the
h5File.
|
compareTo, copy, getHeight, getInnerRadius, getMaterial, getOuterRadius, getWriteableChildren, readChild, setHeight, setInnerRadius, setMaterial, setOuterRadius
accept, addData, copy, createGroup, getCurrentTime, getDataAtCurrentTime, getDescription, getFeatureList, getFeaturesAtCurrentTime, getHDF5LWRTag, getId, getName, getNumberOfTimeSteps, getSourceInfo, getTimes, getTimeStep, getTimeUnits, readDatasets, register, removeAllDataFromFeature, setDescription, setId, setName, setSourceInfo, setTime, setTimeUnits, toString, unregister, update, writeDatasets
public Tube()
The nullary Constructor.
public Tube(java.lang.String name)
The parameterized Constructor.
name
- The name of this Tube.
public Tube(java.lang.String name, TubeType tubeType)
A parameterized Constructor.
name
- The name of this Tube.
tubeType
- The TubeType enumeration value for this Tube.
public Tube(java.lang.String name, TubeType tubeType, Material material, double height, double outerRadius)
A parameterized Constructor.
name
- The name of this Tube.
tubeType
- The TubeType enumeration value for this Tube.
material
- The Material for this Tube.
height
- The height of this Tube, which must be greater than zero.
outerRadius
- The outer radius of this Tube, which must be greater than the innerRadius value.
public Tube(java.lang.String name, TubeType tubeType, Material material, double height, double innerRadius, double outerRadius)
A parameterized Constructor.
name
- The name of this Tube.
tubeType
- The TubeType enumeration value for this Tube.
material
- The Material for this Tube.
height
- The height of this Tube, which must be greater than zero.
innerRadius
- The inner radius of this Tube, which must be greater than or equal to zero.
outerRadius
- The outer radius of this Tube, which must be greater than the innerRadius value.
public TubeType getTubeType()
Returns the TubeType enumeration value for this Tube.
The TubeType enumeration value for this Tube.
public void setTubeType(TubeType tubeType)
Sets the TubeType enumeration value for this Tube. Can not set to null.
tubeType
- The TubeType enumeration value for this Tube.
public boolean equals(java.lang.Object otherObject)
Overrides the equals operation to check the attributes on this object with another object of the same type. Returns true if the objects are equal. False otherwise.
equals
in interface Identifiable
equals
in class Ring
otherObject
- The object to be compared.
True if otherObject is equal. False otherwise.
public int hashCode()
Returns the hashCode of the object.
hashCode
in interface Identifiable
hashCode
in class Ring
The hash of the object.
public void copy(Tube otherObject)
Deep copies the contents of the object.
otherObject
- The object to be copied.
public java.lang.Object clone()
Deep copies and returns a newly instantiated object.
clone
in interface Identifiable
clone
in class Ring
The newly instantiated copied object.
public boolean writeAttributes(ncsa.hdf.object.h5.H5File h5File, ncsa.hdf.object.h5.H5Group h5Group)
IHdfWriteable
This operation writes HDF5 Attributes to the metadata of h5Group in the h5File. If the h5Group is null or h5File is null or can not be opened, then false is returned. If the operation fails to write all Attributes, then false is returned. Otherwise, true is returned.
writeAttributes
in interface IHdfWriteable
writeAttributes
in class Ring
h5File
- h5Group
- public boolean readAttributes(ncsa.hdf.object.h5.H5Group h5Group)
IHdfReadable
This operation reads Attributes from h5Group and assigns their values to class variables. If h5Group is null, false is returned. If any Attribute values are null, false is returned. Otherwise, true is returned.
readAttributes
in interface IHdfReadable
readAttributes
in class Ring
h5Group
- public void accept(ILWRComponentVisitor visitor)
This operation accepts an ILWRComponentVisitor that can be visit the LWRComponent to ascertain its type and perform various type-specific operations.