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

    27

from graphics.GraphicCommons import INPUT, INOUT, OUTPUT

    28

from graphics.FBD_Objects import FBD_Variable

    29

from BlockPreviewDialog import BlockPreviewDialog

    30

    31

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

    32

#                                    Helpers

    33

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

    34

    35

# Dictionaries containing correspondence between variable block class and string

    36

# to be shown in Class combo box in both sense

    37

VARIABLE_CLASSES_DICT = {INPUT : _("Input"),

    38

                         INOUT : _("InOut"),

    39

                         OUTPUT : _("Output")}

    40

VARIABLE_CLASSES_DICT_REVERSE = dict(

    41

    [(value, key) for key, value in VARIABLE_CLASSES_DICT.iteritems()])

    42

    43

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

    44

#                        Set Variable Parameters Dialog

    45

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

    46

    47

"""

    48

Class that implements a dialog for defining parameters of a FBD variable graphic

    49

element

    50

"""

    51

    52

class FBDVariableDialog(BlockPreviewDialog):

    53

    54

    def __init__(self, parent, controller, tagname):

    55

        """

    56

        Constructor

    57

        @param parent: Parent wx.Window of dialog for modal

    58

        @param controller: Reference to project controller

    59

        @param tagname: Tagname of project POU edited

    60

        """

    61

        BlockPreviewDialog.__init__(self, parent, controller, tagname,

    62

              size=wx.Size(400, 380), title=_('Variable Properties'))

    63

    64

        # Create dialog main sizer

    65

        main_sizer = wx.FlexGridSizer(cols=1, hgap=0, rows=4, vgap=10)

    66

        main_sizer.AddGrowableCol(0)

    67

        main_sizer.AddGrowableRow(2)

    68

    69

        # Create a sizer for dividing FBD variable parameters in two columns

    70

        column_sizer = wx.BoxSizer(wx.HORIZONTAL)

    71

        main_sizer.AddSizer(column_sizer, border=20, 

    72

              flag=wx.GROW|wx.TOP|wx.LEFT|wx.RIGHT)

    73

    74

        # Create a sizer for left column

    75

        left_gridsizer = wx.FlexGridSizer(cols=1, hgap=0, rows=4, vgap=5)

    76

        left_gridsizer.AddGrowableCol(0)

    77

        column_sizer.AddSizer(left_gridsizer, 1, border=5, 

    78

              flag=wx.GROW|wx.RIGHT)

    79

    80

        # Create label for variable class

    81

        class_label = wx.StaticText(self, label=_('Class:'))

    82

        left_gridsizer.AddWindow(class_label, flag=wx.GROW)

    83

    84

        # Create a combo box for defining variable class

    85

        self.Class = wx.ComboBox(self, style=wx.CB_READONLY)

    86

        self.Bind(wx.EVT_COMBOBOX, self.OnClassChanged, self.Class)

    87

        left_gridsizer.AddWindow(self.Class, flag=wx.GROW)

    88

    89

        # Create label for variable execution order

    90

        execution_order_label = wx.StaticText(self, 

    91

              label=_('Execution Order:'))

    92

        left_gridsizer.AddWindow(execution_order_label, flag=wx.GROW)

    93

    94

        # Create spin control for defining variable execution order

    95

        self.ExecutionOrder = wx.SpinCtrl(self, min=0, style=wx.SP_ARROW_KEYS)

    96

        self.Bind(wx.EVT_SPINCTRL, self.OnExecutionOrderChanged, 

    97

                  self.ExecutionOrder)

    98

        left_gridsizer.AddWindow(self.ExecutionOrder, flag=wx.GROW)

    99

   100

        # Create a sizer for right column

   101

        right_gridsizer = wx.FlexGridSizer(cols=1, hgap=0, rows=3, vgap=0)

   102

        right_gridsizer.AddGrowableCol(0)

   103

        right_gridsizer.AddGrowableRow(2)

   104

        column_sizer.AddSizer(right_gridsizer, 1, border=5, 

   105

              flag=wx.GROW|wx.LEFT)

   106

   107

        # Create label for variable expression

   108

        name_label = wx.StaticText(self, label=_('Expression:'))

   109

        right_gridsizer.AddWindow(name_label, border=5, flag=wx.GROW|wx.BOTTOM)

   110

   111

        # Create text control for defining variable expression

   112

        self.Expression = wx.TextCtrl(self)

   113

        self.Bind(wx.EVT_TEXT, self.OnExpressionChanged, self.Expression)

   114

        right_gridsizer.AddWindow(self.Expression, flag=wx.GROW)

   115

   116

        # Create a list box to selected variable expression in the list of

   117

        # variables defined in POU

   118

        self.VariableName = wx.ListBox(self, size=wx.Size(0, 120), 

   119

              style=wx.LB_SINGLE|wx.LB_SORT)

   120

        self.Bind(wx.EVT_LISTBOX, self.OnNameChanged, self.VariableName)

   121

        right_gridsizer.AddWindow(self.VariableName, flag=wx.GROW)

   122

   123

        # Add preview panel and associated label to sizers

   124

        main_sizer.AddWindow(self.PreviewLabel, border=20,

   125

              flag=wx.GROW|wx.LEFT|wx.RIGHT)

   126

        main_sizer.AddWindow(self.Preview, border=20,

   127

              flag=wx.GROW|wx.LEFT|wx.RIGHT)

   128

   129

        # Add buttons sizer to sizers

   130

        main_sizer.AddSizer(self.ButtonSizer, border=20, 

   131

              flag=wx.ALIGN_RIGHT|wx.BOTTOM|wx.LEFT|wx.RIGHT)

   132

   133

        self.SetSizer(main_sizer)

   134

   135

        # Set options that can be selected in class combo box

   136

        for choice in VARIABLE_CLASSES_DICT.itervalues():

   137

            self.Class.Append(choice)

   138

        self.Class.SetStringSelection(VARIABLE_CLASSES_DICT[INPUT])

   139

   140

        # Extract list of variables defined in POU

   141

        self.RefreshVariableList()

   142

   143

        # Refresh values in name list box

   144

        self.RefreshNameList()

   145

   146

        # Class combo box is default control having keyboard focus

   147

        self.Class.SetFocus()

   148

   149

    def RefreshNameList(self):

   150

        """

   151

        Called to refresh names in name list box

   152

        """

   153

        # Get variable class to select POU variable applicable

   154

        var_class = VARIABLE_CLASSES_DICT_REVERSE[

   155

                            self.Class.GetStringSelection()]

   156

   157

        # Refresh names in name list box by selecting variables in POU variables

   158

        # list that can be applied to variable class

   159

        self.VariableName.Clear()

   160

        for name, (var_type, value_type) in self.VariableList.iteritems():

   161

            if var_type != "Input" or var_class == INPUT:

   162

                self.VariableName.Append(name)

   163

   164

        # Get variable expression and select corresponding value in name list

   165

        # box if it exists

   166

        selected = self.Expression.GetValue()

   167

        if (selected != "" and 

   168

            self.VariableName.FindString(selected) != wx.NOT_FOUND):

   169

            self.VariableName.SetStringSelection(selected)

   170

        else:

   171

            self.VariableName.SetSelection(wx.NOT_FOUND)

   172

   173

        # Disable name list box if no name present inside

   174

        self.VariableName.Enable(self.VariableName.GetCount() > 0)

   175

   176

    def SetValues(self, values):

   177

        """

   178

        Set default variable parameters

   179

        @param values: Variable parameters values

   180

        """

   181

   182

        # Get class parameter value

   183

        var_class = values.get("class", None)

   184

        if var_class is not None:

   185

            # Set class selected in class combo box

   186

            self.Class.SetStringSelection(VARIABLE_CLASSES_DICT[var_class])

   187

            # Refresh names in name list box according to var class

   188

            self.RefreshNameList()

   189

   190

        # For each parameters defined, set corresponding control value

   191

        for name, value in values.items():

   192

   193

            # Parameter is variable expression

   194

            if name == "expression":

   195

                # Set expression text control value

   196

                self.Expression.ChangeValue(value)

   197

                # Select corresponding text in name list box if it exists

   198

                if self.VariableName.FindString(value) != wx.NOT_FOUND:

   199

                    self.VariableName.SetStringSelection(value)

   200

                else:

   201

                    self.VariableName.SetSelection(wx.NOT_FOUND)

   202

   203

            # Parameter is variable execution order

   204

            elif name == "executionOrder":

   205

                self.ExecutionOrder.SetValue(value)

   206

   207

        # Refresh preview panel

   208

        self.RefreshPreview()

   209

   210

    def GetValues(self):

   211

        """

   212

        Return block parameters defined in dialog

   213

        @return: {parameter_name: parameter_value,...}

   214

        """

   215

        expression = self.Expression.GetValue()

   216

        values = {

   217

            "class": VARIABLE_CLASSES_DICT_REVERSE[

   218

                        self.Class.GetStringSelection()],

   219

            "expression": expression,

   220

            "var_type": self.VariableList.get(expression, (None, None))[1],

   221

            "executionOrder": self.ExecutionOrder.GetValue()}

   222

        values["width"], values["height"] = self.Element.GetSize()

   223

        return values

   224

   225

    def OnOK(self, event):

   226

        """

   227

        Called when dialog OK button is pressed

   228

        Test if parameters defined are valid

   229

        @param event: wx.Event from OK button

   230

        """

   231

        message = None

   232

   233

        # Test that an expression have been selected or typed by user

   234

        value = self.Expression.GetValue()

   235

        if value == "":

   236

            message = _("At least a variable or an expression must be selected!")

   237

   238

        # Show error message if an error is detected

   239

        if message is not None:

   240

            self.ShowErrorMessage(message)

   241

   242

        else:

   243

            # Call BlockPreviewDialog function

   244

            BlockPreviewDialog.OnOK(self, event)

   245

   246

    def OnClassChanged(self, event):

   247

        """

   248

        Called when variable class value changed

   249

        @param event: wx.ComboBoxEvent

   250

        """

   251

        # Refresh name list box values

   252

        self.RefreshNameList()

   253

   254

        self.RefreshPreview()

   255

        event.Skip()

   256

   257

    def OnNameChanged(self, event):

   258

        """

   259

        Called when name selected in name list box changed

   260

        @param event: wx.ListBoxEvent

   261

        """

   262

        # Change expression test control value to the value selected in name

   263

        # list box if value selected is valid

   264

        if self.VariableName.GetSelection() != wx.NOT_FOUND:

   265

            self.Expression.ChangeValue(self.VariableName.GetStringSelection())

   266

   267

        self.RefreshPreview()

   268

        event.Skip()

   269

   270

    def OnExpressionChanged(self, event):

   271

        """

   272

        Called when expression text control is changed by user

   273

        @param event: wx.ListBoxEvent

   274

        """

   275

        # Select the corresponding value in name list box if it exists

   276

        self.VariableName.SetSelection(

   277

            self.VariableName.FindString(self.Expression.GetValue()))

   278

   279

        self.RefreshPreview()

   280

        event.Skip()

   281

   282

    def OnExecutionOrderChanged(self, event):

   283

        """

   284

        Called when block execution control value changed

   285

        @param event: wx.SpinEvent

   286

        """

   287

        self.RefreshPreview()

   288

        event.Skip()

   289

   290

    def RefreshPreview(self):

   291

        """

   292

        Refresh preview panel of graphic element

   293

        Override BlockPreviewDialog function

   294

        """

   295

        # Get expression value to put in FBD variable element

   296

        name = self.Expression.GetValue()

   297

   298

        # Set graphic element displayed, creating a FBD variable element

   299

        self.Element = FBD_Variable(self.Preview, 

   300

                    VARIABLE_CLASSES_DICT_REVERSE[

   301

                        self.Class.GetStringSelection()], 

   302

                    name, 

   303

                    self.VariableList.get(name, ("", ""))[1], 

   304

                    executionOrder = self.ExecutionOrder.GetValue())

   305

   306

        # Call BlockPreviewDialog function

   307

        BlockPreviewDialog.RefreshPreview(self)

   308

   309