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

# Copyright (C) 2017: Andrey Skvortsov <andrej.skvortzov@gmail.com>

     9

#

    10

# See COPYING file for copyrights details.

    11

#

    12

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

    13

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

    14

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

    15

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

    16

#

    17

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

    18

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

    19

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    20

# GNU General Public License for more details.

    21

#

    22

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

    23

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

    24

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

    25

    26

import wx

    27

    28

from graphics.GraphicCommons import CONTACT_NORMAL, CONTACT_REVERSE, \

    29

    CONTACT_RISING, CONTACT_FALLING, COIL_NORMAL, COIL_REVERSE, COIL_SET, \

    30

    COIL_RESET, COIL_RISING, COIL_FALLING

    31

from graphics.LD_Objects import LD_Contact, LD_Coil

    32

from BlockPreviewDialog import BlockPreviewDialog

    33

    34

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

    35

#                       Set Ladder Element Parmeters Dialog

    36

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

    37

    38

"""

    39

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

    40

graphic element

    41

"""

    42

    43

class LDElementDialog(BlockPreviewDialog):

    44

    45

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

    46

        """

    47

        Constructor

    48

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

    49

        @param controller: Reference to project controller

    50

        @param tagname: Tagname of project POU edited

    51

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

    52

        """

    53

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

    54

              title=(_("Edit Contact Values")

    55

                     if type == "contact"

    56

                     else _("Edit Coil Values")))

    57

    58

        # Init common sizers

    59

        self._init_sizers(2, 0,

    60

              (7 if type == "contact" else 9), None, 2, 1)

    61

    62

        # Create label for LD element modifier

    63

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

    64

        self.LeftGridSizer.AddWindow(modifier_label, border=5,

    65

              flag=wx.GROW|wx.BOTTOM)

    66

    67

        # Create radio buttons for selecting LD element modifier

    68

        self.ModifierRadioButtons = {}

    69

        first = True

    70

        element_modifiers = ([CONTACT_NORMAL, CONTACT_REVERSE,

    71

                              CONTACT_RISING, CONTACT_FALLING]

    72

                             if type == "contact"

    73

                             else [COIL_NORMAL, COIL_REVERSE, COIL_SET,

    74

                                   COIL_RESET, COIL_RISING, COIL_FALLING])

    75

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

    76

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

    77

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

    78

    79

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

    80

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

    81

                  style=(wx.RB_GROUP if first else 0))

    82

            radio_button.SetValue(first)

    83

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

    84

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

    85

            self.ModifierRadioButtons[modifier] = radio_button

    86

            first = False

    87

    88

        # Create label for LD element variable

    89

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

    90

        self.LeftGridSizer.AddWindow(element_variable_label, border=5,

    91

              flag=wx.GROW|wx.TOP)

    92

    93

        # Create a combo box for defining LD element variable

    94

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

    95

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

    96

                  self.ElementVariable)

    97

        self.Bind(wx.EVT_TEXT, self.OnVariableChanged,

    98

                  self.ElementVariable)

    99

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

   100

             flag=wx.GROW|wx.TOP)

   101

   102

        # Add preview panel and associated label to sizers

   103

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

   104

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

   105

   106

        # Add buttons sizer to sizers

   107

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

   108

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

   109

   110

        # Save LD element class

   111

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

   112

   113

        # Extract list of variables defined in POU

   114

        self.RefreshVariableList()

   115

   116

        # Set values in ElementVariable

   117

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

   118

            # Only select BOOL variable and avoid input for coil

   119

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

   120

               value_type == "BOOL":

   121

                self.ElementVariable.Append(name)

   122

   123

        self.Fit()

   124

        # Normal radio button is default control having keyboard focus

   125

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

   126

   127

    def GetElementModifier(self):

   128

        """

   129

        Return modifier selected for LD element

   130

        @return: Modifier selected (None if not found)

   131

        """

   132

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

   133

        # that is selected

   134

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

   135

            if control.GetValue():

   136

                return modifier

   137

        return None

   138

   139

    def SetValues(self, values):

   140

        """

   141

        Set default LD element parameters

   142

        @param values: LD element parameters values

   143

        """

   144

        # For each parameters defined, set corresponding control value

   145

        for name, value in values.items():

   146

   147

            # Parameter is LD element variable

   148

            if name == "variable":

   149

                self.ElementVariable.SetValue(value)

   150

   151

            # Set value of other controls

   152

            elif name == "modifier":

   153

                self.ModifierRadioButtons[value].SetValue(True)

   154

   155

        # Refresh preview panel

   156

        self.RefreshPreview()

   157

   158

    def GetValues(self):

   159

        """

   160

        Return LD element parameters defined in dialog

   161

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

   162

        """

   163

        values = {

   164

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

   165

            "modifier": self.GetElementModifier()}

   166

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

   167

        return values

   168

   169

    def OnModifierChanged(self, event):

   170

        """

   171

        Called when LD element modifier changed

   172

        @param event: wx.RadioButtonEvent

   173

        """

   174

        self.RefreshPreview()

   175

        event.Skip()

   176

   177

    def OnVariableChanged(self, event):

   178

        """

   179

        Called when LD element associated variable changed

   180

        @param event: wx.ComboBoxEvent

   181

        """

   182

        self.RefreshPreview()

   183

        event.Skip()

   184

   185

    def RefreshPreview(self):

   186

        """

   187

        Refresh preview panel of graphic element

   188

        Override BlockPreviewDialog function

   189

        """

   190

        value = self.ElementVariable.GetValue()

   191

   192

        # Set graphic element displayed, creating a LD element

   193

        self.Element = self.ElementClass(

   194

                self.Preview,

   195

                self.GetElementModifier(),

   196

                value)

   197

   198

        button = self.ButtonSizer.GetAffirmativeButton()

   199

        button.Enable(value != "")

   200

   201

        # Call BlockPreviewDialog function

   202

        BlockPreviewDialog.RefreshPreview(self)

   203

   204

    def OnOK(self, event):

   205

        if self.ElementVariable.GetValue() != "":

   206

            self.EndModal(wx.ID_OK)