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.SFC_Objects import SFC_Step

    29

from BlockPreviewDialog import BlockPreviewDialog

    30

    31

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

    32

#                         Set SFC Step Parameters Dialog

    33

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

    34

    35

    36

class SFCStepDialog(BlockPreviewDialog):

    37

    """

    38

    Class that implements a dialog for defining parameters of a SFC step graphic

    39

    element

    40

    """

    41

    42

    def __init__(self, parent, controller, tagname, initial=False):

    43

        """

    44

        Constructor

    45

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

    46

        @param controller: Reference to project controller

    47

        @param tagname: Tagname of project POU edited

    48

        @param initial: True if step is initial (default: False)

    49

        """

    50

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

    51

                                    title=_('Edit Step'))

    52

    53

        # Init common sizers

    54

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

    55

    56

        # Create label for SFC step name

    57

        name_label = wx.StaticText(self, label=_('Name:'))

    58

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

    59

    60

        # Create text control for defining SFC step name

    61

        self.StepName = wx.TextCtrl(self)

    62

        self.Bind(wx.EVT_TEXT, self.OnNameChanged, self.StepName)

    63

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

    64

    65

        # Create label for SFC step connectors

    66

        connectors_label = wx.StaticText(self, label=_('Connectors:'))

    67

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

    68

    69

        # Create check boxes for defining connectors available on SFC step

    70

        self.ConnectorsCheckBox = {}

    71

        for name, label in [("input", _("Input")),

    72

                            ("output", _("Output")),

    73

                            ("action", _("Action"))]:

    74

            check_box = wx.CheckBox(self, label=label)

    75

            if name == "output" or (name == "input" and not initial):

    76

                check_box.SetValue(True)

    77

            self.Bind(wx.EVT_CHECKBOX, self.OnConnectorsChanged, check_box)

    78

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

    79

            self.ConnectorsCheckBox[name] = check_box

    80

    81

        # Add preview panel and associated label to sizers

    82

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

    83

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

    84

    85

        # Add buttons sizer to sizers

    86

        self.MainSizer.AddSizer(

    87

            self.ButtonSizer, border=20,

    88

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

    89

    90

        # Save flag that indicates that step is initial

    91

        self.Initial = initial

    92

    93

        # Set default name for step

    94

        self.StepName.ChangeValue(controller.GenerateNewName(

    95

               tagname, None, "Step%d", 0))

    96

    97

        self.Fit()

    98

    99

        # Step name text control is default control having keyboard focus

   100

        self.StepName.SetFocus()

   101

   102

    def SetValues(self, values):

   103

        """

   104

        Set default block parameters

   105

        @param values: Block parameters values

   106

        """

   107

        # For each parameters defined, set corresponding control value

   108

        for name, value in values.items():

   109

   110

            # Parameter is step name

   111

            if name == "name":

   112

                self.StepName.ChangeValue(value)

   113

   114

            # Set value of other controls

   115

            else:

   116

                control = self.ConnectorsCheckBox.get(name, None)

   117

                if control is not None:

   118

                    control.SetValue(value)

   119

   120

        # Refresh preview panel

   121

        self.RefreshPreview()

   122

   123

    def GetValues(self):

   124

        """

   125

        Return step parameters defined in dialog

   126

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

   127

        """

   128

        values = {"name": self.StepName.GetValue()}

   129

        values.update({

   130

            name: control.IsChecked()

   131

            for name, control in self.ConnectorsCheckBox.iteritems()})

   132

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

   133

        return values

   134

   135

    def OnOK(self, event):

   136

        """

   137

        Called when dialog OK button is pressed

   138

        Test if step name defined is valid

   139

        @param event: wx.Event from OK button

   140

        """

   141

        message = None

   142

   143

        # Get step name typed by user

   144

        step_name = self.StepName.GetValue()

   145

   146

        # Test that a name have been defined

   147

        if step_name == "":

   148

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

   149

   150

        # If an error have been identify, show error message dialog

   151

        if message is not None:

   152

            self.ShowErrorMessage(message)

   153

   154

        # Test step name validity

   155

        elif self.TestElementName(step_name):

   156

            # Call BlockPreviewDialog function

   157

            BlockPreviewDialog.OnOK(self, event)

   158

   159

    def OnConnectorsChanged(self, event):

   160

        """

   161

        Called when a step connector value changed

   162

        @param event: wx.CheckBoxEvent

   163

        """

   164

        self.RefreshPreview()

   165

        event.Skip()

   166

   167

    def OnNameChanged(self, event):

   168

        """

   169

        Called when step name value changed

   170

        @param event: wx.TextEvent

   171

        """

   172

        self.RefreshPreview()

   173

        event.Skip()

   174

   175

    def RefreshPreview(self):

   176

        """

   177

        Refresh preview panel of graphic element

   178

        Override BlockPreviewDialog function

   179

        """

   180

        # Set graphic element displayed, creating a SFC step element

   181

        self.Element = SFC_Step(self.Preview,

   182

                                self.StepName.GetValue(),

   183

                                self.Initial)

   184

   185

        # Update connectors of SFC step element according to check boxes value

   186

        for name, control in self.ConnectorsCheckBox.iteritems():

   187

            if control.IsChecked():

   188

                getattr(self.Element, "Add" + name.capitalize())()

   189

            else:

   190

                getattr(self.Element, "Remove" + name.capitalize())()

   191

   192

        # Call BlockPreviewDialog function

   193

        BlockPreviewDialog.RefreshPreview(self)