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 LDElementDialog(BlockPreviewDialog):

    40

    """

    41

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

    42

    graphic element

    43

    """

    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, (7 if type == "contact" else 9),

    60

                          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 = \

    76

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

    77

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

    78

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

    79

    80

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

    81

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

    82

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

    83

            radio_button.SetValue(first)

    84

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

    85

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

    86

            self.ModifierRadioButtons[modifier] = radio_button

    87

            first = False

    88

    89

        # Create label for LD element variable

    90

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

    91

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

    92

                                     flag=wx.GROW | wx.TOP)

    93

    94

        # Create a combo box for defining LD element variable

    95

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

    96

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

    97

                  self.ElementVariable)

    98

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

    99

                  self.ElementVariable)

   100

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

   101

                                     flag=wx.GROW | wx.TOP)

   102

   103

        # Add preview panel and associated label to sizers

   104

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

   105

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

   106

   107

        # Add buttons sizer to sizers

   108

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

   109

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

   110

   111

        # Save LD element class

   112

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

   113

   114

        # Extract list of variables defined in POU

   115

        self.RefreshVariableList()

   116

   117

        # Set values in ElementVariable

   118

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

   119

            # Only select BOOL variable and avoid input for coil

   120

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

   121

               value_type == "BOOL":

   122

                self.ElementVariable.Append(name)

   123

   124

        self.Fit()

   125

        # Normal radio button is default control having keyboard focus

   126

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

   127

   128

    def GetElementModifier(self):

   129

        """

   130

        Return modifier selected for LD element

   131

        @return: Modifier selected (None if not found)

   132

        """

   133

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

   134

        # that is selected

   135

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

   136

            if control.GetValue():

   137

                return modifier

   138

        return None

   139

   140

    def SetValues(self, values):

   141

        """

   142

        Set default LD element parameters

   143

        @param values: LD element parameters values

   144

        """

   145

        # For each parameters defined, set corresponding control value

   146

        for name, value in values.items():

   147

   148

            # Parameter is LD element variable

   149

            if name == "variable":

   150

                self.ElementVariable.SetValue(value)

   151

   152

            # Set value of other controls

   153

            elif name == "modifier":

   154

                self.ModifierRadioButtons[value].SetValue(True)

   155

   156

        # Refresh preview panel

   157

        self.RefreshPreview()

   158

   159

    def GetValues(self):

   160

        """

   161

        Return LD element parameters defined in dialog

   162

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

   163

        """

   164

        values = {

   165

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

   166

            "modifier": self.GetElementModifier()}

   167

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

   168

        return values

   169

   170

    def OnModifierChanged(self, event):

   171

        """

   172

        Called when LD element modifier changed

   173

        @param event: wx.RadioButtonEvent

   174

        """

   175

        self.RefreshPreview()

   176

        event.Skip()

   177

   178

    def OnVariableChanged(self, event):

   179

        """

   180

        Called when LD element associated variable changed

   181

        @param event: wx.ComboBoxEvent

   182

        """

   183

        self.RefreshPreview()

   184

        event.Skip()

   185

   186

    def RefreshPreview(self):

   187

        """

   188

        Refresh preview panel of graphic element

   189

        Override BlockPreviewDialog function

   190

        """

   191

        value = self.ElementVariable.GetValue()

   192

   193

        # Set graphic element displayed, creating a LD element

   194

        self.Element = self.ElementClass(

   195

                self.Preview,

   196

                self.GetElementModifier(),

   197

                value)

   198

   199

        button = self.ButtonSizer.GetAffirmativeButton()

   200

        button.Enable(value != "")

   201

   202

        # Call BlockPreviewDialog function

   203

        BlockPreviewDialog.RefreshPreview(self)

   204

   205

    def OnOK(self, event):

   206

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

   207

            self.EndModal(wx.ID_OK)