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

    27

from __future__ import absolute_import

    28

import wx

    29

    30

from graphics.GraphicCommons import CONTACT_NORMAL, CONTACT_REVERSE, \

    31

    CONTACT_RISING, CONTACT_FALLING, COIL_NORMAL, COIL_REVERSE, COIL_SET, \

    32

    COIL_RESET, COIL_RISING, COIL_FALLING

    33

from graphics.LD_Objects import LD_Contact, LD_Coil

    34

from dialogs.BlockPreviewDialog import BlockPreviewDialog

    35

    36

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

    37

#                       Set Ladder Element Parmeters Dialog

    38

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

    39

    40

    41

class LDElementDialog(BlockPreviewDialog):

    42

    """

    43

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

    44

    graphic element

    45

    """

    46

    47

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

    48

        """

    49

        Constructor

    50

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

    51

        @param controller: Reference to project controller

    52

        @param tagname: Tagname of project POU edited

    53

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

    54

        """

    55

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

    56

                                    title=(_("Edit Contact Values")

    57

                                           if type == "contact"

    58

                                           else _("Edit Coil Values")))

    59

    60

        # Init common sizers

    61

        self._init_sizers(2, 0, (7 if type == "contact" else 9),

    62

                          None, 2, 1)

    63

    64

        # Create label for LD element modifier

    65

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

    66

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

    67

                                     flag=wx.GROW | wx.BOTTOM)

    68

    69

        # Create radio buttons for selecting LD element modifier

    70

        self.ModifierRadioButtons = {}

    71

        first = True

    72

        element_modifiers = ([CONTACT_NORMAL, CONTACT_REVERSE,

    73

                              CONTACT_RISING, CONTACT_FALLING]

    74

                             if type == "contact"

    75

                             else [COIL_NORMAL, COIL_REVERSE, COIL_SET,

    76

                                   COIL_RESET, COIL_RISING, COIL_FALLING])

    77

        modifiers_label = \

    78

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

    79

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

    80

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

    81

    82

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

    83

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

    84

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

    85

            radio_button.SetValue(first)

    86

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

    87

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

    88

            self.ModifierRadioButtons[modifier] = radio_button

    89

            first = False

    90

    91

        # Create label for LD element variable

    92

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

    93

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

    94

                                     flag=wx.GROW | wx.TOP)

    95

    96

        # Create a combo box for defining LD element variable

    97

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

    98

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

    99

                  self.ElementVariable)

   100

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

   101

                  self.ElementVariable)

   102

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

   103

                                     flag=wx.GROW | wx.TOP)

   104

   105

        # Add preview panel and associated label to sizers

   106

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

   107

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

   108

   109

        # Add buttons sizer to sizers

   110

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

   111

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

   112

   113

        # Save LD element class

   114

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

   115

   116

        # Extract list of variables defined in POU

   117

        self.RefreshVariableList()

   118

   119

        # Set values in ElementVariable

   120

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

   121

            # Only select BOOL variable and avoid input for coil

   122

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

   123

               value_type == "BOOL":

   124

                self.ElementVariable.Append(name)

   125

   126

        self.Fit()

   127

        # Normal radio button is default control having keyboard focus

   128

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

   129

   130

    def GetElementModifier(self):

   131

        """

   132

        Return modifier selected for LD element

   133

        @return: Modifier selected (None if not found)

   134

        """

   135

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

   136

        # that is selected

   137

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

   138

            if control.GetValue():

   139

                return modifier

   140

        return None

   141

   142

    def SetValues(self, values):

   143

        """

   144

        Set default LD element parameters

   145

        @param values: LD element parameters values

   146

        """

   147

        # For each parameters defined, set corresponding control value

   148

        for name, value in values.items():

   149

   150

            # Parameter is LD element variable

   151

            if name == "variable":

   152

                self.ElementVariable.SetValue(value)

   153

   154

            # Set value of other controls

   155

            elif name == "modifier":

   156

                self.ModifierRadioButtons[value].SetValue(True)

   157

   158

        # Refresh preview panel

   159

        self.RefreshPreview()

   160

   161

    def GetValues(self):

   162

        """

   163

        Return LD element parameters defined in dialog

   164

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

   165

        """

   166

        values = {

   167

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

   168

            "modifier": self.GetElementModifier()}

   169

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

   170

        return values

   171

   172

    def OnModifierChanged(self, event):

   173

        """

   174

        Called when LD element modifier changed

   175

        @param event: wx.RadioButtonEvent

   176

        """

   177

        self.RefreshPreview()

   178

        event.Skip()

   179

   180

    def OnVariableChanged(self, event):

   181

        """

   182

        Called when LD element associated variable changed

   183

        @param event: wx.ComboBoxEvent

   184

        """

   185

        self.RefreshPreview()

   186

        event.Skip()

   187

   188

    def RefreshPreview(self):

   189

        """

   190

        Refresh preview panel of graphic element

   191

        Override BlockPreviewDialog function

   192

        """

   193

        value = self.ElementVariable.GetValue()

   194

   195

        # Set graphic element displayed, creating a LD element

   196

        self.Element = self.ElementClass(

   197

            self.Preview,

   198

            self.GetElementModifier(),

   199

            value)

   200

   201

        button = self.ButtonSizer.GetAffirmativeButton()

   202

        button.Enable(value != "")

   203

   204

        # Call BlockPreviewDialog function

   205

        BlockPreviewDialog.RefreshPreview(self)

   206

   207

    def OnOK(self, event):

   208

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

   209

            self.EndModal(wx.ID_OK)