xal.extension.widgets.olmplot

Class EnvelopeCurve

java.lang.Object

xal.extension.widgets.plot.BasicGraphData

xal.extension.widgets.olmplot.EnvelopeCurve

public class EnvelopeCurve
extends BasicGraphData

Graphics object representing a curve in a object. The curve is a BasicGraphData object that is an RMS envelope trajectory produced by an online model simulation.

Since:

Nov 26, 2012

Nested Class Summary

Nested classes/interfaces inherited from class xal.extension.widgets.plot.BasicGraphData

BasicGraphData.CompareErr, BasicGraphData.CompareX, BasicGraphData.CompareY, BasicGraphData.XYpoint

Field Summary

Fields inherited from class xal.extension.widgets.plot.BasicGraphData

color, drawLinesOn, drawPointsOn, errYmax, graphDataContainerV, immediateContainerUpdate, lineStroke, lineThick, lockUpObj, markShape, markShapeFilled, name, nInterpPoints, pointSize, propertyMap, xMax, xMin, xyInterpPointV, xyPointV, yMax, yMin

Constructor Summary

Constructors

Constructor and Description
EnvelopeCurve(PLANE plane) Creates an empty data object representing the RMS beam envelope for the given phase plane.
EnvelopeCurve(PLANE plane, Trajectory<EnvelopeProbeState> trjEnv) Creates the basic data object representing a curve on a graph.

Method Summary

Modifier and Type	Method and Description
void	loadCurve(Trajectory<EnvelopeProbeState> trjEnv) Defines the graphics curve according to the RMS envelope trajectory data in the given Trajectory object.

Methods inherited from class xal.extension.widgets.plot.BasicGraphData

addPoint, addPoint, addPoint, addPoint, calculateRepresentation, getCapacity, getDrawLinesOn, getDrawPointsOn, getErr, getGraphColor, getGraphDataContainer, getGraphName, getGraphPointShape, getGraphPointSize, getGraphProperty, getGraphPropertyKeys, getGraphPropertySize, getImmediateContainerUpdate, getInterpX, getInterpY, getLineThick, getLockObject, getMaxErr, getMaxX, getMaxY, getMinX, getMinY, getNumberOfGraphDataContainers, getNumbOfInterpPoints, getNumbOfPoints, getStroke, getValueDerivativeY, getValueY, getX, getY, init, isGraphPointShapeFilled, main, registerInContainer, removeAllPoints, removeContainer, removePoint, setDrawLinesOn, setDrawPointsOn, setGraphColor, setGraphName, setGraphPointFillingShape, setGraphPointShape, setGraphPointSize, setGraphProperty, setImmediateContainerUpdate, setLineDashPattern, setLineStroke, setLineThick, updateContainer, updateData, updatePoint, updatePoint, updateValues, updateValues, updateValuesY, updateValuesY, updateValueY

Methods inherited from class java.lang.Object

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

Constructor Detail

EnvelopeCurve

public EnvelopeCurve(PLANE plane)

Creates an empty data object representing the RMS beam envelope for the given phase plane. The curve object must be subsequently defined using the method loadCurve(Trajectory).

Parameters:

plane - phase plane of the rms envelope curve

Since:

Nov 26, 2012

EnvelopeCurve

public EnvelopeCurve(PLANE plane,
                     Trajectory<EnvelopeProbeState> trjEnv)
              throws java.lang.IllegalArgumentException

Creates the basic data object representing a curve on a graph. The curve is constructed from the given trajectory data for the given phase plane.

Parameters:

plane - phase plane of the rms envelope curve

trjEnv - object containing the data for the curve

Throws:

java.lang.IllegalArgumentException - the argument trjEnv is not an envelope trajectory object

Since:

Nov 26, 2012

Method Detail

loadCurve

public void loadCurve(Trajectory<EnvelopeProbeState> trjEnv)
               throws java.lang.IllegalArgumentException

Defines the graphics curve according to the RMS envelope trajectory data in the given Trajectory object.

Parameters:

trjEnv - online model simulation trajectory containing curve data

Throws:

java.lang.IllegalArgumentException - the argument is not an envelope trajectory object

Since:

Nov 26, 2012