|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object mavis.MagneticComponents
public class MagneticComponents
This class is used to store the steps of magnetic components and the antipole values and to retrieve these steps and values. Components are accessed through their index, which starts from 0.
Field Summary | |
---|---|
private java.util.Vector<java.lang.Boolean> |
componentIsAntipole
|
private Session |
session
|
private java.util.Vector<int[]> |
stepNumbers
|
private java.util.Vector<java.util.Vector<MeasurementStep>> |
steps
|
Constructor Summary | |
---|---|
MagneticComponents(Session session)
|
Method Summary | |
---|---|
boolean |
addComponent(java.util.Vector<MeasurementStep> steps)
Adds a new collection of MeasurementSteps. |
boolean |
addStepNumbers(int[] stepnumbers)
Call to add the component's step indices to those as in the measurement sequence table |
java.lang.Boolean |
getAntipole(int component)
Check if the specified component is an antipole or not. |
int |
getNumOfComponents()
Return the number of magnetic components currently present. |
int[] |
getStepNumbers(int component)
Returns an int[] of the component's step indices in the measurement sequence table |
java.util.Vector<MeasurementStep> |
getSteps(int component)
Returns the collection of MeasurementSteps associated with the specified magnetic component. |
boolean |
removeComponent(int component)
Removes one component i.e. collection of MeasurementSteps. |
void |
setAntipole(int component,
boolean isAntipole)
Sets the specified component to be antipole or not. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private Session session
private java.util.Vector<java.util.Vector<MeasurementStep>> steps
private java.util.Vector<int[]> stepNumbers
private java.util.Vector<java.lang.Boolean> componentIsAntipole
Constructor Detail |
---|
public MagneticComponents(Session session)
Method Detail |
---|
public boolean addComponent(java.util.Vector<MeasurementStep> steps)
steps
- A vector that contains the MeasurementSteps that should
be considered as part of the added magnetic component.
public boolean addStepNumbers(int[] stepnumbers)
stepnumbers
- An int[] that contains the indices to add
to the most recent component. Indices are
the same as those in the measurement sequence
table
public boolean removeComponent(int component)
component
- Which magnetic component to remove (0 is the first).
public java.util.Vector<MeasurementStep> getSteps(int component)
component
- Which magnetic component (0 is the first).
public int[] getStepNumbers(int component)
component
- Which magnetic component (0 is the first)
public int getNumOfComponents()
public void setAntipole(int component, boolean isAntipole)
component
- which componentisAntipole
- true if the component should be an antipolepublic java.lang.Boolean getAntipole(int component)
component
- which component
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |