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

    31

from dialogs.BlockPreviewDialog import BlockPreviewDialog

    32

    33

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

    34

#                         Set SFC Step Parameters Dialog

    35

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

    36

    37

    38

class SFCStepDialog(BlockPreviewDialog):

    39

    """

    40

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

    41

    element

    42

    """

    43

    44

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

    45

        """

    46

        Constructor

    47

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

    48

        @param controller: Reference to project controller

    49

        @param tagname: Tagname of project POU edited

    50

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

    51

        """

    52

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

    53

                                    title=_('Edit Step'))

    54

    55

        # Init common sizers

    56

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

    57

    58

        # Create label for SFC step name

    59

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

    60

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

    61

    62

        # Create text control for defining SFC step name

    63

        self.StepName = wx.TextCtrl(self)

    64

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

    65

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

    66

    67

        # Create label for SFC step connectors

    68

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

    69

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

    70

    71

        # Create check boxes for defining connectors available on SFC step

    72

        self.ConnectorsCheckBox = {}

    73

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

    74

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

    75

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

    76

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

    77

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

    78

                check_box.SetValue(True)

    79

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

    80

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

    81

            self.ConnectorsCheckBox[name] = check_box

    82

    83

        # Add preview panel and associated label to sizers

    84

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

    85

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

    86

    87

        # Add buttons sizer to sizers

    88

        self.MainSizer.AddSizer(

    89

            self.ButtonSizer, border=20,

    90

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

    91

    92

        # Save flag that indicates that step is initial

    93

        self.Initial = initial

    94

    95

        # Set default name for step

    96

        self.StepName.ChangeValue(controller.GenerateNewName(

    97

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

    98

    99

        self.Fit()

   100

   101

        # Step name text control is default control having keyboard focus

   102

        self.StepName.SetFocus()

   103

   104

    def SetValues(self, values):

   105

        """

   106

        Set default block parameters

   107

        @param values: Block parameters values

   108

        """

   109

        # For each parameters defined, set corresponding control value

   110

        for name, value in values.items():

   111

   112

            # Parameter is step name

   113

            if name == "name":

   114

                self.StepName.ChangeValue(value)

   115

   116

            # Set value of other controls

   117

            else:

   118

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

   119

                if control is not None:

   120

                    control.SetValue(value)

   121

   122

        # Refresh preview panel

   123

        self.RefreshPreview()

   124

   125

    def GetValues(self):

   126

        """

   127

        Return step parameters defined in dialog

   128

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

   129

        """

   130

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

   131

        values.update({

   132

            name: control.IsChecked()

   133

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

   134

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

   135

        return values

   136

   137

    def OnOK(self, event):

   138

        """

   139

        Called when dialog OK button is pressed

   140

        Test if step name defined is valid

   141

        @param event: wx.Event from OK button

   142

        """

   143

        message = None

   144

   145

        # Get step name typed by user

   146

        step_name = self.StepName.GetValue()

   147

   148

        # Test that a name have been defined

   149

        if step_name == "":

   150

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

   151

   152

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

   153

        if message is not None:

   154

            self.ShowErrorMessage(message)

   155

   156

        # Test step name validity

   157

        elif self.TestElementName(step_name):

   158

            # Call BlockPreviewDialog function

   159

            BlockPreviewDialog.OnOK(self, event)

   160

   161

    def OnConnectorsChanged(self, event):

   162

        """

   163

        Called when a step connector value changed

   164

        @param event: wx.CheckBoxEvent

   165

        """

   166

        self.RefreshPreview()

   167

        event.Skip()

   168

   169

    def OnNameChanged(self, event):

   170

        """

   171

        Called when step name value changed

   172

        @param event: wx.TextEvent

   173

        """

   174

        self.RefreshPreview()

   175

        event.Skip()

   176

   177

    def RefreshPreview(self):

   178

        """

   179

        Refresh preview panel of graphic element

   180

        Override BlockPreviewDialog function

   181

        """

   182

        # Set graphic element displayed, creating a SFC step element

   183

        self.Element = SFC_Step(self.Preview,

   184

                                self.StepName.GetValue(),

   185

                                self.Initial)

   186

   187

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

   188

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

   189

            if control.IsChecked():

   190

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

   191

            else:

   192

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

   193

   194

        # Call BlockPreviewDialog function

   195

        BlockPreviewDialog.RefreshPreview(self)