ucl.physiol.neuroconstruct.project.segmentchoice
Class SegmentLocationChooser

java.lang.Object
  ucl.physiol.neuroconstruct.project.segmentchoice.SegmentLocationChooser

Direct Known Subclasses:

GroupDistributedSegments, IndividualSegments

public abstract class SegmentLocationChooser
extends Object

Base class for all Segment Choosers. This can be extended to allow different subsets of Segments to be selected. The primary purpose of this is to allow elec stims be put on subsets of segments.

Author:

Padraig Gleeson

Constructor Summary

SegmentLocationChooser(String description)

Method Summary

Object	clone()
protected abstract SegmentLocation	generateNextSegLoc()
String	getDescription()
SegmentLocation	getNextSegLoc() Gets the next chosen segment based on the settings in the sub class
void	initialise(Cell cell)
boolean	isInitialised()
protected abstract void	reinitialise()
abstract String	toNiceString()
String	toString()

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SegmentLocationChooser

public SegmentLocationChooser(String description)

Method Detail

clone

public Object clone()

Overrides:

clone in class Object

getDescription

public String getDescription()

initialise

public void initialise(Cell cell)

getNextSegLoc

public SegmentLocation getNextSegLoc()
                              throws AllSegmentsChosenException,
                                     SegmentChooserException

Gets the next chosen segment based on the settings in the sub class

Throws:

AllSegmentsChosenException

SegmentChooserException

isInitialised

public boolean isInitialised()

generateNextSegLoc

protected abstract SegmentLocation generateNextSegLoc()
                                               throws AllSegmentsChosenException,
                                                      SegmentChooserException

Throws:

AllSegmentsChosenException

SegmentChooserException

reinitialise

protected abstract void reinitialise()

toString

public String toString()

Overrides:

toString in class Object

toNiceString

public abstract String toNiceString()