Graph.cs

Go to the documentation of this file.

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Drawing;
using System.Data;
using System.Linq;
using System.Text;
using System.Windows.Forms;
using System.Windows.Forms.DataVisualization.Charting;

namespace SeciControls.Graphing
{
    public partial class Graph : UserControl, IUpdate
    {
        private Double _maxDoubleValue = Math.Pow(10, 25);
        private const int _maxPoints = 1000;
        private DateTime _lastUpdate = new DateTime();
        private DateTime _minValue;
        private DateTime _maxValue;

        private Double _yMin = Double.NaN;
        private Double _yMax = Double.NaN;
        private Double _y2Min = Double.NaN;
        private Double _y2Max = Double.NaN;

        private Boolean _limitsBeingChanged = false;
        private Boolean _yLimitsSetManually = false;
        private Boolean _y2LimitsSetManually = false;

        private Boolean _yMinAuto = false;
        private Boolean _yMaxAuto = false;
        private Boolean _y2MinAuto = false;
        private Boolean _y2MaxAuto = false;

        private Double _ySetMin = Double.NaN;
        private Double _ySetMax = Double.NaN;
        private Double _y2SetMin = Double.NaN;
        private Double _y2SetMax = Double.NaN;

        private Seci.Definitions.GraphDefinition _graphDef;

        public Seci.Definitions.GraphDefinition GraphDef { get { return _graphDef; } }

        public Graph()
        {
            InitializeComponent();

            chart1.ChartAreas[0].CursorX.IsUserEnabled = true;
            chart1.ChartAreas[0].CursorX.IsUserSelectionEnabled = true;
            chart1.ChartAreas[0].AxisX.ScaleView.Zoomable = true;
            chart1.ChartAreas[0].AxisX.ScaleView.MinSize = 1;
            chart1.ChartAreas[0].AxisX.ScaleView.MinSizeType = DateTimeIntervalType.Minutes;
            chart1.ChartAreas[0].AxisX.ScrollBar.ButtonStyle = ScrollBarButtonStyles.None;

            chart1.ChartAreas[0].CursorY.IsUserEnabled = true;
            chart1.ChartAreas[0].CursorY.IsUserSelectionEnabled = true;
            chart1.ChartAreas[0].AxisY.ScaleView.Zoomable = true;
            chart1.ChartAreas[0].AxisY.ScaleView.MinSize = 1;
            chart1.ChartAreas[0].AxisY.ScaleView.MinSizeType = DateTimeIntervalType.Auto;
            chart1.ChartAreas[0].AxisY.ScrollBar.ButtonStyle = ScrollBarButtonStyles.None;

            chart1.ChartAreas[0].AxisY2.ScaleView.Zoomable = true;
            chart1.ChartAreas[0].AxisY2.ScaleView.MinSize = 1;
            chart1.ChartAreas[0].AxisY2.ScaleView.MinSizeType = DateTimeIntervalType.Auto;
            chart1.ChartAreas[0].AxisY2.ScrollBar.ButtonStyle = ScrollBarButtonStyles.None;

            chart1.ChartAreas[0].CursorX.Interval = 0; //Zooming does not work on x-axis without this being set for some reason - y axis is fine without
            chart1.ChartAreas[0].CursorY.Interval = 0.001; //However, this stops the labels printing to 10 dps
        }

        public void SetupGraph(Seci.Definitions.GraphDefinition graphDef)
        {
            _lastUpdate = new DateTime();
            _graphDef = graphDef;

            // Predefine the viewing area of the chart
            _minValue = DateTime.Now;
            _maxValue = _minValue.AddSeconds(120);

            //Main appearance
            chart1.Titles.Clear();
            chart1.Titles.Add(_graphDef.Title);
            chart1.ChartAreas[0].BackGradientStyle = GradientStyle.TopBottom;
            chart1.ChartAreas[0].BackColor = Color.AliceBlue;
            chart1.ChartAreas[0].BorderDashStyle = ChartDashStyle.Solid;
            chart1.ChartAreas[0].BorderColor = Color.Gray;

            //Standard axis appearance
            chart1.ChartAreas[0].AxisX.MajorGrid.Enabled = false;
            chart1.ChartAreas[0].AxisX.LineColor = Color.Gray;
            chart1.ChartAreas[0].AxisX.MajorTickMark.LineColor = Color.Gray;
            chart1.ChartAreas[0].AxisY.MajorGrid.Enabled = false;
            chart1.ChartAreas[0].AxisY.LineColor = Color.Gray;
            chart1.ChartAreas[0].AxisY.MajorTickMark.LineColor = Color.Gray;
            chart1.ChartAreas[0].AxisY2.MajorGrid.Enabled = false;
            chart1.ChartAreas[0].AxisY2.LineColor = Color.Gray;
            chart1.ChartAreas[0].AxisY2.MajorTickMark.LineColor = Color.Gray;

            //Legend appearance
            chart1.Legends[0].Enabled = true;
            //chart1.Legends[0].BorderColor = Color.Gray;
            chart1.Legends[0].LegendStyle = LegendStyle.Row;
            chart1.Legends[0].Docking = Docking.Top;

            chart1.ChartAreas[0].AxisX.Minimum = _minValue.ToOADate();
            chart1.ChartAreas[0].AxisX.Maximum = _maxValue.ToOADate();
            chart1.ChartAreas[0].AxisX.LabelStyle.Format = "HH:mm:ss";
            chart1.ChartAreas[0].AxisX.Title = "Time";
            chart1.ChartAreas[0].AxisY.Title = _graphDef.YLabel;

            if (_graphDef.ShowZeroY1)
            {
                chart1.ChartAreas[0].AxisY.Minimum = 0;
                chart1.ChartAreas[0].AxisY.Maximum = 1;
                _yMinAuto = true;
                _yMaxAuto = true;
            }

            if (_graphDef.ShowZeroY2)
            {
                chart1.ChartAreas[0].AxisY2.Minimum = 0;
                chart1.ChartAreas[0].AxisY.Maximum = 1;
                y2AxisToolStripMenuItem.Enabled = true;
                _y2MinAuto = true;
                _y2MaxAuto = true;
            }

            if (!String.IsNullOrEmpty(_graphDef.Y2Label))
            {
                chart1.ChartAreas[0].AxisY2.Title = _graphDef.Y2Label;
                chart1.ChartAreas[0].AxisY2.Enabled = AxisEnabled.False; //Only show it if a plot uses it
            }

            chart1.Series.Clear();

            foreach (Seci.Definitions.PlotDefinition plot in _graphDef.Plots)
            {
                addPlot(plot.BlockName, plot.UseY2);
            }
        }

        private void addPlot(string blockname, Boolean useY2)
        {
            foreach (Series series in chart1.Series)
            {
                if (series.Name.ToLower() == blockname.ToLower())
                {
                    //Don't add duplicates
                    return;
                }
            }

            Series series1 = new Series(blockname);
            series1.ChartType = SeriesChartType.FastLine;
            series1.BorderWidth = 3;
            series1.XValueType = ChartValueType.DateTime;
            if (useY2)
            {
                chart1.ChartAreas[0].AxisY2.Enabled = AxisEnabled.True;
                series1.YAxisType = AxisType.Secondary;
            }
            chart1.Series.Add(series1);

            setPlotColours();
        }

        private void setPlotColours()
        {
            for (int i = 0; i < chart1.Series.Count; ++i)
            {
                switch (i)
                {
                    case 0:
                        chart1.Series[i].Color = Color.Red; //Plot 1
                        break;
                    case 1:
                        chart1.Series[i].Color = Color.Blue; //Plot 2
                        break;
                    case 2:
                        chart1.Series[i].Color = Color.Purple; //Plot 3
                        break;
                    case 3:
                        chart1.Series[i].Color = Color.Goldenrod; //Plot 4
                        break;
                    default:
                        chart1.Series[i].Color = Color.Black; //Others
                        break;
                }
            }
        }

        public void RemoveAllPlots()
        {
            chart1.Series.Clear();
        }

        private void addDataPoint(Series series, DateTime time, double value)
        {
            if (Math.Abs(value) > _maxDoubleValue)
            {
                //Do not plot it or the graph will crash
                return;
            }

            try
            {
                series.Points.AddXY(time.ToOADate(), value);
            }
            catch
            {
            }

            while (series.Points.Count > _maxPoints)
            {
                series.Points.RemoveAt(0);
            }
        }

        private void adjustXaxisRange()
        {
            double minX = -1;
            double maxX = -1;

            foreach (Series series in chart1.Series)
            {
                if (series.Points != null && series.Points.Count > 0)
                {
                    if (minX == -1 || series.Points[0].XValue < minX) minX = series.Points[0].XValue;
                    if (maxX == -1 || series.Points[series.Points.Count - 1].XValue > maxX) maxX = series.Points[series.Points.Count - 1].XValue;
                }
            }
            chart1.ChartAreas[0].AxisX.Minimum = minX;
            chart1.ChartAreas[0].AxisX.Maximum = maxX;
        }

        public void ClearAllPlotData()
        {
            foreach (Series series in chart1.Series)
            {
                series.Points.Clear();
            }
            _yMin = Double.NaN;
            _yMax = Double.NaN;
            _y2Min = Double.NaN;
            _y2Max = Double.NaN;
        }

        private void checkYRange(Series series, double value)
        {
            if (series.YAxisType == AxisType.Primary)
            {
                if (_yLimitsSetManually)
                {
                    //Still log the max and min even if they are not shown
                    setYRange(chart1.ChartAreas[0].AxisY, ref _yMin, ref _yMax, value, false);

                    ySetManualLimits();
                }
                else if (!_graphDef.ShowZeroY1)
                {
                    setYRange(chart1.ChartAreas[0].AxisY, ref _yMin, ref _yMax, value, !_limitsBeingChanged);
                }
                else
                {
                    setYRange(chart1.ChartAreas[0].AxisY, ref _yMin, ref _yMax, value, !_limitsBeingChanged);
                    if (_yMin != _yMax && !_limitsBeingChanged)
                    {
                        chart1.ChartAreas[0].AxisY.Minimum = Double.NaN;
                        chart1.ChartAreas[0].AxisY.Maximum = Double.NaN;
                    }
                }
            }
            else if (series.YAxisType == AxisType.Secondary)
            {
                if (_y2LimitsSetManually)
                {
                    //Still log the max and min even if they are not shown
                    setYRange(chart1.ChartAreas[0].AxisY2, ref _y2Min, ref _y2Max, value, false);

                    y2SetManualLimits();
                }
                else if (!_graphDef.ShowZeroY2)
                {
                    setYRange(chart1.ChartAreas[0].AxisY2, ref _y2Min, ref _y2Max, value, !_limitsBeingChanged);
                }
                else
                {
                    setYRange(chart1.ChartAreas[0].AxisY2, ref _y2Min, ref _y2Max, value, !_limitsBeingChanged);
                    if (_y2Min != _y2Max && !_limitsBeingChanged)
                    {
                        chart1.ChartAreas[0].AxisY2.Minimum = Double.NaN;
                        chart1.ChartAreas[0].AxisY2.Maximum = Double.NaN;
                    }
                }
            }
        }

        private void y2SetManualLimits()
        {
            if ((_y2MinAuto || _y2MaxAuto) && _y2Min == _y2Max)
            {
                chart1.ChartAreas[0].AxisY2.Maximum = _y2Min + 1;
                chart1.ChartAreas[0].AxisY2.Minimum = _y2Min - 1;
            }
            else if (_y2MaxAuto && _y2MinAuto)
            {
                chart1.ChartAreas[0].AxisY2.Maximum = Double.NaN;
                chart1.ChartAreas[0].AxisY2.Minimum = Double.NaN;
            }
            else if (_y2MinAuto)
            {
                chart1.ChartAreas[0].AxisY2.Minimum = Double.NaN;
                chart1.ChartAreas[0].AxisY2.Maximum = _y2SetMax;
            }
            else if (_y2MaxAuto)
            {
                chart1.ChartAreas[0].AxisY2.Maximum = Double.NaN;
                chart1.ChartAreas[0].AxisY2.Minimum = _y2SetMin;
            }
        }

        private void ySetManualLimits()
        {
            if ((_yMinAuto || _yMaxAuto) && _yMin == _yMax)
            {
                chart1.ChartAreas[0].AxisY.Maximum = _yMin + 1;
                chart1.ChartAreas[0].AxisY.Minimum = _yMin - 1;
            }
            else if (_yMaxAuto && _yMinAuto)
            {
                chart1.ChartAreas[0].AxisY.Maximum = Double.NaN;
                chart1.ChartAreas[0].AxisY.Minimum = Double.NaN;
            }
            else if (_yMinAuto)
            {
                chart1.ChartAreas[0].AxisY.Minimum = Double.NaN;
                chart1.ChartAreas[0].AxisY.Maximum = _ySetMax;
            }
            else if (_yMaxAuto)
            {
                chart1.ChartAreas[0].AxisY.Maximum = Double.NaN;
                chart1.ChartAreas[0].AxisY.Minimum = _ySetMin;
            }
        }

        private Double findMinimum(Double min, Double value)
        {
            if (Double.IsNaN(min))
            {
                return value;
            }
            else if (value < min)
            {
                return value;
            }

            return min;
        }

        private Double findMaximum(Double max, Double value)
        {
            if (Double.IsNaN(max))
            {
                return value;
            }
            else if (value > max)
            {
                return value;
            }

            return max;
        }

        private void setYRange(Axis axis, ref Double min, ref Double max, Double value, Boolean setAxis)
        {
            min = findMinimum(min, value);
            max = findMaximum(max, value);

            if (setAxis)
            {
                if (min == max)
                {
                    axis.Minimum = min - 1;
                    axis.Maximum = max + 1;
                }
                else
                {
                    axis.Minimum = min;
                    axis.Maximum = max;
                }
            }
        }

        #region IUpdate Members

        public void UpdateControl()
        {
            DateTime time = DateTime.Now;

            if (time >= _lastUpdate.AddSeconds(_graphDef.UpdateRate))
            {
                _lastUpdate = time;

                foreach (Series series in chart1.Series)
                {
                    double result;

                    try
                    {

                        if (series.Name.EndsWith(" (Setpoint)"))
                        {
                            if (Double.TryParse(Seci.Managers.BlockMgr.GetBlockSetpoint(series.Name.Substring(0, series.Name.IndexOf(" (Setpoint)"))), out result))
                            {
                                addDataPoint(series, time, result);
                                checkYRange(series, result);
                            }
                        }
                        else
                        {
                            if (Double.TryParse(Seci.Managers.BlockMgr.GetBlockValue(series.Name), out result))
                            {
                                addDataPoint(series, time, result);
                                checkYRange(series, result);
                            }
                        }
                    }
                    catch
                    {
                        //Just incase something goes wrong with the parsing.
                    }
                }

                adjustXaxisRange();
                chart1.Invalidate();
            }
        }

        #endregion

        private void autoScaleToolStripMenuItem_Click(object sender, EventArgs e)
        {
            chart1.ChartAreas[0].AxisX.ScaleView.ZoomReset(0);
            chart1.ChartAreas[0].AxisY.ScaleView.ZoomReset(0);
            chart1.ChartAreas[0].AxisY2.ScaleView.ZoomReset(0);
        }

        private void clearPointsToolStripMenuItem_Click(object sender, EventArgs e)
        {
            ClearAllPlotData();
        }

        private void setLimitsXToolStripMenuItem(object sender, EventArgs e)
        {
            //Not implemented
        }

        private void autoScaleXToolStripMenuItem_Click(object sender, EventArgs e)
        {
            //Not implemented
        }

        private void setLimitsYToolStripMenuItem_Click(object sender, EventArgs e)
        {
            GraphLimitsDialog limits = new GraphLimitsDialog();
            _limitsBeingChanged = true;
            limits.Min = chart1.ChartAreas[0].AxisY.Minimum;
            limits.Max = chart1.ChartAreas[0].AxisY.Maximum;
            if (_yMinAuto) limits.Min = Double.NaN;
            if (_yMaxAuto) limits.Max = Double.NaN;

            if (limits.ShowDialog() == DialogResult.OK)
            {
                _yLimitsSetManually = true;
                _ySetMin = limits.Min;
                _ySetMax = limits.Max;
                chart1.ChartAreas[0].AxisY.Minimum = limits.Min;
                chart1.ChartAreas[0].AxisY.Maximum = limits.Max;
                _yMinAuto = Double.IsNaN(limits.Min);
                _yMaxAuto = Double.IsNaN(limits.Max);
                ySetManualLimits();
            }
            _limitsBeingChanged = false;
        }

        private void autoScaleYToolStripMenuItem_Click(object sender, EventArgs e)
        {
            _yLimitsSetManually = false;
            _ySetMin = Double.NaN;
            _ySetMax = Double.NaN;
        }

        private void setLimitsY2ToolStripMenuItem_Click(object sender, EventArgs e)
        {
            GraphLimitsDialog limits = new GraphLimitsDialog();
            _limitsBeingChanged = true;
            limits.Min = chart1.ChartAreas[0].AxisY2.Minimum;
            limits.Max = chart1.ChartAreas[0].AxisY2.Maximum;
            if (_y2MinAuto) limits.Min = Double.NaN;
            if (_y2MaxAuto) limits.Max = Double.NaN;

            if (limits.ShowDialog() == DialogResult.OK)
            {
                _y2LimitsSetManually = true;
                _y2SetMin = limits.Min;
                _y2SetMax = limits.Max;
                chart1.ChartAreas[0].AxisY2.Minimum = limits.Min;
                chart1.ChartAreas[0].AxisY2.Maximum = limits.Max;
                _y2MinAuto = Double.IsNaN(limits.Min);
                _y2MaxAuto = Double.IsNaN(limits.Max);
                y2SetManualLimits();
            }
            _limitsBeingChanged = false;
        }

        private void autoScaleY2ToolStripMenuItem_Click(object sender, EventArgs e)
        {
            _y2LimitsSetManually = false;
            _y2SetMin = Double.NaN;
            _y2SetMax = Double.NaN;
        }
    }
}