|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.quinncurtis.chart2djava.ChartObj
com.quinncurtis.spcchartjava.SPCChartObjects
public class SPCChartObjects
The SPCChartObjects class holds all of the chart objects associated with a single SPC chart. These objects include objects for data, a coordinate system, titles, axes, axes labels, grids, line and scatter plots. It also includes a FrequencyHistogramChart for displaying an adjunct histogram for monitoring the distribution of the related data values. Two SPCChartObjects objects are included in the SPCChartObject base class to manage the two possible charts in a variable control chart.
Field Summary | |
---|---|
static int |
CALCULATED_VALUE_SOURCE
Specifies that the source of the data in the chart is a calculated value (or measurement) data. |
static int |
CONTROL_LINE_DISABLE
Disable drawing of control line in the chart. |
static int |
CONTROL_LINE_FIXED
Draw control line as a fixed horizontal line in the chart. |
static int |
CONTROL_LINE_VARIABLE
Draw control line as a variable line in the chart. |
static int |
PRIMARY_CHART
Specifies the primary chart. |
static int |
SAMPLED_VALUE_SOURCE
Specifies that the source of the data in the chart is sampled (or measurement) data. |
static int |
SECONDARY_CHART
Specifies the secondary chart. |
static int |
SPC_CONTROL_LABEL_INSIDE_PLOTAREA
Specifies that numeric label for a control limit is placed inside the plot area of the chart. |
static int |
SPC_CONTROL_LABEL_OUTSIDE_PLOTAREA
Specifies that numeric label for a control limit is placed outside (to the right of) the plot area of the chart. |
static int |
SPC_CONTROL_TARGET
Index of target control limit in controlLimitData array. |
static int |
SPC_LOWER_CONTROL_LIMIT
Index of lower control limit in controlLimitData array. |
static int |
SPC_LOWER_CONTROL_LIMIT_0
Index of lower control limit in controlLimitData array. |
static int |
SPC_LOWER_CONTROL_LIMIT_1
Index of lower control limit in controlLimitData array. |
static int |
SPC_LOWER_CONTROL_LIMIT_2
Index of lower control limit in controlLimitData array. |
static int |
SPC_LOWER_CONTROL_LIMIT_3
Index of lower control limit in controlLimitData array. |
static int |
SPC_MEASURED_VARIABLE
Index of measured (or sampled) control limit in controlLimitData array (unused). |
static int |
SPC_SAMPLED_DATA
Index of sampled data in controlLimitData array. |
static int |
SPC_UPPER_CONTROL_LIMIT
Index of upper control limit in controlLimitData array. |
static int |
SPC_UPPER_CONTROL_LIMIT_0
Index of upper control limit in controlLimitData array. |
static int |
SPC_UPPER_CONTROL_LIMIT_1
Index of upper control limit in controlLimitData array. |
static int |
SPC_UPPER_CONTROL_LIMIT_2
Index of upper control limit in controlLimitData array. |
static int |
SPC_UPPER_CONTROL_LIMIT_3
Index of upper control limit in controlLimitData array. |
Constructor Summary | |
---|---|
SPCChartObjects()
Default constructor for the class. |
|
SPCChartObjects(SPCChartBase spcchartbase)
Constructor initializes parent object. |
|
SPCChartObjects(SPCChartBase spcchartbase,
int chartpos)
Constructor initializes parent object. |
Method Summary | |
---|---|
int |
addAdditionalControlLimit(SPCControlLimitRecord spccontrollimit,
int limittype,
double sigma)
Initialize the class |
int |
addAdditionalControlLimit(SPCControlLimitRecord spccontrollimit,
int limittype,
double sigma,
boolean addlines)
Initialize the class |
int |
addControlLimit(SPCControlLimitRecord controllimitrecord,
int controllimittype,
double sigmalevel)
Add a control limit to the controlLimitData array. |
java.lang.Object |
clone()
Returns an object that is a clone of this object. |
void |
copy(SPCChartObjects source)
Copies the source object. |
void |
enableControlLimitItem(int item,
boolean enable)
Enable/Disable a specific control limit item. |
java.util.Vector<ChartText> |
getAnnotationArray()
Get the array of TextObject objects, representing the annotations of the chart. |
static java.awt.Font |
getAnnotationFont()
Get annotation font. |
ChartPoint2D |
getAnnotationNudge()
Get the x and y-values use to offset a data points annotation with respect to the actual data point. |
java.util.Vector<SimpleDataset> |
getAutoScaleVector()
Get the array of all of the datasets used in the graph, used in the auto-scale routines. |
static java.awt.Font |
getAxisLabelFont()
Get the font used to label the x- and y- axes. |
static java.awt.Font |
getAxisTitleFont()
Get the font used for the axes titles. |
int |
getBatchIncrement()
Get increment between adjacent samples of batch type charts that use a numeric x-scale. |
int |
getBatchStartValue()
Get the starting numeric value of the x-scale for batch type charts that use a numeric x-scale. |
int |
getBatchStopValue()
Get the ending numeric value of the x-scale for batch type charts that use a numeric x-scale. |
int |
getChartPosition()
Get the current chart type. |
int |
getChartValueIndex()
Get the index of the variable used as the source of the SPC data in the chart. |
int |
getChartValueSource()
Get the source of SPC data plotted in the chart. |
int |
getControlLabelPosition()
Get that numeric label for a control limit is placed inside, or outside the plot area INSIDE_PLOTAREA. |
java.util.Vector<SPCControlPlotObjectData> |
getControlLimitData()
Get the array of the plot objects associated with control limits. |
SPCControlPlotObjectData |
getControlLimitData(int index)
Get control limit data associated with a specfic index in the controlLimitData array. |
static java.awt.Font |
getControlLimitLabelFont()
Get annotation font. |
int |
getControlLineMode()
Set/Get the control line mode. |
SPCDataToolTip |
getDatatooltip()
Get a reference to the charts tooltip. |
java.awt.Color |
getDefaultGraphBackgroundColor()
Get the default background color for the graph area. |
int |
getDefaultNumberControlLimits()
Get the number of control limits in the chart. |
java.awt.Color |
getDefaultPlotBackgroundColor()
Get the default background color for the plot area. |
boolean |
getDisplayChart()
Set to true to enable the drawing of this chart. |
boolean |
getDisplayFrequencyHistogram()
Set to true to enable the drawing of the frequency histogram attached to the chart. |
ChartTitle |
getFooter()
Get a reference to the charts subhead. |
static java.awt.Font |
getFooterFont()
Get the font used for the chart subhead. |
FrequencyHistogramChart |
getFrequencyHistogramChart()
Get a reference to the optional frequency histogram attached to the chart. |
Background |
getGraphBackground()
Get a reference to the charts graph background object. |
double |
getHistogramMinWidth()
Get the minimum width of the histogram chart, using normalized coordinates, of the frequency histogram plotting area. |
double |
getHistogramOffset()
Get the offset of the frequency histogram plotting area with respect to the GraphStartPosX value. |
double |
getHistogramStartPos()
Get the left edge, using normalized coordinates, of the frequency histogram plotting area. |
ChartTitle |
getMainTitle()
Get a reference to the charts mainTitle. |
static java.awt.Font |
getMainTitleFont()
Get the font used for the chart title. |
double |
getMaxY()
Get the maximum value used to scale the y-axis of the chart. |
double |
getMinY()
Get the minimum value used to scale the y-axis of the chart. |
SPCChartBase |
getParentSPCChartBase()
Get that parent SPCChartBase object. |
Background |
getPlotBackground()
Get a reference to the charts plot background object. |
PhysicalCoordinates |
getPPhysTransform1()
Gets a reference to the charts physical coordinate system. |
SPCControlPlotObjectData |
getProcessVariableData()
Holds a reference to an object encapsulating the plot object data associated with the main variable of the chart. |
SPCControlPlotObjectData |
getProcessVariableData2()
Holds a reference to an object encapsulating the plot object data associated with the secondary variable of the chart. |
java.util.Vector<SPCControlPlotObjectData> |
getSampledDataData()
Get the array of the sample data. |
SPCControlPlotObjectData |
getSampledDataData(int index)
Get the sampled data data associated with a specfic index in the sampledDataData array. |
ChartTitle |
getSubHead()
Get a reference to the charts subhead. |
static java.awt.Font |
getSubHeadFont()
Get the font used for the chart subhead. |
ChartText |
getTextTemplate()
Get the text template for the data tooltip. |
int |
getTimeIncrementMinutes()
Get the increment between adjacent samples of charts that use a numeric x-scale. |
static java.awt.Font |
getToolTipFont()
Get tool tip font. |
ChartSymbol |
getToolTipSymbol()
Get a reference to the charts tooltip symbol. |
Axis |
getXAxis()
Get a reference to the charts x-axis. |
AxisLabels |
getXAxisLab()
Get a reference to the charts x-axis labels. |
AxisTitle |
getXAxisTitle()
Get a reference to the charts left y-axis title. |
Grid |
getXGrid()
Get a reference to the charts x-axis grid. |
NumericLabel |
getXValueTemplate()
Get the x-value template for the data tooltip. |
void |
getXValueTemplate(NumericLabel value)
Get the x-value template for the data tooltip. |
LinearAxis |
getYAxis1()
Get a reference to the charts left y-axis. |
LinearAxis |
getYAxis2()
Get a reference to the charts right y-axis. |
NumericAxisLabels |
getYAxisLab()
Get a reference to the charts left y-axis labels. |
AxisTitle |
getYAxisTitle()
Get a reference to the charts left y-axis title. |
Grid |
getYGrid()
Get a reference to the charts y-axis grid. |
NumericLabel |
getYValueTemplate()
Get the y-value template for the data tooltip. |
void |
initSPCChartObjects()
Initialize the class |
void |
reset()
Reset the datasets of the SPCChartObjects class. |
static void |
setAnnotationFont(java.awt.Font value)
Set annotation font. |
static void |
setAxisLabelFont(java.awt.Font value)
Set the font used to label the x- and y- axes. |
static void |
setAxisTitleFont(java.awt.Font value)
Set the font used for the axes titles. |
void |
setBatchStartValue(int value)
Set the starting numeric value of the x-scale for batch type charts that use a numeric x-scale. |
void |
setBatchStopValue(int value)
Set the ending numeric value of the x-scale for batch type charts that use a numeric x-scale. |
void |
setChartPosition(int value)
Set the current chart type. |
void |
setChartValueIndex(int value)
Set/Get the index of the variable used as the source of the SPC data in the chart. |
void |
setChartValueSource(int value)
Set the source of SPC data plotted in the chart. |
void |
setControlLabelPosition(int value)
Set that numeric label for a control limit is placed inside, or outside the plot area INSIDE_PLOTAREA. |
static void |
setControlLimitLabelFont(java.awt.Font value)
Set annotation font. |
void |
setControlLimitsLabelFont(java.awt.Font limitfont)
Allows for late change of all of the control limits label fonts. |
void |
setControlLineMode(int value)
Set/Get the control line mode. |
void |
setDefaultGraphBackgroundColor(java.awt.Color value)
Set the default background color for the graph area. |
void |
setDefaultNumberControlLimits(int value)
Set the number of control limits in the chart. |
void |
setDefaultPlotBackgroundColor(java.awt.Color value)
Set the default background color for the plot area. |
void |
setDisplayChart(boolean value)
Set to true to enable the drawing of this chart. |
void |
setDisplayFrequencyHistogram(boolean value)
Set to true to enable the drawing of the frequency histogram attached to the chart. |
static void |
setFooterFont(java.awt.Font value)
Set the font used for the chart subhead. |
void |
setHistogramMinWidth(double value)
Set the minimum width of the histogram chart, using normalized coordinates, of the frequency histogram plotting area. |
void |
setHistogramOffset(double value)
Set the offset of the frequency histogram plotting area with respect to the GraphStartPosX value. |
void |
setHistogramStartPos(double value)
Set the left edge, using normalized coordinates, of the frequency histogram plotting area. |
static void |
setMainTitleFont(java.awt.Font value)
Set the font used for the chart title. |
void |
setMaxY(double value)
Set the maximum value used to scale the y-axis of the chart. |
void |
setMinY(double value)
Set the minimum value used to scale the y-axis of the chart. |
void |
setParentSPCChartBase(SPCChartBase value)
Set that parent SPCChartBase object. |
void |
setPlotMeasurementValues(boolean value)
Set to true to enable the plotting of all sampled values, as a scatter plot, in additon to the mean or median values. |
static void |
setSubHeadFont(java.awt.Font value)
Set the font used for the chart subhead. |
void |
setTextTemplate(ChartText value)
Set the text template for the data tooltip. |
void |
setTimeIncrementMinutes(int value)
Set the increment between adjacent samples of charts that use a numeric x-scale. |
static void |
setToolTipFont(java.awt.Font value)
Set tool tip font. |
void |
setYValueTemplate(NumericLabel value)
Set the y-value template for the data tooltip. |
void |
useWERuntimeRules()
Use Western Electric Runtime Rules when checking for alarm conditions. |
Methods inherited from class com.quinncurtis.chart2djava.ChartObj |
---|
copy, errorCheck, getChartObjIDCntr, getChartObjType, getThisChartObjID, TypeSafeVectorCopy |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int CALCULATED_VALUE_SOURCE
public static final int CONTROL_LINE_DISABLE
public static final int CONTROL_LINE_FIXED
public static final int CONTROL_LINE_VARIABLE
public static final int PRIMARY_CHART
public static final int SAMPLED_VALUE_SOURCE
public static final int SECONDARY_CHART
public static final int SPC_CONTROL_LABEL_INSIDE_PLOTAREA
public static final int SPC_CONTROL_LABEL_OUTSIDE_PLOTAREA
public static final int SPC_CONTROL_TARGET
public static final int SPC_LOWER_CONTROL_LIMIT
public static final int SPC_LOWER_CONTROL_LIMIT_0
public static final int SPC_LOWER_CONTROL_LIMIT_1
public static final int SPC_LOWER_CONTROL_LIMIT_2
public static final int SPC_LOWER_CONTROL_LIMIT_3
public static final int SPC_MEASURED_VARIABLE
public static final int SPC_SAMPLED_DATA
public static final int SPC_UPPER_CONTROL_LIMIT
public static final int SPC_UPPER_CONTROL_LIMIT_0
public static final int SPC_UPPER_CONTROL_LIMIT_1
public static final int SPC_UPPER_CONTROL_LIMIT_2
public static final int SPC_UPPER_CONTROL_LIMIT_3
Constructor Detail |
---|
public SPCChartObjects()
public SPCChartObjects(SPCChartBase spcchartbase)
public SPCChartObjects(SPCChartBase spcchartbase, int chartpos)
Method Detail |
---|
public int addAdditionalControlLimit(SPCControlLimitRecord spccontrollimit, int limittype, double sigma)
public int addAdditionalControlLimit(SPCControlLimitRecord spccontrollimit, int limittype, double sigma, boolean addlines)
public int addControlLimit(SPCControlLimitRecord controllimitrecord, int controllimittype, double sigmalevel)
public java.lang.Object clone()
clone
in class java.lang.Object
public void copy(SPCChartObjects source)
source
- The source object.public void enableControlLimitItem(int item, boolean enable)
item
- The control limit item.enable
- Set to true to enable.public java.util.Vector<ChartText> getAnnotationArray()
public static java.awt.Font getAnnotationFont()
public ChartPoint2D getAnnotationNudge()
public java.util.Vector<SimpleDataset> getAutoScaleVector()
public static java.awt.Font getAxisLabelFont()
public static java.awt.Font getAxisTitleFont()
public int getBatchIncrement()
public int getBatchStartValue()
public int getBatchStopValue()
public int getChartPosition()
public int getChartValueIndex()
public int getChartValueSource()
public int getControlLabelPosition()
public java.util.Vector<SPCControlPlotObjectData> getControlLimitData()
public SPCControlPlotObjectData getControlLimitData(int index)
public static java.awt.Font getControlLimitLabelFont()
public int getControlLineMode()
public SPCDataToolTip getDatatooltip()
public java.awt.Color getDefaultGraphBackgroundColor()
public int getDefaultNumberControlLimits()
public java.awt.Color getDefaultPlotBackgroundColor()
public boolean getDisplayChart()
public boolean getDisplayFrequencyHistogram()
public ChartTitle getFooter()
public static java.awt.Font getFooterFont()
public FrequencyHistogramChart getFrequencyHistogramChart()
public Background getGraphBackground()
public double getHistogramMinWidth()
public double getHistogramOffset()
public double getHistogramStartPos()
public ChartTitle getMainTitle()
public static java.awt.Font getMainTitleFont()
public double getMaxY()
public double getMinY()
public SPCChartBase getParentSPCChartBase()
public Background getPlotBackground()
public PhysicalCoordinates getPPhysTransform1()
public SPCControlPlotObjectData getProcessVariableData()
public SPCControlPlotObjectData getProcessVariableData2()
public java.util.Vector<SPCControlPlotObjectData> getSampledDataData()
public SPCControlPlotObjectData getSampledDataData(int index)
public ChartTitle getSubHead()
public static java.awt.Font getSubHeadFont()
public ChartText getTextTemplate()
public int getTimeIncrementMinutes()
public static java.awt.Font getToolTipFont()
public ChartSymbol getToolTipSymbol()
public Axis getXAxis()
public AxisLabels getXAxisLab()
public AxisTitle getXAxisTitle()
public Grid getXGrid()
public NumericLabel getXValueTemplate()
public void getXValueTemplate(NumericLabel value)
public LinearAxis getYAxis1()
public LinearAxis getYAxis2()
public NumericAxisLabels getYAxisLab()
public AxisTitle getYAxisTitle()
public Grid getYGrid()
public NumericLabel getYValueTemplate()
public void initSPCChartObjects()
public void reset()
public static void setAnnotationFont(java.awt.Font value)
public static void setAxisLabelFont(java.awt.Font value)
public static void setAxisTitleFont(java.awt.Font value)
public void setBatchStartValue(int value)
public void setBatchStopValue(int value)
public void setChartPosition(int value)
public void setChartValueIndex(int value)
public void setChartValueSource(int value)
public void setControlLabelPosition(int value)
public static void setControlLimitLabelFont(java.awt.Font value)
public void setControlLimitsLabelFont(java.awt.Font limitfont)
public void setControlLineMode(int value)
public void setDefaultGraphBackgroundColor(java.awt.Color value)
public void setDefaultNumberControlLimits(int value)
public void setDefaultPlotBackgroundColor(java.awt.Color value)
public void setDisplayChart(boolean value)
public void setDisplayFrequencyHistogram(boolean value)
public static void setFooterFont(java.awt.Font value)
public void setHistogramMinWidth(double value)
public void setHistogramOffset(double value)
public void setHistogramStartPos(double value)
public static void setMainTitleFont(java.awt.Font value)
public void setMaxY(double value)
public void setMinY(double value)
public void setParentSPCChartBase(SPCChartBase value)
public void setPlotMeasurementValues(boolean value)
public static void setSubHeadFont(java.awt.Font value)
public void setTextTemplate(ChartText value)
public void setTimeIncrementMinutes(int value)
public static void setToolTipFont(java.awt.Font value)
public void setYValueTemplate(NumericLabel value)
public void useWERuntimeRules()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |