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 CONTACT_NORMAL, CONTACT_REVERSE, \

    28

    CONTACT_RISING, CONTACT_FALLING, COIL_NORMAL, COIL_REVERSE, COIL_SET, \

    29

    COIL_RESET, COIL_RISING, COIL_FALLING

    30

from graphics.LD_Objects import LD_Contact, LD_Coil

    31

from BlockPreviewDialog import BlockPreviewDialog

    32

    33

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

    34

#                       Set Ladder Element Parmeters Dialog

    35

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

    36

    37

"""

    38

Class that implements a dialog for defining parameters of a LD contact or coil

    39

graphic element

    40

"""

    41

    42

class LDElementDialog(BlockPreviewDialog):

    43

    44

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

    45

        """

    46

        Constructor

    47

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

    48

        @param controller: Reference to project controller

    49

        @param tagname: Tagname of project POU edited

    50

        @param type: Type of LD element ('contact or 'coil')

    51

        """

    52

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

    53

              size=wx.Size(350, 260 if type == "contact" else 310),

    54

              title=(_("Edit Contact Values")

    55

                     if type == "contact"

    56

                     else _("Edit Coil Values")))

    57

    58

        # Create dialog main sizer

    59

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

    60

        main_sizer.AddGrowableCol(0)

    61

        main_sizer.AddGrowableRow(0)

    62

    63

        # Create a sizer for dividing LD element parameters in two columns

    64

        column_sizer = wx.BoxSizer(wx.HORIZONTAL)

    65

        main_sizer.AddSizer(column_sizer, border=20, 

    66

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

    67

    68

        # Create a sizer for left column

    69

        left_gridsizer = wx.FlexGridSizer(cols=1, hgap=0, 

    70

              rows=(7 if type == "contact" else 9), vgap=0)

    71

        left_gridsizer.AddGrowableCol(0)

    72

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

    73

              flag=wx.GROW|wx.RIGHT)

    74

    75

        # Create label for LD element modifier

    76

        modifier_label = wx.StaticText(self, label=_('Modifier:'))

    77

        left_gridsizer.AddWindow(modifier_label, border=5, 

    78

              flag=wx.GROW|wx.BOTTOM)

    79

    80

        # Create radio buttons for selecting LD element modifier

    81

        self.ModifierRadioButtons = {}

    82

        first = True

    83

        element_modifiers = ([CONTACT_NORMAL, CONTACT_REVERSE, 

    84

                              CONTACT_RISING, CONTACT_FALLING]

    85

                             if type == "contact"

    86

                             else [COIL_NORMAL, COIL_REVERSE, COIL_SET,

    87

                                   COIL_RESET, COIL_RISING, COIL_FALLING])

    88

        modifiers_label = [_("Normal"), _("Negated")] + \

    89

                          ([_("Set"), _("Reset")] if type == "coil" else []) + \

    90

                          [_("Rising Edge"), _("Falling Edge")]

    91

    92

        for modifier, label in zip(element_modifiers, modifiers_label):

    93

            radio_button = wx.RadioButton(self, label=label, 

    95

            radio_button.SetValue(first)

    96

            self.Bind(wx.EVT_RADIOBUTTON, self.OnModifierChanged, radio_button)

   100

            self.ModifierRadioButtons[modifier] = radio_button

   101

            first = False

   102

   103

        # Create label for LD element variable

   104

        element_variable_label = wx.StaticText(self, label=_('Variable:'))

   105

        left_gridsizer.AddWindow(element_variable_label, border=5,

   106

              flag=wx.GROW|wx.TOP)

   107

   108

        # Create a combo box for defining LD element variable

   109

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

   110

        self.Bind(wx.EVT_COMBOBOX, self.OnVariableChanged, 

   111

                  self.ElementVariable)

   112

        left_gridsizer.AddWindow(self.ElementVariable, border=5,

   113

             flag=wx.GROW|wx.TOP)

   114

   115

        # Create a sizer for right column

   116

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

   117

        right_gridsizer.AddGrowableCol(0)

   118

        right_gridsizer.AddGrowableRow(1)

   119

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

   120

              flag=wx.GROW|wx.LEFT)

   121

   122

        # Add preview panel and associated label to sizers

   123

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

   124

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

   125

   126

        # Add buttons sizer to sizers

   127

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

   128

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

   129

   130

        self.SetSizer(main_sizer)

   131

   132

        # Save LD element class

   133

        self.ElementClass = (LD_Contact if type == "contact" else LD_Coil)

   134

   135

        # Extract list of variables defined in POU

   136

        self.RefreshVariableList()

   137

   138

        # Set values in ElementVariable

   139

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

   140

            # Only select BOOL variable and avoid input for coil

   141

            if (type == "contact" or var_type != "Input") and \

   142

               value_type == "BOOL":

   143

                self.ElementVariable.Append(name)

   144

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

   145

   146

        # Normal radio button is default control having keyboard focus

   147

        self.ModifierRadioButtons[element_modifiers[0]].SetFocus()

   148

   149

    def GetElementModifier(self):

   150

        """

   151

        Return modifier selected for LD element

   152

        @return: Modifier selected (None if not found)

   153

        """

   154

        # Go through radio buttons and return modifier associated to the one

   155

        # that is selected

   156

        for modifier, control in self.ModifierRadioButtons.iteritems():

   157

            if control.GetValue():

   158

                return modifier

   159

        return None

   160

   161

    def SetValues(self, values):

   162

        """

   163

        Set default LD element parameters

   164

        @param values: Block parameters values

   165

        """

   166

        # For each parameters defined, set corresponding control value

   167

        for name, value in values.items():

   168

   169

            # Parameter is LD element variable

   170

            if name == "variable":

   171

                self.ElementVariable.SetStringSelection(value)

   172

   173

            # Set value of other controls

   174

            elif name == "modifier":

   175

                self.ModifierRadioButtons[value].SetValue(True)

   176

   177

        # Refresh preview panel

   178

        self.RefreshPreview()

   179

   180

    def GetValues(self):

   181

        """

   182

        Return LD element parameters defined in dialog

   183

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

   184

        """

   185

        values = {

   186

            "variable": self.ElementVariable.GetValue(),

   187

            "modifier": self.GetElementModifier()}

   188

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

   189

        return values

   190

   191

    def OnModifierChanged(self, event):

   192

        """

   193

        Called when LD element modifier changed

   194

        @param event: wx.RadioButtonEvent

   195

        """

   196

        self.RefreshPreview()

   197

        event.Skip()

   198

   199

    def OnVariableChanged(self, event):

   200

        """

   201

        Called when LD element associated variable changed

   202

        @param event: wx.ComboBoxEvent

   203

        """

   204

        self.RefreshPreview()

   205

        event.Skip()

   206

   207

    def RefreshPreview(self):

   208

        """

   209

        Refresh preview panel of graphic element

   210

        Override BlockPreviewDialog function

   211

        """

   212

        # Set graphic element displayed, creating a LD element

   213

        self.Element = self.ElementClass(

   214

                self.Preview, 

   215

                self.GetElementModifier(),

   216

                self.ElementVariable.GetStringSelection())

   217

   218

        # Call BlockPreviewDialog function

   219

        BlockPreviewDialog.RefreshPreview(self)