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

#

     9

# See COPYING file for copyrights details.

    10

#

    11

# This program is free software; you can redistribute it and/or

    12

# modify it under the terms of the GNU General Public License

    13

# as published by the Free Software Foundation; either version 2

    14

# of the License, or (at your option) any later version.

    15

#

    16

# This program is distributed in the hope that it will be useful,

    17

# but WITHOUT ANY WARRANTY; without even the implied warranty of

    18

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    19

# GNU General Public License for more details.

    20

#

    21

# You should have received a copy of the GNU General Public License

    22

# along with this program; if not, write to the Free Software

    23

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

    24

    25

import wx

    26

    27

from graphics.SFC_Objects import SFC_Step

    28

from BlockPreviewDialog import BlockPreviewDialog

    29

    30

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

    31

#                         Set SFC Step Parameters Dialog

    32

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

    33

    34

"""

    35

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

    36

element

    37

"""

    38

    39

class SFCStepDialog(BlockPreviewDialog):

    40

    41

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

    42

        """

    43

        Constructor

    44

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

    45

        @param controller: Reference to project controller

    46

        @param tagname: Tagname of project POU edited

    47

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

    48

        """

    49

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

    50

              size=wx.Size(400, 280), title=_('Edit Step'))

    51

    52

        # Init common sizers

    53

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

    54

    55

        # Create label for SFC step name

    56

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

    57

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

    58

    59

        # Create text control for defining SFC step name

    60

        self.StepName = wx.TextCtrl(self)

    61

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

    62

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

    63

    64

        # Create label for SFC step connectors

    65

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

    66

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

    67

    68

        # Create check boxes for defining connectors available on SFC step

    69

        self.ConnectorsCheckBox = {}

    70

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

    71

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

    72

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

    73

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

    74

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

    75

                check_box.SetValue(True)

    76

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

    77

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

    78

            self.ConnectorsCheckBox[name] = check_box

    79

    80

        # Add preview panel and associated label to sizers

    81

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

    82

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

    83

    84

        # Add buttons sizer to sizers

    85

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

    86

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

    87

    88

        # Save flag that indicates that step is initial

    89

        self.Initial = initial

    90

    91

        # Set default name for step

    92

        self.StepName.ChangeValue(controller.GenerateNewName(

    93

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

    94

    95

        # Step name text control is default control having keyboard focus

    96

        self.StepName.SetFocus()

    97

    98

    def SetValues(self, values):

    99

        """

   100

        Set default block parameters

   101

        @param values: Block parameters values

   102

        """

   103

        # For each parameters defined, set corresponding control value

   104

        for name, value in values.items():

   105

   106

            # Parameter is step name

   107

            if name == "name":

   108

                self.StepName.ChangeValue(value)

   109

   110

            # Set value of other controls

   111

            else:

   112

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

   113

                if control is not None:

   114

                    control.SetValue(value)

   115

   116

        # Refresh preview panel

   117

        self.RefreshPreview()

   118

   119

    def GetValues(self):

   120

        """

   121

        Return step parameters defined in dialog

   122

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

   123

        """

   124

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

   125

        values.update({

   126

            name: control.IsChecked()

   127

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

   128

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

   129

        return values

   130

   131

    def OnOK(self, event):

   132

        """

   133

        Called when dialog OK button is pressed

   134

        Test if step name defined is valid

   135

        @param event: wx.Event from OK button

   136

        """

   137

        message = None

   138

   139

        # Get step name typed by user

   140

        step_name = self.StepName.GetValue()

   141

   142

        # Test that a name have been defined

   143

        if step_name == "":

   144

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

   145

   146

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

   147

        if message is not None:

   148

            self.ShowErrorMessage(message)

   149

   150

        # Test step name validity

   151

        elif self.TestElementName(step_name):

   152

            # Call BlockPreviewDialog function

   153

            BlockPreviewDialog.OnOK(self, event)

   154

   155

    def OnConnectorsChanged(self, event):

   156

        """

   157

        Called when a step connector value changed

   158

        @param event: wx.CheckBoxEvent

   159

        """

   160

        self.RefreshPreview()

   161

        event.Skip()

   162

   163

    def OnNameChanged(self, event):

   164

        """

   165

        Called when step name value changed

   166

        @param event: wx.TextEvent

   167

        """

   168

        self.RefreshPreview()

   169

        event.Skip()

   170

   171

    def RefreshPreview(self):

   172

        """

   173

        Refresh preview panel of graphic element

   174

        Override BlockPreviewDialog function

   175

        """

   176

        # Set graphic element displayed, creating a SFC step element

   177

        self.Element = SFC_Step(self.Preview, 

   178

                                self.StepName.GetValue(), 

   179

                                self.Initial)

   180

   181

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

   182

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

   183

            if control.IsChecked():

   184

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

   185

            else:

   186

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

   187

   188

        # Call BlockPreviewDialog function

   189

        BlockPreviewDialog.RefreshPreview(self)