ucl.physiol.neuroconstruct.project
Class SimPlot

java.lang.Object
  ucl.physiol.neuroconstruct.project.SimPlot

public class SimPlot
extends Object

Info on something to plot **and/or save** during a simulation

Author:

Padraig Gleeson

Field Summary

static String	CONCENTRATION
static String	COND_DENS
static String	CONTINUOUS_DATA_EXT
static String	CURR_DENS
static float	DEFAULT_THRESHOLD
static String	H5_EXT
static String	PLOT_AND_SAVE
static String	PLOT_ONLY
static String	PLOTTED_VALUE_SEPARATOR Used to separate the element from the field, e.g.
static String	REV_POT
static String	SAVE_ONLY
static String	SPIKE
static String	SPIKE_EXT
static String	SYN_COND
static String	SYN_CURR
static String	SYNAPSES
static String	VOLTAGE

Constructor Summary

SimPlot()

SimPlot(String plotReference, String graphWindow, String cellGroup, String cellNumber, String segmentId, String valuePlotted, float minValue, float maxValue, String plotAndOrSave)

Method Summary

Object	clone()
String	getCellGroup()
String	getCellNumber()
static String	getFilename(GeneratedPlotSaves.PlotSaveDetails record, PostSynapticObject pso, String cellNumber)
static String	getFilename(GeneratedPlotSaves.PlotSaveDetails record, Segment segment, String cellNumber)
String	getGraphWindow()
static String	getLegend(String variable) Gets an appropriate legend for graphs if the quantity plotted can be determine from valuePlotted
float	getMaxValue()
float	getMinValue()
static String	getNetConnName(String synapticMechVariable)
String	getPlotAndOrSave()
String	getPlotReference()
String	getSafeVarName()
String	getSegmentId()
static String	getSynapseType(String synapticMechVariable)
static String	getSynapseVariable(String synapticMechVariable)
static String	getUnits(String variable) Gets the units if the quantity plotted can be determine from valuePlotted
String	getValuePlotted()
boolean	isSynapticMechanism()
boolean	isVoltage()
void	setCellGroup(String cellGroup)
void	setCellNumber(String cellNumber)
void	setGraphWindow(String graphWindow)
void	setMaxValue(float maxValue)
void	setMinValue(float minValue)
void	setPlotAndOrSave(String plotAndOrSave)
void	setPlotReference(String plotReference)
void	setSegmentId(String segmentId)
void	setValuePlotted(String valuePlotted)
boolean	toBePlotted()
boolean	toBeSaved()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

VOLTAGE

public static String VOLTAGE

SPIKE

public static String SPIKE

CONCENTRATION

public static String CONCENTRATION

COND_DENS

public static String COND_DENS

CURR_DENS

public static String CURR_DENS

REV_POT

public static String REV_POT

SYNAPSES

public static String SYNAPSES

SYN_COND

public static String SYN_COND

SYN_CURR

public static String SYN_CURR

PLOT_ONLY

public static String PLOT_ONLY

SAVE_ONLY

public static String SAVE_ONLY

PLOT_AND_SAVE

public static String PLOT_AND_SAVE

CONTINUOUS_DATA_EXT

public static String CONTINUOUS_DATA_EXT

SPIKE_EXT

public static String SPIKE_EXT

H5_EXT

public static String H5_EXT

DEFAULT_THRESHOLD

public static float DEFAULT_THRESHOLD

PLOTTED_VALUE_SEPARATOR

public static String PLOTTED_VALUE_SEPARATOR

Used to separate the element from the field, e.g. NaConductance:Gk

Constructor Detail

SimPlot

public SimPlot(String plotReference,
               String graphWindow,
               String cellGroup,
               String cellNumber,
               String segmentId,
               String valuePlotted,
               float minValue,
               float maxValue,
               String plotAndOrSave)

SimPlot

public SimPlot()

Method Detail

clone

public Object clone()

Overrides:

clone in class Object

getUnits

public static String getUnits(String variable)

Gets the units if the quantity plotted can be determine from valuePlotted

getLegend

public static String getLegend(String variable)

Gets an appropriate legend for graphs if the quantity plotted can be determine from valuePlotted

isVoltage

public boolean isVoltage()

isSynapticMechanism

public boolean isSynapticMechanism()

getNetConnName

public static String getNetConnName(String synapticMechVariable)

getSynapseType

public static String getSynapseType(String synapticMechVariable)

getSynapseVariable

public static String getSynapseVariable(String synapticMechVariable)

getCellGroup

public String getCellGroup()

getCellNumber

public String getCellNumber()

getMaxValue

public float getMaxValue()

getMinValue

public float getMinValue()

getPlotReference

public String getPlotReference()

getValuePlotted

public String getValuePlotted()

setCellGroup

public void setCellGroup(String cellGroup)

setCellNumber

public void setCellNumber(String cellNumber)

setMaxValue

public void setMaxValue(float maxValue)

setMinValue

public void setMinValue(float minValue)

setPlotReference

public void setPlotReference(String plotReference)

setValuePlotted

public void setValuePlotted(String valuePlotted)

getGraphWindow

public String getGraphWindow()

getPlotAndOrSave

public String getPlotAndOrSave()

toBePlotted

public boolean toBePlotted()

toBeSaved

public boolean toBeSaved()

setPlotAndOrSave

public void setPlotAndOrSave(String plotAndOrSave)

setGraphWindow

public void setGraphWindow(String graphWindow)

getSegmentId

public String getSegmentId()

setSegmentId

public void setSegmentId(String segmentId)

toString

public String toString()

Overrides:

toString in class Object

getSafeVarName

public String getSafeVarName()

getFilename

public static String getFilename(GeneratedPlotSaves.PlotSaveDetails record,
                                 Segment segment,
                                 String cellNumber)

getFilename

public static String getFilename(GeneratedPlotSaves.PlotSaveDetails record,
                                 PostSynapticObject pso,
                                 String cellNumber)