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

from __future__ import absolute_import

    27

import wx

    28

    29

from graphics.SFC_Objects import SFC_Transition

    30

from dialogs.BlockPreviewDialog import BlockPreviewDialog

    31

    32

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

    33

#                        Set Transition Parameters Dialog

    34

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

    35

    36

    37

class SFCTransitionDialog(BlockPreviewDialog):

    38

    """

    39

    Class that implements a dialog for defining parameters of a transition graphic

    40

    element

    41

    """

    42

    43

    def __init__(self, parent, controller, tagname, connection=True):

    44

        """

    45

        Constructor

    46

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

    47

        @param controller: Reference to project controller

    48

        @param tagname: Tagname of project POU edited

    49

        @param connection: True if transition value can be defined by a

    50

        connection (default: True)

    51

        """

    52

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

    53

                                    title=_('Edit transition'))

    54

    55

        # Init common sizers

    56

        self._init_sizers(2, 0, 8, None, 2, 1)

    57

    58

        # Create label for transition type

    59

        type_label = wx.StaticText(self, label=_('Type:'))

    60

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

    61

    62

        # Create combo box for selecting reference value

    63

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

    64

        reference.Append("")

    65

        for transition in controller.GetEditedElementTransitions(tagname):

    66

            reference.Append(transition)

    67

        self.Bind(wx.EVT_COMBOBOX, self.OnReferenceChanged, reference)

    68

    69

        # Create Text control for defining inline value

    70

        inline = wx.TextCtrl(self)

    71

        self.Bind(wx.EVT_TEXT, self.OnInlineChanged, inline)

    72

    73

        # Create radio buttons for selecting power rail type

    74

        self.TypeRadioButtons = {}

    75

        first = True

    76

        for type, label, control in [('reference', _('Reference'), reference),

    77

                                     ('inline', _('Inline'), inline),

    78

                                     ('connection', _('Connection'), None)]:

    79

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

    80

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

    81

            radio_button.SetValue(first)

    82

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

    83

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

    84

            if control is not None:

    85

                control.Enable(first)

    86

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

    87

            self.TypeRadioButtons[type] = (radio_button, control)

    88

            first = False

    89

    90

        # Create label for transition priority

    91

        priority_label = wx.StaticText(self, label=_('Priority:'))

    92

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

    93

    94

        # Create spin control for defining priority value

    95

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

    96

        self.Bind(wx.EVT_TEXT, self.OnPriorityChanged, self.Priority)

    97

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

    98

    99

        # Add preview panel and associated label to sizers

   100

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

   101

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

   102

   103

        # Add buttons sizer to sizers

   104

        self.MainSizer.AddSizer(

   105

            self.ButtonSizer, border=20,

   106

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

   107

   108

        self.Fit()

   109

   110

        # Reference radio button is default control having keyboard focus

   111

        self.TypeRadioButtons["reference"][0].SetFocus()

   112

   113

    def GetTransitionType(self):

   114

        """

   115

        Return type selected for SFC transition and associated value

   116

        @return: Type selected and associated value (None if no value)

   117

        """

   118

        # Go through radio buttons and return type and value associated to the

   119

        # one that is selected

   120

        for type, (radio, control) in self.TypeRadioButtons.iteritems():

   121

            if radio.GetValue():

   122

                if isinstance(control, wx.ComboBox):

   123

                    return type, control.GetStringSelection()

   124

                elif isinstance(control, wx.TextCtrl):

   125

                    return type, control.GetValue()

   126

                else:

   127

                    return type, None

   128

        return None, None

   129

   130

    def SetValues(self, values):

   131

        """

   132

        Set default SFC transition parameters

   133

        @param values: Transition parameters values

   134

        """

   135

        # Extract transition value according to type

   136

        type_value = values.get("value", None)

   137

   138

        # For each parameters defined, set corresponding control value

   139

        for name, value in values.items():

   140

   141

            # Parameter is SFC transition priority

   142

            if name == "priority":

   143

                self.Priority.SetValue(values["priority"])

   144

   145

            # Parameter is SFC transition type

   146

            elif name == "type":

   147

                for type, (radio, control) in self.TypeRadioButtons.iteritems():

   148

                    radio.SetValue(type == value)

   149

                    if control is not None:

   150

                        # Enable associated control to type and set value

   151

                        control.Enable(type == value)

   152

                        if type == value:

   153

                            if isinstance(control, wx.ComboBox):

   154

                                control.SetStringSelection(type_value)

   155

                            elif isinstance(control, wx.TextCtrl):

   156

                                control.ChangeValue(type_value)

   157

   158

        # Refresh preview panel

   159

        self.RefreshPreview()

   160

   161

    def GetValues(self):

   162

        """

   163

        Return SFC transition parameters defined in dialog

   164

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

   165

        """

   166

        values = {"priority": self.Priority.GetValue()}

   167

        values["type"], values["value"] = self.GetTransitionType()

   168

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

   169

        return values

   170

   171

    def OnOK(self, event):

   172

        """

   173

        Called when dialog OK button is pressed

   174

        Test if parameters defined are valid

   175

        @param event: wx.Event from OK button

   176

        """

   177

        message = None

   178

   179

        # Get transition type and value associated

   180

        type, value = self.GetTransitionType()

   181

   182

        # Test that value associated to type is defined

   183

        if type != "connection" and value == "":

   184

            message = _("Form isn't complete. %s must be filled!") % type

   185

   186

        # Show error message if an error is detected

   187

        if message is not None:

   188

            self.ShowErrorMessage(message)

   189

   190

        else:

   191

            # Call BlockPreviewDialog function

   192

            BlockPreviewDialog.OnOK(self, event)

   193

   194

    def OnTypeChanged(self, event):

   195

        """

   196

        Called when transition type changed

   197

        @param event: wx.RadioButtonEvent

   198

        """

   199

        # Refresh sensibility of control associated to transition types

   200

        for _type, (radio, control) in self.TypeRadioButtons.iteritems():

   201

            if control is not None:

   202

                control.Enable(radio.GetValue())

   203

   204

        # Refresh preview panel

   205

        self.RefreshPreview()

   206

        event.Skip()

   207

   208

    def OnReferenceChanged(self, event):

   209

        """

   210

        Called when SFC transition reference value changed

   211

        @param event: wx.ComboBoxEvent

   212

        """

   213

        self.RefreshPreview()

   214

        event.Skip()

   215

   216

    def OnInlineChanged(self, event):

   217

        """

   218

        Called when SFC transition inline value changed

   219

        @param event: wx.TextEvent

   220

        """

   221

        self.RefreshPreview()

   222

        event.Skip()

   223

   224

    def OnPriorityChanged(self, event):

   225

        """

   226

        Called when block inputs number changed

   227

        @param event: wx.SpinEvent

   228

        """

   229

        self.RefreshPreview()

   230

        event.Skip()

   231

   232

    def RefreshPreview(self):

   233

        """

   234

        Refresh preview panel of graphic element

   235

        Override BlockPreviewDialog function

   236

        """

   237

        # Set graphic element displayed, creating a SFC transition

   238

        self.Element = SFC_Transition(self.Preview)

   239

        self.Element.SetType(*self.GetTransitionType())

   240

        self.Element.SetPriority(self.Priority.GetValue())

   241

   242

        # Call BlockPreviewDialog function

   243

        BlockPreviewDialog.RefreshPreview(self)