1

# -*- coding: utf-8 -*-

     2

     3

#This file is part of PLCOpenEditor, a library implementing an IEC 61131-3 editor

     4

#based on the plcopen standard. 

     5

#

     6

#Copyright (C) 2007: Edouard TISSERANT and Laurent BESSARD

     7

#

     8

#See COPYING file for copyrights details.

     9

#

    10

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

    11

#modify it under the terms of the GNU General Public

    12

#License as published by the Free Software Foundation; either

    13

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

    14

#

    15

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

    16

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

    17

#MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

    18

#General Public License for more details.

    19

#

    20

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

    21

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

    22

#Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

    23

    24

import wx

    25

    26

from graphics.SFC_Objects import SFC_Step

    27

from BlockPreviewDialog import BlockPreviewDialog

    28

    29

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

    30

#                         Set SFC Step Parameters Dialog

    31

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

    32

    33

"""

    34

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

    35

element

    36

"""

    37

    38

class SFCStepDialog(BlockPreviewDialog):

    39

    40

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

    41

        """

    42

        Constructor

    43

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

    44

        @param controller: Reference to project controller

    45

        @param tagname: Tagname of project POU edited

    46

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

    47

        """

    48

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

    50

    51

        # Init common sizers

    52

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

    53

    54

        # Create label for SFC step name

    55

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

    56

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

    57

    58

        # Create text control for defining SFC step name

    59

        self.StepName = wx.TextCtrl(self)

    60

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

    61

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

    62

    63

        # Create label for SFC step connectors

    64

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

    65

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

    66

    67

        # Create check boxes for defining connectors available on SFC step

    68

        self.ConnectorsCheckBox = {}

    69

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

    70

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

    71

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

    72

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

    73

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

    74

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

    75

            self.ConnectorsCheckBox[name] = check_box

    76

    77

        # Add preview panel and associated label to sizers

    78

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

    79

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

    80

    81

        # Add buttons sizer to sizers

    82

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

    83

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

    84

    85

        # Save flag that indicates that step is initial

    86

        self.Initial = initial

    87

    88

        # Set default name for step

    89

        self.StepName.ChangeValue(controller.GenerateNewName(

    90

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

    91

    92

        # Step name text control is default control having keyboard focus

    93

        self.StepName.SetFocus()

    94

    95

    def SetValues(self, values):

    96

        """

    97

        Set default block parameters

    98

        @param values: Block parameters values

    99

        """

   100

        # For each parameters defined, set corresponding control value

   101

        for name, value in values.items():

   102

   103

            # Parameter is step name

   104

            if name == "name":

   105

                self.StepName.ChangeValue(value)

   106

   107

            # Set value of other controls

   108

            else:

   109

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

   110

                if control is not None:

   111

                    control.SetValue(value)

   112

   113

        # Refresh preview panel

   114

        self.RefreshPreview()

   115

   116

    def GetValues(self):

   117

        """

   118

        Return step parameters defined in dialog

   119

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

   120

        """

   121

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

   122

        values.update({

   123

            name: control.IsChecked()

   124

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

   125

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

   126

        return values

   127

   128

    def OnOK(self, event):

   129

        """

   130

        Called when dialog OK button is pressed

   131

        Test if step name defined is valid

   132

        @param event: wx.Event from OK button

   133

        """

   134

        message = None

   135

   136

        # Get step name typed by user

   137

        step_name = self.StepName.GetValue()

   138

   139

        # Test that a name have been defined

   140

        if step_name == "":

   141

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

   142

   143

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

   144

        if message is not None:

   145

            self.ShowErrorMessage(message)

   146

   147

        # Test step name validity

   148

        elif self.TestElementName(step_name):

   149

            # Call BlockPreviewDialog function

   150

            BlockPreviewDialog.OnOK(self, event)

   151

   152

    def OnConnectorsChanged(self, event):

   153

        """

   154

        Called when a step connector value changed

   155

        @param event: wx.CheckBoxEvent

   156

        """

   157

        self.RefreshPreview()

   158

        event.Skip()

   159

   160

    def OnNameChanged(self, event):

   161

        """

   162

        Called when step name value changed

   163

        @param event: wx.TextEvent

   164

        """

   165

        self.RefreshPreview()

   166

        event.Skip()

   167

   168

    def RefreshPreview(self):

   169

        """

   170

        Refresh preview panel of graphic element

   171

        Override BlockPreviewDialog function

   172

        """

   173

        # Set graphic element displayed, creating a SFC step element

   174

        self.Element = SFC_Step(self.Preview, 

   175

                                self.StepName.GetValue(), 

   176

                                self.Initial)

   177

   178

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

   179

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

   180

            if control.IsChecked():

   181

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

   182

            else:

   183

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

   184

   185

        # Call BlockPreviewDialog function

   186

        BlockPreviewDialog.RefreshPreview(self)