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

import numpy

    28

from graphics.GraphicCommons import DebugViewer

    29

from controls import EditorPanel

    30

    31

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

    32

           'pink', 'grey']

    33

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

    34

    35

    36

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

    37

#                       Debug Variable Graphic Viewer class

    38

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

    39

    40

SECOND = 1000000000

    41

MINUTE = 60 * SECOND

    42

HOUR = 60 * MINUTE

    43

    44

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

    45

TIME_RANGE_VALUES = [("%ds" % i, i * SECOND) for i in (1, 2, 5, 10, 20, 30)] + \

    46

                    [("%dm" % i, i * MINUTE) for i in (1, 2, 5, 10, 20, 30)] + \

    47

                    [("%dh" % i, i * HOUR) for i in (1, 2, 3, 6, 12, 24)]

    48

    49

[ID_GRAPHICVIEWER, ID_GRAPHICVIEWERCANVAS,

    50

 ID_GRAPHICVIEWERCANVASRANGE, ID_GRAPHICVIEWERCANVASPOSITION,

    51

 ID_GRAPHICVIEWERRESETBUTTON, ID_GRAPHICVIEWERCURRENTBUTTON, 

    52

 ID_GRAPHICVIEWERSTATICTEXT1, ID_GRAPHICVIEWERSTATICTEXT2,

    53

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

    54

    55

class GraphicViewer(EditorPanel, DebugViewer):

    56

    57

    def _init_coll_MainGridSizer_Items(self, parent):

    58

        # generated method, don't edit

    59

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

    60

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

    61

    62

    def _init_coll_MainGridSizer_Growables(self, parent):

    63

        # generated method, don't edit

    64

        parent.AddGrowableCol(0)

    65

        parent.AddGrowableRow(0)

    66

    67

    def _init_coll_RangeSizer_Items(self, parent):

    68

        # generated method, don't edit

    69

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

    70

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

    71

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

    72

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

    73

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

    74

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

    75

    76

    def _init_coll_RangeSizer_Growables(self, parent):

    77

        # generated method, don't edit

    78

        parent.AddGrowableCol(3)

    79

        parent.AddGrowableRow(0)

    80

    81

    def _init_sizers(self):

    82

        # generated method, don't edit

    83

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

    84

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

    85

    86

        self._init_coll_MainGridSizer_Items(self.MainGridSizer)

    87

        self._init_coll_MainGridSizer_Growables(self.MainGridSizer)

    88

        self._init_coll_RangeSizer_Items(self.RangeSizer)

    89

        self._init_coll_RangeSizer_Growables(self.RangeSizer)

    90

    91

        self.Editor.SetSizer(self.MainGridSizer)

    92

    93

    def _init_Editor(self, prnt):

    94

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

    95

                 wx.DefaultSize, 0)

    96

    97

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

    98

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

    99

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

   100

        def _axisInterval(spec, lower, upper):

   101

            if spec == 'border':

   102

                if lower == upper:

   103

                    return lower - 0.5, upper + 0.5

   104

                else:

   105

                    border = (upper - lower) * 0.05

   106

                    return lower - border, upper + border

   107

            else:

   108

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

   109

        self.Canvas._axisInterval = _axisInterval

   110

        self.Canvas.SetYSpec('border')

   111

   112

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

   113

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

   114

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

   115

   116

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

   117

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

   118

              size=wx.Size(100, 28), style=wx.CB_READONLY)

   119

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

   120

   121

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

   122

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

   123

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

   124

   125

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

   126

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

   127

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

   128

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

   129

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

   130

              id = ID_GRAPHICVIEWERCANVASPOSITION)

   131

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

   132

              id = ID_GRAPHICVIEWERCANVASPOSITION)

   133

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

   134

              id = ID_GRAPHICVIEWERCANVASPOSITION)

   135

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

   136

              id = ID_GRAPHICVIEWERCANVASPOSITION)

   137

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

   138

              id = ID_GRAPHICVIEWERCANVASPOSITION)

   139

   140

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

   141

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

   142

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

   143

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

   144

   145

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

   146

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

   147

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

   148

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

   149

   150

        self._init_sizers()

   151

   152

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

   153

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

   154

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

   155

   156

        self.InstancePath = instancepath

   157

        self.RangeValues = None

   158

   159

        self.Datas = []

   160

        self.StartValue = 0

   161

        self.EndValue = 0

   162

        self.Fixed = False

   163

        self.Ticktime = self.DataProducer.GetTicktime()

   164

        self.RefreshCanvasRange()

   165

   166

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

   167

   168

    def __del__(self):

   169

        DebugViewer.__del__(self)

   170

        self.RemoveDataConsumer(self)

   171

   172

    def GetTitle(self):

   173

        if len(self.InstancePath) > 15:

   174

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

   175

        return self.InstancePath

   176

   177

    def ResetView(self):

   178

        self.Datas = []

   179

        self.StartValue = 0

   180

        self.EndValue = 0

   181

        self.Fixed = False

   182

        self.Ticktime = self.DataProducer.GetTicktime()

   183

        self.RefreshCanvasRange()

   184

        self.RefreshView()

   185

   186

    def RefreshNewData(self, *args, **kwargs):

   187

        self.RefreshView(*args, **kwargs)

   188

        DebugViewer.RefreshNewData(self)

   189

   190

    def RefreshCanvasRange(self):

   191

        if self.Ticktime == 0 and self.RangeValues != RANGE_VALUES:

   192

            self.RangeValues = RANGE_VALUES

   193

            self.RangeValues_dict = dict(RANGE_VALUES)

   194

            self.CanvasRange.Clear()

   195

            for text, value in RANGE_VALUES:

   196

                self.CanvasRange.Append(text)

   197

            self.CanvasRange.SetStringSelection(RANGE_VALUES[0][0])

   198

            self.CurrentRange = RANGE_VALUES[0][1]

   199

        elif self.RangeValues != TIME_RANGE_VALUES:

   200

            self.RangeValues = TIME_RANGE_VALUES

   201

            self.RangeValues_dict = dict(TIME_RANGE_VALUES)

   202

            self.CanvasRange.Clear()

   203

            for text, value in TIME_RANGE_VALUES:

   204

                self.CanvasRange.Append(text)

   205

            self.CanvasRange.SetStringSelection(TIME_RANGE_VALUES[0][0])

   206

            self.CurrentRange = TIME_RANGE_VALUES[0][1] / self.Ticktime

   207

   208

    def RefreshView(self, force=True):

   209

        self.Freeze()

   210

        if force or not self.Fixed:

   211

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

   212

   213

            self.VariableGraphic = plot.PolyLine(self.Datas[self.StartValue:self.EndValue + 1], 

   214

                                                 legend=var_name, colour=colours[0])

   215

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

   216

            datas_length = len(self.Datas)

   217

            if datas_length > 1:

   218

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

   219

            else:

   220

                start = 0.

   221

            self.Canvas.Draw(self.GraphicsObject, xAxis=(start, start + self.CurrentRange))

   222

        self.RefreshScrollBar()

   223

        self.Thaw()

   224

   225

    def GetInstancePath(self):

   226

        return self.InstancePath

   227

   228

    def IsViewing(self, tagname):

   229

        return self.InstancePath == tagname

   230

   231

    def GetNearestData(self, tick, adjust):

   232

        ticks = numpy.array(zip(*self.Datas)[0])

   233

        new_cursor = numpy.argmin(abs(ticks - tick))

   234

        if adjust == -1 and ticks[new_cursor] > tick and new_cursor > 0:

   235

            new_cursor -= 1

   236

        elif adjust == 1 and ticks[new_cursor] < tick and new_cursor < len(self.Datas):

   237

            new_cursor += 1

   238

        return new_cursor

   239

   240

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

   241

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

   242

        if not self.Fixed:

   243

            while int(self.Datas[self.StartValue][0]) < tick - self.CurrentRange:

   244

                self.StartValue += 1

   245

            self.EndValue += 1

   246

        self.NewDataAvailable()

   247

   248

    def RefreshScrollBar(self):

   249

        if len(self.Datas) > 0:

   250

            pos = int(self.Datas[self.StartValue][0] - self.Datas[0][0])

   251

            range = int(self.Datas[-1][0] - self.Datas[0][0])

   252

        else:

   253

            pos = 0

   254

            range = 0

   255

        self.CanvasPosition.SetScrollbar(pos, self.CurrentRange, range, self.CurrentRange)

   256

   257

    def OnRangeChanged(self, event):

   258

        old_range = self.CurrentRange

   259

        try:

   260

            if self.Ticktime == 0:

   261

                self.CurrentRange = self.RangeValues_dict[self.CanvasRange.GetValue()]

   262

            else:

   263

                self.CurrentRange = self.RangeValues_dict[self.CanvasRange.GetValue()] / self.Ticktime

   264

        except ValueError, e:

   265

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

   266

        if self.Fixed and self.Datas[-1][0] - self.Datas[0][0] < self.CurrentRange:

   267

            self.Fixed = False

   268

        if self.Fixed:

   269

            self.StartValue = min(self.StartValue, self.GetNearestData(self.Datas[-1][0] - self.CurrentRange, -1))

   270

            self.EndValue = self.GetNearestData(self.StartValue + self.CurrentRange, 1)

   271

        else:

   272

            self.StartValue = self.GetNearestData(self.Datas[-1][0] - self.CurrentRange - 1, -1)

   273

            self.EndValue = len(self.Datas) - 1

   274

        self.NewDataAvailable(True)

   275

        event.Skip()

   276

   277

    def OnPositionChanging(self, event):

   278

        self.StartValue = self.GetNearestData(self.Datas[0][0] + event.GetPosition(), -1)

   279

        self.EndValue = self.GetNearestData(self.Datas[self.StartValue][0] + self.CurrentRange, 1)

   280

        self.Fixed = True

   281

        self.NewDataAvailable(True)

   282

        event.Skip()

   283

   284

    def OnResetButton(self, event):

   285

        self.Fixed = False

   286

        self.ResteView()

   287

        event.Skip()

   288

   289

    def OnCurrentButton(self, event):

   290

        self.StartValue = self.GetNearestData(self.Datas[-1][0] - self.CurrentRange, -1)

   291

        self.EndValue = self.GetNearestData(self.Datas[self.StartValue][0] + self.CurrentRange, 1)

   292

        self.Fixed = False

   293

        self.NewDataAvailable(True)

   294

        event.Skip()

   295