org.micromanager.api

Class PositionList

java.lang.Object

org.micromanager.api.PositionList

All Implemented Interfaces:

java.io.Serializable

public class PositionList
extends java.lang.Object
implements java.io.Serializable

Navigation list of positions for the XYStage. Used for multi site acquisition support.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AF_KEY
static java.lang.String	AF_VALUE_FULL
static java.lang.String	AF_VALUE_INCREMENTAL
static java.lang.String	AF_VALUE_NONE

Constructor Summary

Constructors

Constructor and Description
PositionList()

Method Summary

Modifier and Type	Method and Description
void	addChangeListener(javax.swing.event.ChangeListener listener)
void	addPosition(int in0, MultiStagePosition pos) Insert a position into the list.
void	addPosition(MultiStagePosition pos) Adds a new position to the list.
void	clearAllPositions() Empties the list.
java.lang.String	generateLabel() Helper method to generate unique label when inserting a new position.
java.lang.String	generateLabel(java.lang.String proposal)
int	getNumberOfPositions() Returns the number of positions contained within the list
MultiStagePosition	getPosition(int idx) Returns multi-stage position associated with the position index.
MultiStagePosition	getPositionCopy(int idx) Returns a copy of the multi-stage position associated with the position index.
int	getPositionIndex(java.lang.String posLabel) Returns position index associated with the position name.
MultiStagePosition[]	getPositions() Returns an array of positions contained in the list.
boolean	isLabelUnique(java.lang.String label) Verify that the new label is unique
void	load(java.lang.String path) Load position list from a file.
static PositionList	newInstance(PositionList aPl)
void	notifyChangeListeners()
void	removeChangeListener(javax.swing.event.ChangeListener listener)
void	removePosition(int idx) Removes a specific position based on the index
void	replacePosition(int index, MultiStagePosition pos) Replaces position in the list with the new position
void	restore(java.lang.String stream) Restore object data from the JSON encoded stream.
void	save(java.lang.String path) Save list to a file.
java.lang.String	serialize() Serialize object into the JSON encoded stream.
void	setLabel(int idx, java.lang.String label) Assigns a label to the position index
void	setPositions(MultiStagePosition[] posArray) Initialize the entire array by passing an array of multi-stage positions

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

AF_KEY

public static final java.lang.String AF_KEY

See Also:

Constant Field Values

AF_VALUE_FULL

public static final java.lang.String AF_VALUE_FULL

See Also:

Constant Field Values

AF_VALUE_INCREMENTAL

public static final java.lang.String AF_VALUE_INCREMENTAL

See Also:

Constant Field Values

AF_VALUE_NONE

public static final java.lang.String AF_VALUE_NONE

See Also:

Constant Field Values

Constructor Detail

PositionList

public PositionList()

Method Detail

newInstance

public static PositionList newInstance(PositionList aPl)

addChangeListener

public void addChangeListener(javax.swing.event.ChangeListener listener)

removeChangeListener

public void removeChangeListener(javax.swing.event.ChangeListener listener)

notifyChangeListeners

public void notifyChangeListeners()

getPosition

public MultiStagePosition getPosition(int idx)

Returns multi-stage position associated with the position index.

Parameters:

idx - - position index

Returns:

multi-stage position

getPositionCopy

public MultiStagePosition getPositionCopy(int idx)

Returns a copy of the multi-stage position associated with the position index.

Parameters:

idx - - position index

Returns:

multi-stage position

getPositionIndex

public int getPositionIndex(java.lang.String posLabel)

Returns position index associated with the position name.

Parameters:

posLabel - - label (name) of the position

Returns:

index

addPosition

public void addPosition(MultiStagePosition pos)

Adds a new position to the list.

Parameters:

pos - - multi-stage position

addPosition

public void addPosition(int in0,
                        MultiStagePosition pos)

Insert a position into the list.

Parameters:

pos - - multi-stage position

replacePosition

public void replacePosition(int index,
                            MultiStagePosition pos)

Replaces position in the list with the new position

Parameters:

pos - - multi-stage position

getNumberOfPositions

public int getNumberOfPositions()

Returns the number of positions contained within the list

clearAllPositions

public void clearAllPositions()

Empties the list.

removePosition

public void removePosition(int idx)

Removes a specific position based on the index

Parameters:

idx - - position index

setPositions

public void setPositions(MultiStagePosition[] posArray)

Initialize the entire array by passing an array of multi-stage positions

Parameters:

posArray - - array of multi-stage positions

getPositions

public MultiStagePosition[] getPositions()

Returns an array of positions contained in the list.

Returns:

position array

setLabel

public void setLabel(int idx,
                     java.lang.String label)

Assigns a label to the position index

Parameters:

idx - - position index

label - - new label (name)

serialize

public java.lang.String serialize()
                           throws org.micromanager.utils.MMSerializationException

Serialize object into the JSON encoded stream.

Throws:

org.micromanager.utils.MMSerializationException

restore

public void restore(java.lang.String stream)
             throws org.micromanager.utils.MMSerializationException

Restore object data from the JSON encoded stream.

Parameters:

stream -

Throws:

org.micromanager.utils.MMSerializationException

generateLabel

public java.lang.String generateLabel()

Helper method to generate unique label when inserting a new position. Not recommended for use - planned to become obsolete.

Returns:

Unique label

generateLabel

public java.lang.String generateLabel(java.lang.String proposal)

isLabelUnique

public boolean isLabelUnique(java.lang.String label)

Verify that the new label is unique

Parameters:

label - - proposed label

Returns:

true if label does not exist

save

public void save(java.lang.String path)
          throws org.micromanager.utils.MMException

Save list to a file.

Parameters:

path -

Throws:

org.micromanager.utils.MMException

load

public void load(java.lang.String path)
          throws org.micromanager.utils.MMException

Load position list from a file.

Parameters:

path -

Throws:

org.micromanager.utils.MMException