Main Page | Packages | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

ikayaki.MeasurementSequence Class Reference

List of all members.

Public Member Functions

 MeasurementSequence ()
 MeasurementSequence (String name)
 MeasurementSequence (Element element)
 MeasurementSequence (Element element, Project project)
synchronized Element getElement (Document document)
synchronized String getName ()
synchronized void setName (String name)
synchronized int getSteps ()
synchronized MeasurementStep getStep (int index)
synchronized void addStep (MeasurementStep step)
synchronized void addStep (int index, MeasurementStep step)
synchronized void removeStep (int index)
int compareTo (MeasurementSequence other)
Override String toString ()

Private Attributes

String name
final List< MeasurementStepsteps = new ArrayList<MeasurementStep>()

Detailed Description

A list of measurement steps. Steps can be added or removed from the sequence. <p/> All operations are thread-safe.

Author:
Esko Luontola

Definition at line 39 of file MeasurementSequence.java.


Constructor & Destructor Documentation

ikayaki.MeasurementSequence.MeasurementSequence  ) 
 

Creates an empty sequence with no name.

Definition at line 54 of file MeasurementSequence.java.

References ikayaki.MeasurementSequence.setName().

Here is the call graph for this function:

ikayaki.MeasurementSequence.MeasurementSequence String  name  ) 
 

Creates an empty sequence with the specified name.

Parameters:
name name of the sequence.
Exceptions:
NullPointerException if name is null.

Definition at line 64 of file MeasurementSequence.java.

References ikayaki.MeasurementSequence.setName().

Here is the call graph for this function:

ikayaki.MeasurementSequence.MeasurementSequence Element  element  ) 
 

Creates a sequence from the specified element.

Parameters:
element the element from which this sequence will be created.
Exceptions:
NullPointerException if element is null.
IllegalArgumentException if the element was not in the right format.

Definition at line 75 of file MeasurementSequence.java.

ikayaki.MeasurementSequence.MeasurementSequence Element  element,
Project  project
 

Creates a sequence from the specified element for a project.

Parameters:
element the element from which this sequence will be created.
project the project whose sequence this will be, or null if this is not owned by a project. Needed for importing the measurement steps correctly.
Exceptions:
NullPointerException if element is null.
IllegalArgumentException if the element was not in the right format.

Definition at line 88 of file MeasurementSequence.java.

References ikayaki.MeasurementSequence.setName(), and ikayaki.MeasurementSequence.steps.

Here is the call graph for this function:


Member Function Documentation

synchronized void ikayaki.MeasurementSequence.addStep int  index,
MeasurementStep  step
 

Adds a step to the specified index of this sequence.

Parameters:
index the index to which the step will be added.
step the measurement step to be added.
Exceptions:
IndexOutOfBoundsException if the index is out of range (index < 0 || index > getSteps()).
NullPointerException if step is null.

Definition at line 181 of file MeasurementSequence.java.

References ikayaki.MeasurementSequence.steps.

synchronized void ikayaki.MeasurementSequence.addStep MeasurementStep  step  ) 
 

Appends a step to this sequence.

Parameters:
step the measurement step to be added.
Exceptions:
NullPointerException if step is null.

Definition at line 166 of file MeasurementSequence.java.

References ikayaki.MeasurementSequence.steps.

Referenced by ikayaki.Project.copySequence(), and ikayaki.gui.MeasurementSequencePanel.SequencePopupMenu.getSaveSelectedAsAction().

int ikayaki.MeasurementSequence.compareTo MeasurementSequence  other  ) 
 

Orders the sequences by their name. If two different sequences have the same name, one of them if always greater than the other.

Parameters:
other the sequence to be compared to.
Returns:
less than 0 if this precedes other, or 0 if they are the same sequence, or else greater than 0.

Definition at line 205 of file MeasurementSequence.java.

References ikayaki.MeasurementSequence.getName().

Here is the call graph for this function:

synchronized Element ikayaki.MeasurementSequence.getElement Document  document  ) 
 

Exports this sequence to a DOM element.

Parameters:
document the document that will contain this element.

Definition at line 114 of file MeasurementSequence.java.

References ikayaki.MeasurementSequence.name, and ikayaki.MeasurementSequence.steps.

Referenced by ikayaki.Project.getDocument().

synchronized String ikayaki.MeasurementSequence.getName  ) 
 

Returns the name of this sequence.

Definition at line 126 of file MeasurementSequence.java.

References ikayaki.MeasurementSequence.name.

Referenced by ikayaki.MeasurementSequence.compareTo(), ikayaki.gui.ProgramSettingsPanel.EditSequencesTableModel.getValueAt(), ikayaki.gui.ProgramSettingsPanel.EditSequencesTableModel.setValueAt(), and ikayaki.MeasurementSequence.toString().

synchronized MeasurementStep ikayaki.MeasurementSequence.getStep int  index  ) 
 

Returns the specified step from this sequence.

Parameters:
index the index of the step.
Returns:
the specified step.
Exceptions:
IndexOutOfBoundsException if the index is out of range (index < 0 || index >= getSteps()).

Definition at line 156 of file MeasurementSequence.java.

References ikayaki.MeasurementSequence.steps.

Referenced by ikayaki.Project.addSequence(), ikayaki.gui.MeasurementSequencePanel.SequencePopupMenu.getFirstIndex(), ikayaki.Project.getTimestamp(), ikayaki.Project.Project(), and ikayaki.Project.updateTransforms().

synchronized int ikayaki.MeasurementSequence.getSteps  ) 
 

Returns the number of steps in this sequence.

Definition at line 145 of file MeasurementSequence.java.

References ikayaki.MeasurementSequence.steps.

Referenced by ikayaki.Project.addSequence(), ikayaki.Project.getTimestamp(), ikayaki.Project.Project(), and ikayaki.Project.updateTransforms().

synchronized void ikayaki.MeasurementSequence.removeStep int  index  ) 
 

Removes a step from this sequence.

Parameters:
index the index of the step to be removed.
Exceptions:
IndexOutOfBoundsException if the index is out of range (index < 0 || index >= getSteps()).

Definition at line 194 of file MeasurementSequence.java.

References ikayaki.MeasurementSequence.steps.

synchronized void ikayaki.MeasurementSequence.setName String  name  ) 
 

Sets the name of this sequence.

Exceptions:
NullPointerException if name is null.

Definition at line 135 of file MeasurementSequence.java.

Referenced by ikayaki.gui.MeasurementSequencePanel.SequencePopupMenu.getSaveAllAsAction(), ikayaki.gui.MeasurementSequencePanel.SequencePopupMenu.getSaveSelectedAsAction(), ikayaki.MeasurementSequence.MeasurementSequence(), and ikayaki.gui.ProgramSettingsPanel.EditSequencesTableModel.setValueAt().

Override String ikayaki.MeasurementSequence.toString  ) 
 

Definition at line 214 of file MeasurementSequence.java.

References ikayaki.MeasurementSequence.getName().

Referenced by ikayaki.gui.ProgramSettingsPanel.EditSequencesTableModel.setValueAt().

Here is the call graph for this function:


Member Data Documentation

String ikayaki.MeasurementSequence.name [private]
 

Name of the sequence. Empty string if it has no name.

Definition at line 44 of file MeasurementSequence.java.

Referenced by ikayaki.MeasurementSequence.getElement(), and ikayaki.MeasurementSequence.getName().

final List<MeasurementStep> ikayaki.MeasurementSequence.steps = new ArrayList<MeasurementStep>() [private]
 

The measurement steps of this sequence.

Definition at line 49 of file MeasurementSequence.java.

Referenced by ikayaki.MeasurementSequence.addStep(), ikayaki.MeasurementSequence.getElement(), ikayaki.MeasurementSequence.getStep(), ikayaki.MeasurementSequence.getSteps(), ikayaki.MeasurementSequence.MeasurementSequence(), and ikayaki.MeasurementSequence.removeStep().


The documentation for this class was generated from the following file:
Generated on Fri May 6 16:00:39 2005 for Squid by  doxygen 1.4.1