1

#!/usr/bin/env python

     2

# -*- coding: utf-8 -*-

     3

     4

#This file is part of PLCOpenEditor, a library implementing an IEC 61131-3 editor

     5

#based on the plcopen standard. 

     6

#

     7

#Copyright (C) 2007: Edouard TISSERANT and Laurent BESSARD

     8

#

     9

#See COPYING file for copyrights details.

    10

#

    11

#This library is free software; you can redistribute it and/or

    12

#modify it under the terms of the GNU General Public

    13

#License as published by the Free Software Foundation; either

    14

#version 2.1 of the License, or (at your option) any later version.

    15

#

    16

#This library is distributed in the hope that it will be useful,

    17

#but WITHOUT ANY WARRANTY; without even the implied warranty of

    18

#MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

    19

#General Public License for more details.

    20

#

    21

#You should have received a copy of the GNU General Public

    22

#License along with this library; if not, write to the Free Software

    23

#Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

    24

    25

import wx

    26

import wx.lib.plot as plot

    27

from graphics.GraphicCommons import DebugViewer

    28

from controls import EditorPanel

    29

    30

colours = ['blue', 'red', 'green', 'yellow', 'orange', 'purple', 'brown', 'cyan',

    31

           'pink', 'grey']

    32

markers = ['circle', 'dot', 'square', 'triangle', 'triangle_down', 'cross', 'plus', 'circle']

    33

    34

    35

#-------------------------------------------------------------------------------

    36

#                       Debug Variable Graphic Viewer class

    37

#-------------------------------------------------------------------------------

    38

    39

    40

RANGE_VALUES = [str(25 * 2 ** i) for i in xrange(6)]

    41

    42

[ID_GRAPHICVIEWER, ID_GRAPHICVIEWERCANVAS,

    43

 ID_GRAPHICVIEWERCANVASRANGE, ID_GRAPHICVIEWERCANVASPOSITION,

    44

 ID_GRAPHICVIEWERRESETBUTTON, ID_GRAPHICVIEWERCURRENTBUTTON, 

    45

 ID_GRAPHICVIEWERSTATICTEXT1, ID_GRAPHICVIEWERSTATICTEXT2,

    46

] = [wx.NewId() for _init_ctrls in range(8)]

    47

    48

class GraphicViewer(EditorPanel, DebugViewer):

    49

    50

    def _init_coll_MainGridSizer_Items(self, parent):

    51

        # generated method, don't edit

    52

        parent.AddWindow(self.Canvas, 0, border=0, flag=wx.GROW)

    53

        parent.AddSizer(self.RangeSizer, 0, border=0, flag=wx.GROW)

    54

    55

    def _init_coll_MainGridSizer_Growables(self, parent):

    56

        # generated method, don't edit

    57

        parent.AddGrowableCol(0)

    58

        parent.AddGrowableRow(0)

    59

    60

    def _init_coll_RangeSizer_Items(self, parent):

    61

        # generated method, don't edit

    62

        parent.AddWindow(self.staticbox1, 0, border=5, flag=wx.ALIGN_CENTER_VERTICAL|wx.ALL)

    63

        parent.AddWindow(self.CanvasRange, 0, border=5, flag=wx.ALL)

    64

        parent.AddWindow(self.staticText2, 0, border=5, flag=wx.ALIGN_CENTER_VERTICAL|wx.ALL)

    65

        parent.AddWindow(self.CanvasPosition, 0, border=5, flag=wx.GROW|wx.ALL)

    66

        parent.AddWindow(self.ResetButton, 0, border=5, flag=wx.ALL)

    67

        parent.AddWindow(self.CurrentButton, 0, border=5, flag=wx.ALL)

    68

    69

    def _init_coll_RangeSizer_Growables(self, parent):

    70

        # generated method, don't edit

    71

        parent.AddGrowableCol(3)

    72

        parent.AddGrowableRow(0)

    73

    74

    def _init_sizers(self):

    75

        # generated method, don't edit

    76

        self.MainGridSizer = wx.FlexGridSizer(cols=1, hgap=0, rows=2, vgap=0)

    77

        self.RangeSizer = wx.FlexGridSizer(cols=6, hgap=0, rows=1, vgap=0)

    78

    79

        self._init_coll_MainGridSizer_Items(self.MainGridSizer)

    80

        self._init_coll_MainGridSizer_Growables(self.MainGridSizer)

    81

        self._init_coll_RangeSizer_Items(self.RangeSizer)

    82

        self._init_coll_RangeSizer_Growables(self.RangeSizer)

    83

    84

        self.Editor.SetSizer(self.MainGridSizer)

    85

    86

    def _init_Editor(self, prnt):

    87

        self.Editor = wx.Panel(prnt, ID_GRAPHICVIEWER, wx.DefaultPosition, 

    88

                 wx.DefaultSize, 0)

    89

    90

        self.Canvas = plot.PlotCanvas(id=ID_GRAPHICVIEWERCANVAS, 

    91

              name='Canvas', parent=self.Editor, pos=wx.Point(0, 0),

    92

              size=wx.Size(0, 0), style=0)

    93

        def _axisInterval(spec, lower, upper):

    94

            if spec == 'border':

    95

                if lower == upper:

    96

                    return lower - 0.5, upper + 0.5

    97

                else:

    98

                    border = (upper - lower) * 0.05

    99

                    return lower - border, upper + border

   100

            else:

   101

                return plot.PlotCanvas._axisInterval(self.Canvas, spec, lower, upper)

   102

        self.Canvas._axisInterval = _axisInterval

   103

        self.Canvas.SetYSpec('border')

   104

   105

        self.staticbox1 = wx.StaticText(id=ID_GRAPHICVIEWERSTATICTEXT1,

   106

              label=_('Range:'), name='staticText1', parent=self.Editor,

   107

              pos=wx.Point(0, 0), size=wx.DefaultSize, style=0)

   108

   109

        self.CanvasRange = wx.ComboBox(id=ID_GRAPHICVIEWERCANVASRANGE,

   110

              name='CanvasRange', parent=self.Editor, pos=wx.Point(0, 0),

   111

              size=wx.Size(100, 28), choices=RANGE_VALUES, style=0)

   112

        self.CanvasRange.SetStringSelection("25")

   113

        self.Bind(wx.EVT_COMBOBOX, self.OnRangeChanged, id=ID_GRAPHICVIEWERCANVASRANGE)

   114

        self.Bind(wx.EVT_TEXT_ENTER, self.OnRangeChanged, id=ID_GRAPHICVIEWERCANVASRANGE)

   115

   116

        self.staticText2 = wx.StaticText(id=ID_GRAPHICVIEWERSTATICTEXT2,

   117

              label=_('Position:'), name='staticText2', parent=self.Editor,

   118

              pos=wx.Point(0, 0), size=wx.DefaultSize, style=0)

   119

   120

        self.CanvasPosition = wx.ScrollBar(id=ID_GRAPHICVIEWERCANVASPOSITION,

   121

              name='Position', parent=self.Editor, pos=wx.Point(0, 0),

   122

              size=wx.Size(0, 16), style=wx.SB_HORIZONTAL)

   123

        self.CanvasPosition.SetScrollbar(0, 10, 100, 10)

   124

        self.CanvasPosition.Bind(wx.EVT_SCROLL_THUMBTRACK, self.OnPositionChanging, 

   125

              id = ID_GRAPHICVIEWERCANVASPOSITION)

   126

        self.CanvasPosition.Bind(wx.EVT_SCROLL_LINEUP, self.OnPositionChanging, 

   127

              id = ID_GRAPHICVIEWERCANVASPOSITION)

   128

        self.CanvasPosition.Bind(wx.EVT_SCROLL_LINEDOWN, self.OnPositionChanging, 

   129

              id = ID_GRAPHICVIEWERCANVASPOSITION)

   130

        self.CanvasPosition.Bind(wx.EVT_SCROLL_PAGEUP, self.OnPositionChanging, 

   131

              id = ID_GRAPHICVIEWERCANVASPOSITION)

   132

        self.CanvasPosition.Bind(wx.EVT_SCROLL_PAGEDOWN, self.OnPositionChanging, 

   133

              id = ID_GRAPHICVIEWERCANVASPOSITION)

   134

   135

        self.ResetButton = wx.Button(id=ID_GRAPHICVIEWERRESETBUTTON, label='Reset',

   136

              name='ResetButton', parent=self.Editor, pos=wx.Point(0, 0),

   137

              size=wx.Size(72, 24), style=0)

   138

        self.Bind(wx.EVT_BUTTON, self.OnResetButton, id=ID_GRAPHICVIEWERRESETBUTTON)

   139

   140

        self.CurrentButton = wx.Button(id=ID_GRAPHICVIEWERCURRENTBUTTON, label='Current',

   141

              name='CurrentButton', parent=self.Editor, pos=wx.Point(0, 0),

   142

              size=wx.Size(72, 24), style=0)

   143

        self.Bind(wx.EVT_BUTTON, self.OnCurrentButton, id=ID_GRAPHICVIEWERCURRENTBUTTON)

   144

   145

        self._init_sizers()

   146

   147

    def __init__(self, parent, window, producer, instancepath = ""):

   148

        EditorPanel.__init__(self, parent, "", window, None)

   149

        DebugViewer.__init__(self, producer, True, False)

   150

   151

        self.InstancePath = instancepath

   152

   153

        self.Datas = []

   154

        self.CurrentValue = 0

   155

        self.CurrentRange = 25

   156

   157

        self.AddDataConsumer(self.InstancePath.upper(), self)

   158

   159

    def __del__(self):

   160

        DebugViewer.__del__(self)

   161

        self.RemoveDataConsumer(self)

   162

   163

    def GetTitle(self):

   164

        if len(self.InstancePath) > 15:

   165

            return "..." + self.InstancePath[-12:]

   166

        return self.InstancePath

   167

   168

    def ResetView(self):

   169

        self.Datas = []

   170

        self.CurrentValue = 0

   171

        self.RefreshView()

   172

   173

    def RefreshNewData(self):

   174

        self.RefreshView(False)

   175

        DebugViewer.RefreshNewData(self)

   176

   177

    def RefreshView(self, force=True):

   178

        self.Freeze()

   179

        if force or self.CurrentValue + self.CurrentRange == len(self.Datas) or self.CurrentValue + len(self.Datas) < self.CurrentRange:

   180

            var_name = self.InstancePath.split(".")[-1]

   181

   182

            self.VariableGraphic = plot.PolyLine(self.Datas[self.CurrentValue:self.CurrentValue + self.CurrentRange], 

   183

                                                 legend=var_name, colour=colours[0])

   184

            self.GraphicsObject = plot.PlotGraphics([self.VariableGraphic], _("%s Graphics") % var_name, _("Tick"), _("Values"))

   185

            datas_length = len(self.Datas)

   186

            if datas_length > 1:

   187

                start = self.Datas[self.CurrentValue][0]

   188

                if self.CurrentValue + self.CurrentRange > datas_length:

   189

                    end = start + (self.Datas[datas_length - 1][0] - start) * self.CurrentRange / (datas_length - self.CurrentValue - 1)

   190

                else:

   191

                    end = self.Datas[self.CurrentValue + self.CurrentRange - 1][0]

   192

            else:

   193

                start = 0.

   194

                end = 25.

   195

            self.Canvas.Draw(self.GraphicsObject, xAxis=(start, end))

   196

        self.RefreshScrollBar()

   197

        self.Thaw()

   198

   199

    def GetInstancePath(self):

   200

        return self.InstancePath

   201

   202

    def IsViewing(self, tagname):

   203

        return self.InstancePath == tagname

   204

   205

    def NewValue(self, tick, value, forced=False):

   206

        self.Datas.append((float(tick), {True:1., False:0.}.get(value, float(value))))

   207

        if self.CurrentValue + self.CurrentRange == len(self.Datas) - 1:

   208

            self.CurrentValue += 1

   209

        self.NewDataAvailable()

   210

   211

    def RefreshScrollBar(self):

   212

        self.CanvasPosition.SetScrollbar(self.CurrentValue, self.CurrentRange, len(self.Datas), self.CurrentRange)

   213

   214

    def OnRangeChanged(self, event):

   215

        old_range = self.CurrentRange

   216

        try:

   217

            self.CurrentRange = int(self.CanvasRange.GetValue())

   218

        except ValueError, e:

   219

            self.CanvasRange.SetValue(str(self.CurrentRange))

   220

        self.CurrentValue = max(0, min(self.CurrentValue + old_range - self.CurrentRange, 

   221

                                       len(self.Datas) - self.CurrentRange))

   222

        self.RefreshView()

   223

        event.Skip()

   224

   225

    def OnPositionChanging(self, event):

   226

        self.CurrentValue = event.GetPosition()

   227

        self.RefreshView()

   228

        event.Skip()

   229

   230

    def OnResetButton(self, event):

   231

        self.ResetView()

   232

        event.Skip()

   233

   234

    def OnCurrentButton(self, event):

   235

        self.CurrentValue = max(0, len(self.Datas) - self.CurrentRange)

   236

        self.RefreshView()

   237

        event.Skip()

   238