1

#!/usr/bin/env python

     2

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

     3

     4

# This file is part of Beremiz, a Integrated Development Environment for

     5

# programming IEC 61131-3 automates supporting plcopen standard and CanFestival.

     6

#

     7

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

     8

#

     9

# See COPYING file for copyrights details.

    10

#

    11

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

    12

# modify it under the terms of the GNU General Public License

    13

# as published by the Free Software Foundation; either version 2

    14

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

    15

#

    16

# This program 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

    19

# GNU General Public License for more details.

    20

#

    21

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

    22

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

    23

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, 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, exclude_input=False):

    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

        @param exclude_input: Exclude input from variable class selection

    61

        """

    62

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

    63

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

    64

    65

        # Init common sizers

    66

        self._init_sizers(4, 2, 4, None, 3, 2)

    67

    68

        # Create label for variable class

    69

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

    70

        self.LeftGridSizer.AddWindow(class_label, flag=wx.GROW)

    71

    72

        # Create a combo box for defining variable class

    73

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

    74

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

    75

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

    76

    77

        # Create label for variable execution order

    78

        execution_order_label = wx.StaticText(self, 

    79

              label=_('Execution Order:'))

    80

        self.LeftGridSizer.AddWindow(execution_order_label, flag=wx.GROW)

    81

    82

        # Create spin control for defining variable execution order

    83

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

    84

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

    85

                  self.ExecutionOrder)

    86

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

    87

    88

        # Create label for variable expression

    89

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

    90

        self.RightGridSizer.AddWindow(name_label, border=5, 

    91

              flag=wx.GROW|wx.BOTTOM)

    92

    93

        # Create text control for defining variable expression

    94

        self.Expression = wx.TextCtrl(self)

    95

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

    96

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

    97

    98

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

    99

        # variables defined in POU

   100

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

   101

              style=wx.LB_SINGLE|wx.LB_SORT)

   102

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

   103

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

   104

   105

        # Add preview panel and associated label to sizers

   106

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

   107

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

   108

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

   109

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

   110

   111

        # Add buttons sizer to sizers

   112

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

   113

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

   114

   115

        # Set options that can be selected in class combo box

   116

        for var_class, choice in VARIABLE_CLASSES_DICT.iteritems():

   117

            if not exclude_input or var_class != INPUT:

   118

                self.Class.Append(choice)

   119

        self.Class.SetSelection(0)

   120

   121

        # Extract list of variables defined in POU

   122

        self.RefreshVariableList()

   123

   124

        # Refresh values in name list box

   125

        self.RefreshNameList()

   126

   127

        # Class combo box is default control having keyboard focus

   128

        self.Class.SetFocus()

   129

   130

    def RefreshNameList(self):

   131

        """

   132

        Called to refresh names in name list box

   133

        """

   134

        # Get variable class to select POU variable applicable

   135

        var_class = VARIABLE_CLASSES_DICT_REVERSE[

   136

                            self.Class.GetStringSelection()]

   137

   138

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

   139

        # list that can be applied to variable class

   140

        self.VariableName.Clear()

   141

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

   142

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

   143

                self.VariableName.Append(name)

   144

   145

        # Get variable expression and select corresponding value in name list

   146

        # box if it exists

   147

        selected = self.Expression.GetValue()

   148

        if (selected != "" and 

   149

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

   150

            self.VariableName.SetStringSelection(selected)

   151

        else:

   152

            self.VariableName.SetSelection(wx.NOT_FOUND)

   153

   154

        # Disable name list box if no name present inside

   155

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

   156

   157

    def SetValues(self, values):

   158

        """

   159

        Set default variable parameters

   160

        @param values: Variable parameters values

   161

        """

   162

   163

        # Get class parameter value

   164

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

   165

        if var_class is not None:

   166

            # Set class selected in class combo box

   167

            self.Class.SetStringSelection(VARIABLE_CLASSES_DICT[var_class])

   168

            # Refresh names in name list box according to var class

   169

            self.RefreshNameList()

   170

   171

        # For each parameters defined, set corresponding control value

   172

        for name, value in values.items():

   173

   174

            # Parameter is variable expression

   175

            if name == "expression":

   176

                # Set expression text control value

   177

                self.Expression.ChangeValue(value)

   178

                # Select corresponding text in name list box if it exists

   179

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

   180

                    self.VariableName.SetStringSelection(value)

   181

                else:

   182

                    self.VariableName.SetSelection(wx.NOT_FOUND)

   183

   184

            # Parameter is variable execution order

   185

            elif name == "executionOrder":

   186

                self.ExecutionOrder.SetValue(value)

   187

   188

        # Refresh preview panel

   189

        self.RefreshPreview()

   190

   191

    def GetValues(self):

   192

        """

   193

        Return block parameters defined in dialog

   194

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

   195

        """

   196

        expression = self.Expression.GetValue()

   197

        values = {

   198

            "class": VARIABLE_CLASSES_DICT_REVERSE[

   199

                        self.Class.GetStringSelection()],

   200

            "expression": expression,

   201

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

   202

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

   203

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

   204

        return values

   205

   206

    def OnOK(self, event):

   207

        """

   208

        Called when dialog OK button is pressed

   209

        Test if parameters defined are valid

   210

        @param event: wx.Event from OK button

   211

        """

   212

        message = None

   213

   214

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

   215

        value = self.Expression.GetValue()

   216

        if value == "":

   217

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

   218

   219

        # Show error message if an error is detected

   220

        if message is not None:

   221

            self.ShowErrorMessage(message)

   222

   223

        else:

   224

            # Call BlockPreviewDialog function

   225

            BlockPreviewDialog.OnOK(self, event)

   226

   227

    def OnClassChanged(self, event):

   228

        """

   229

        Called when variable class value changed

   230

        @param event: wx.ComboBoxEvent

   231

        """

   232

        # Refresh name list box values

   233

        self.RefreshNameList()

   234

   235

        self.RefreshPreview()

   236

        event.Skip()

   237

   238

    def OnNameChanged(self, event):

   239

        """

   240

        Called when name selected in name list box changed

   241

        @param event: wx.ListBoxEvent

   242

        """

   243

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

   244

        # list box if value selected is valid

   245

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

   246

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

   247

   248

        self.RefreshPreview()

   249

        event.Skip()

   250

   251

    def OnExpressionChanged(self, event):

   252

        """

   253

        Called when expression text control is changed by user

   254

        @param event: wx.ListBoxEvent

   255

        """

   256

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

   257

        self.VariableName.SetSelection(

   258

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

   259

   260

        self.RefreshPreview()

   261

        event.Skip()

   262

   263

    def OnExecutionOrderChanged(self, event):

   264

        """

   265

        Called when block execution control value changed

   266

        @param event: wx.SpinEvent

   267

        """

   268

        self.RefreshPreview()

   269

        event.Skip()

   270

   271

    def RefreshPreview(self):

   272

        """

   273

        Refresh preview panel of graphic element

   274

        Override BlockPreviewDialog function

   275

        """

   276

        # Get expression value to put in FBD variable element

   277

        name = self.Expression.GetValue()

   278

   279

        # Set graphic element displayed, creating a FBD variable element

   280

        self.Element = FBD_Variable(self.Preview, 

   281

                    VARIABLE_CLASSES_DICT_REVERSE[

   282

                        self.Class.GetStringSelection()], 

   283

                    name, 

   284

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

   285

                    executionOrder = self.ExecutionOrder.GetValue())

   286

   287

        # Call BlockPreviewDialog function

   288

        BlockPreviewDialog.RefreshPreview(self)

   289

   290