public class ControlBank extends LWRComponent
The ControlBank class contains properties associated with axially movable RodClusterAssembly objects known as Rod Cluster Control Assemblies. A Bank is a group of RCCA's that are positioned simultaneously by the plant operations. A Bank may have 8 individual RCCAs, for instance, located symmetrically around the core. For a core with 50+ RCCAs, usually only 8 or so banks are controlled independently.
iComponentVisitor
iComponentListener
Constructor and Description |
---|
ControlBank()
The nullary Constructor.
|
ControlBank(java.lang.String name,
double stepSize,
int maxNumberOfSteps)
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(ControlBank 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.
|
int |
getMaxNumberOfSteps()
Returns the maximum number of axial steps.
|
double |
getStepSize()
Returns the axial step size.
|
double |
getStrokeLength()
Calculates and returns the stroke length, which is the axial step size
multiplied by the maximum number of axial steps.
|
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 |
setMaxNumberOfSteps(int maxNumberOfSteps)
Sets the maximum number of axial steps.
|
void |
setStepSize(double stepSize)
Sets the axial step size.
|
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.
|
accept, addData, copy, createGroup, getCurrentTime, getDataAtCurrentTime, getDescription, getFeatureList, getFeaturesAtCurrentTime, getHDF5LWRTag, getId, getName, getNumberOfTimeSteps, getSourceInfo, getTimes, getTimeStep, getTimeUnits, getWriteableChildren, readChild, readDatasets, register, removeAllDataFromFeature, setDescription, setId, setName, setSourceInfo, setTime, setTimeUnits, toString, unregister, update, writeDatasets
public ControlBank()
The nullary Constructor.
public ControlBank(java.lang.String name, double stepSize, int maxNumberOfSteps)
A parameterized Constructor.
name
- stepSize
- The distance between an axial step.
maxNumberOfSteps
- The maximum number of axial steps.
public void setStepSize(double stepSize)
Sets the axial step size.
stepSize
- The axial step size.
public void setMaxNumberOfSteps(int maxNumberOfSteps)
Sets the maximum number of axial steps.
maxNumberOfSteps
- The maximum number of axial steps.
public int getMaxNumberOfSteps()
Returns the maximum number of axial steps.
The maximum number of axial steps.
public double getStepSize()
Returns the axial step size.
The axial step size.
public double getStrokeLength()
Calculates and returns the stroke length, which is the axial step size multiplied by the maximum number of axial steps.
The axial step size multiplied by the maximum number of axial steps.
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 LWRComponent
h5File
- h5Group
- 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 LWRComponent
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 LWRComponent
The hash of the object.
public void copy(ControlBank 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 LWRComponent
The newly instantiated copied object.
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 LWRComponent
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.
accept
in class LWRComponent
visitor
- The visitor