GraphicViewer.py
author laurent
Wed, 15 Feb 2012 00:25:05 +0100
changeset 642 f2325ebd67f4
parent 640 c32c169b8f63
child 648 95d165193770
permissions -rw-r--r--
Fixed wrong time scale in debug graph display when some samples are missed
#!/usr/bin/env python
# -*- coding: utf-8 -*-

#This file is part of PLCOpenEditor, a library implementing an IEC 61131-3 editor
#based on the plcopen standard. 
#
#Copyright (C) 2007: Edouard TISSERANT and Laurent BESSARD
#
#See COPYING file for copyrights details.
#
#This library is free software; you can redistribute it and/or
#modify it under the terms of the GNU General Public
#License as published by the Free Software Foundation; either
#version 2.1 of the License, or (at your option) any later version.
#
#This library is distributed in the hope that it will be useful,
#but WITHOUT ANY WARRANTY; without even the implied warranty of
#MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
#General Public License for more details.
#
#You should have received a copy of the GNU General Public
#License along with this library; if not, write to the Free Software
#Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

import wx
import wx.lib.plot as plot
import numpy
from graphics.GraphicCommons import DebugViewer
from controls import EditorPanel

colours = ['blue', 'red', 'green', 'yellow', 'orange', 'purple', 'brown', 'cyan',
           'pink', 'grey']
markers = ['circle', 'dot', 'square', 'triangle', 'triangle_down', 'cross', 'plus', 'circle']


#-------------------------------------------------------------------------------
#                       Debug Variable Graphic Viewer class
#-------------------------------------------------------------------------------

SECOND = 1000000000
MINUTE = 60 * SECOND
HOUR = 60 * MINUTE

RANGE_VALUES = [(str(25 * 2 ** i), 25 * 2 ** i) for i in xrange(6)]
TIME_RANGE_VALUES = [("%ds" % i, i * SECOND) for i in (1, 2, 5, 10, 20, 30)] + \
                    [("%dm" % i, i * MINUTE) for i in (1, 2, 5, 10, 20, 30)] + \
                    [("%dh" % i, i * HOUR) for i in (1, 2, 3, 6, 12, 24)]

[ID_GRAPHICVIEWER, ID_GRAPHICVIEWERCANVAS,
 ID_GRAPHICVIEWERCANVASRANGE, ID_GRAPHICVIEWERCANVASPOSITION,
 ID_GRAPHICVIEWERRESETBUTTON, ID_GRAPHICVIEWERCURRENTBUTTON, 
 ID_GRAPHICVIEWERSTATICTEXT1, ID_GRAPHICVIEWERSTATICTEXT2,
] = [wx.NewId() for _init_ctrls in range(8)]

class GraphicViewer(EditorPanel, DebugViewer):

    def _init_coll_MainGridSizer_Items(self, parent):
        # generated method, don't edit
        parent.AddWindow(self.Canvas, 0, border=0, flag=wx.GROW)
        parent.AddSizer(self.RangeSizer, 0, border=0, flag=wx.GROW)
    
    def _init_coll_MainGridSizer_Growables(self, parent):
        # generated method, don't edit
        parent.AddGrowableCol(0)
        parent.AddGrowableRow(0)

    def _init_coll_RangeSizer_Items(self, parent):
        # generated method, don't edit
        parent.AddWindow(self.staticbox1, 0, border=5, flag=wx.ALIGN_CENTER_VERTICAL|wx.ALL)
        parent.AddWindow(self.CanvasRange, 0, border=5, flag=wx.ALL)
        parent.AddWindow(self.staticText2, 0, border=5, flag=wx.ALIGN_CENTER_VERTICAL|wx.ALL)
        parent.AddWindow(self.CanvasPosition, 0, border=5, flag=wx.GROW|wx.ALL)
        parent.AddWindow(self.ResetButton, 0, border=5, flag=wx.ALL)
        parent.AddWindow(self.CurrentButton, 0, border=5, flag=wx.ALL)
        
    def _init_coll_RangeSizer_Growables(self, parent):
        # generated method, don't edit
        parent.AddGrowableCol(3)
        parent.AddGrowableRow(0)
        
    def _init_sizers(self):
        # generated method, don't edit
        self.MainGridSizer = wx.FlexGridSizer(cols=1, hgap=0, rows=2, vgap=0)
        self.RangeSizer = wx.FlexGridSizer(cols=6, hgap=0, rows=1, vgap=0)

        self._init_coll_MainGridSizer_Items(self.MainGridSizer)
        self._init_coll_MainGridSizer_Growables(self.MainGridSizer)
        self._init_coll_RangeSizer_Items(self.RangeSizer)
        self._init_coll_RangeSizer_Growables(self.RangeSizer)
        
        self.Editor.SetSizer(self.MainGridSizer)
    
    def _init_Editor(self, prnt):
        self.Editor = wx.Panel(prnt, ID_GRAPHICVIEWER, wx.DefaultPosition, 
                 wx.DefaultSize, 0)
        
        self.Canvas = plot.PlotCanvas(id=ID_GRAPHICVIEWERCANVAS, 
              name='Canvas', parent=self.Editor, pos=wx.Point(0, 0),
              size=wx.Size(0, 0), style=0)
        def _axisInterval(spec, lower, upper):
            if spec == 'border':
                if lower == upper:
                    return lower - 0.5, upper + 0.5
                else:
                    border = (upper - lower) * 0.05
                    return lower - border, upper + border
            else:
                return plot.PlotCanvas._axisInterval(self.Canvas, spec, lower, upper)
        self.Canvas._axisInterval = _axisInterval
        self.Canvas.SetYSpec('border')

        self.staticbox1 = wx.StaticText(id=ID_GRAPHICVIEWERSTATICTEXT1,
              label=_('Range:'), name='staticText1', parent=self.Editor,
              pos=wx.Point(0, 0), size=wx.DefaultSize, style=0)
        
        self.CanvasRange = wx.ComboBox(id=ID_GRAPHICVIEWERCANVASRANGE,
              name='CanvasRange', parent=self.Editor, pos=wx.Point(0, 0),
              size=wx.Size(100, 28), style=wx.CB_READONLY)
        self.Bind(wx.EVT_COMBOBOX, self.OnRangeChanged, id=ID_GRAPHICVIEWERCANVASRANGE)
        
        self.staticText2 = wx.StaticText(id=ID_GRAPHICVIEWERSTATICTEXT2,
              label=_('Position:'), name='staticText2', parent=self.Editor,
              pos=wx.Point(0, 0), size=wx.DefaultSize, style=0)

        self.CanvasPosition = wx.ScrollBar(id=ID_GRAPHICVIEWERCANVASPOSITION,
              name='Position', parent=self.Editor, pos=wx.Point(0, 0),
              size=wx.Size(0, 16), style=wx.SB_HORIZONTAL)
        self.CanvasPosition.SetScrollbar(0, 10, 100, 10)
        self.CanvasPosition.Bind(wx.EVT_SCROLL_THUMBTRACK, self.OnPositionChanging, 
              id = ID_GRAPHICVIEWERCANVASPOSITION)
        self.CanvasPosition.Bind(wx.EVT_SCROLL_LINEUP, self.OnPositionChanging, 
              id = ID_GRAPHICVIEWERCANVASPOSITION)
        self.CanvasPosition.Bind(wx.EVT_SCROLL_LINEDOWN, self.OnPositionChanging, 
              id = ID_GRAPHICVIEWERCANVASPOSITION)
        self.CanvasPosition.Bind(wx.EVT_SCROLL_PAGEUP, self.OnPositionChanging, 
              id = ID_GRAPHICVIEWERCANVASPOSITION)
        self.CanvasPosition.Bind(wx.EVT_SCROLL_PAGEDOWN, self.OnPositionChanging, 
              id = ID_GRAPHICVIEWERCANVASPOSITION)
        
        self.ResetButton = wx.Button(id=ID_GRAPHICVIEWERRESETBUTTON, label='Reset',
              name='ResetButton', parent=self.Editor, pos=wx.Point(0, 0),
              size=wx.Size(72, 24), style=0)
        self.Bind(wx.EVT_BUTTON, self.OnResetButton, id=ID_GRAPHICVIEWERRESETBUTTON)
        
        self.CurrentButton = wx.Button(id=ID_GRAPHICVIEWERCURRENTBUTTON, label='Current',
              name='CurrentButton', parent=self.Editor, pos=wx.Point(0, 0),
              size=wx.Size(72, 24), style=0)
        self.Bind(wx.EVT_BUTTON, self.OnCurrentButton, id=ID_GRAPHICVIEWERCURRENTBUTTON)
        
        self._init_sizers()

    def __init__(self, parent, window, producer, instancepath = ""):
        EditorPanel.__init__(self, parent, "", window, None)
        DebugViewer.__init__(self, producer, True, False)
        
        self.InstancePath = instancepath
        self.RangeValues = None
        
        self.Datas = []
        self.StartValue = 0
        self.EndValue = 0
        self.Fixed = False
        self.Ticktime = self.DataProducer.GetTicktime()
        self.RefreshCanvasRange()
        
        self.AddDataConsumer(self.InstancePath.upper(), self)
    
    def __del__(self):
        DebugViewer.__del__(self)
        self.RemoveDataConsumer(self)
    
    def GetTitle(self):
        if len(self.InstancePath) > 15:
            return "..." + self.InstancePath[-12:]
        return self.InstancePath
    
    def ResetView(self):
        self.Datas = []
        self.StartValue = 0
        self.EndValue = 0
        self.Fixed = False
        self.Ticktime = self.DataProducer.GetTicktime()
        self.RefreshCanvasRange()
        self.RefreshView()
    
    def RefreshNewData(self, *args, **kwargs):
        self.RefreshView(*args, **kwargs)
        DebugViewer.RefreshNewData(self)
    
    def RefreshCanvasRange(self):
        if self.Ticktime == 0 and self.RangeValues != RANGE_VALUES:
            self.RangeValues = RANGE_VALUES
            self.RangeValues_dict = dict(RANGE_VALUES)
            self.CanvasRange.Clear()
            for text, value in RANGE_VALUES:
                self.CanvasRange.Append(text)
            self.CanvasRange.SetStringSelection(RANGE_VALUES[0][0])
            self.CurrentRange = RANGE_VALUES[0][1]
        elif self.RangeValues != TIME_RANGE_VALUES:
            self.RangeValues = TIME_RANGE_VALUES
            self.RangeValues_dict = dict(TIME_RANGE_VALUES)
            self.CanvasRange.Clear()
            for text, value in TIME_RANGE_VALUES:
                self.CanvasRange.Append(text)
            self.CanvasRange.SetStringSelection(TIME_RANGE_VALUES[0][0])
            self.CurrentRange = TIME_RANGE_VALUES[0][1] / self.Ticktime
        
    def RefreshView(self, force=True):
        self.Freeze()
        if force or not self.Fixed:
            var_name = self.InstancePath.split(".")[-1]
            
            self.VariableGraphic = plot.PolyLine(self.Datas[self.StartValue:self.EndValue + 1], 
                                                 legend=var_name, colour=colours[0])
            self.GraphicsObject = plot.PlotGraphics([self.VariableGraphic], _("%s Graphics") % var_name, _("Tick"), _("Values"))
            datas_length = len(self.Datas)
            if datas_length > 1:
                start = self.Datas[self.StartValue][0]
            else:
                start = 0.
            self.Canvas.Draw(self.GraphicsObject, xAxis=(start, start + self.CurrentRange))
        self.RefreshScrollBar()
        self.Thaw()
    
    def GetInstancePath(self):
        return self.InstancePath
    
    def IsViewing(self, tagname):
        return self.InstancePath == tagname
    
    def GetNearestData(self, tick, adjust):
        ticks = numpy.array(zip(*self.Datas)[0])
        new_cursor = numpy.argmin(abs(ticks - tick))
        if adjust == -1 and ticks[new_cursor] > tick and new_cursor > 0:
            new_cursor -= 1
        elif adjust == 1 and ticks[new_cursor] < tick and new_cursor < len(self.Datas):
            new_cursor += 1
        return new_cursor
    
    def NewValue(self, tick, value, forced=False):
        self.Datas.append((float(tick), {True:1., False:0.}.get(value, float(value))))
        if not self.Fixed:
            while int(self.Datas[self.StartValue][0]) < tick - self.CurrentRange:
                self.StartValue += 1
            self.EndValue += 1
        self.NewDataAvailable()
    
    def RefreshScrollBar(self):
        if len(self.Datas) > 0:
            pos = int(self.Datas[self.StartValue][0] - self.Datas[0][0])
            range = int(self.Datas[-1][0] - self.Datas[0][0])
        else:
            pos = 0
            range = 0
        self.CanvasPosition.SetScrollbar(pos, self.CurrentRange, range, self.CurrentRange)

    def OnRangeChanged(self, event):
        old_range = self.CurrentRange
        try:
            if self.Ticktime == 0:
                self.CurrentRange = self.RangeValues_dict[self.CanvasRange.GetValue()]
            else:
                self.CurrentRange = self.RangeValues_dict[self.CanvasRange.GetValue()] / self.Ticktime
        except ValueError, e:
            self.CanvasRange.SetValue(str(self.CurrentRange))
        if self.Fixed and self.Datas[-1][0] - self.Datas[0][0] < self.CurrentRange:
            self.Fixed = False
        if self.Fixed:
            self.StartValue = min(self.StartValue, self.GetNearestData(self.Datas[-1][0] - self.CurrentRange, -1))
            self.EndValue = self.GetNearestData(self.StartValue + self.CurrentRange, 1)
        else:
            self.StartValue = self.GetNearestData(self.Datas[-1][0] - self.CurrentRange - 1, -1)
            self.EndValue = len(self.Datas) - 1
        self.NewDataAvailable(True)
        event.Skip()
    
    def OnPositionChanging(self, event):
        self.StartValue = self.GetNearestData(self.Datas[0][0] + event.GetPosition(), -1)
        self.EndValue = self.GetNearestData(self.Datas[self.StartValue][0] + self.CurrentRange, 1)
        self.Fixed = True
        self.NewDataAvailable(True)
        event.Skip()

    def OnResetButton(self, event):
        self.Fixed = False
        self.ResteView()
        event.Skip()

    def OnCurrentButton(self, event):
        self.StartValue = self.GetNearestData(self.Datas[-1][0] - self.CurrentRange, -1)
        self.EndValue = self.GetNearestData(self.Datas[self.StartValue][0] + self.CurrentRange, 1)
        self.Fixed = False
        self.NewDataAvailable(True)
        event.Skip()