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

     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 that implements a dialog for defining parameters of a SFC step graphic

    37

element

    38

"""

    39

    40

class SFCStepDialog(BlockPreviewDialog):

    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,  

    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(self.ButtonSizer, border=20, 

    87

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

    88

    89

        # Save flag that indicates that step is initial

    90

        self.Initial = initial

    91

    92

        # Set default name for step

    93

        self.StepName.ChangeValue(controller.GenerateNewName(

    94

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

    97

    98

        # Step name text control is default control having keyboard focus

    99

        self.StepName.SetFocus()

   100

   101

    def SetValues(self, values):

   102

        """

   103

        Set default block parameters

   104

        @param values: Block parameters values

   105

        """

   106

        # For each parameters defined, set corresponding control value

   107

        for name, value in values.items():

   108

   109

            # Parameter is step name

   110

            if name == "name":

   111

                self.StepName.ChangeValue(value)

   112

   113

            # Set value of other controls

   114

            else:

   115

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

   116

                if control is not None:

   117

                    control.SetValue(value)

   118

   119

        # Refresh preview panel

   120

        self.RefreshPreview()

   121

   122

    def GetValues(self):

   123

        """

   124

        Return step parameters defined in dialog

   125

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

   126

        """

   127

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

   128

        values.update({

   129

            name: control.IsChecked()

   130

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

   131

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

   132

        return values

   133

   134

    def OnOK(self, event):

   135

        """

   136

        Called when dialog OK button is pressed

   137

        Test if step name defined is valid

   138

        @param event: wx.Event from OK button

   139

        """

   140

        message = None

   141

   142

        # Get step name typed by user

   143

        step_name = self.StepName.GetValue()

   144

   145

        # Test that a name have been defined

   146

        if step_name == "":

   147

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

   148

   149

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

   150

        if message is not None:

   151

            self.ShowErrorMessage(message)

   152

   153

        # Test step name validity

   154

        elif self.TestElementName(step_name):

   155

            # Call BlockPreviewDialog function

   156

            BlockPreviewDialog.OnOK(self, event)

   157

   158

    def OnConnectorsChanged(self, event):

   159

        """

   160

        Called when a step connector value changed

   161

        @param event: wx.CheckBoxEvent

   162

        """

   163

        self.RefreshPreview()

   164

        event.Skip()

   165

   166

    def OnNameChanged(self, event):

   167

        """

   168

        Called when step name value changed

   169

        @param event: wx.TextEvent

   170

        """

   171

        self.RefreshPreview()

   172

        event.Skip()

   173

   174

    def RefreshPreview(self):

   175

        """

   176

        Refresh preview panel of graphic element

   177

        Override BlockPreviewDialog function

   178

        """

   179

        # Set graphic element displayed, creating a SFC step element

   180

        self.Element = SFC_Step(self.Preview, 

   181

                                self.StepName.GetValue(), 

   182

                                self.Initial)

   183

   184

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

   185

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

   186

            if control.IsChecked():

   187

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

   188

            else:

   189

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

   190

   191

        # Call BlockPreviewDialog function

   192

        BlockPreviewDialog.RefreshPreview(self)