1

#!/usr/bin/env python

     2

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

     3

     4

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

     5

#based on the plcopen standard. 

     6

#

     7

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

     8

#

     9

#See COPYING file for copyrights details.

    10

#

    11

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

    12

#modify it under the terms of the GNU General Public

    13

#License as published by the Free Software Foundation; either

    14

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

    15

#

    16

#This library 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 GNU

    19

#General Public License for more details.

    20

#

    21

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

    22

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

    23

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

    24

    25

import re

    26

    27

import wx

    28

    29

from graphics.FBD_Objects import FBD_Block

    30

from controls.LibraryPanel import LibraryPanel

    31

from BlockPreviewDialog import BlockPreviewDialog

    32

    33

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

    34

#                                    Helpers

    35

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

    36

    37

def GetBlockTypeDefaultNameModel(blocktype):

    38

    return re.compile("%s[0-9]+" % blocktype if blocktype is not None else ".*")

    39

    40

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

    41

#                         Set Block Parameters Dialog

    42

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

    43

    44

"""

    45

Class that implements a dialog for defining parameters of a FBD block graphic

    46

element

    47

"""

    48

    49

class FBDBlockDialog(BlockPreviewDialog):

    50

    51

    def __init__(self, parent, controller, tagname):

    52

        """

    53

        Constructor

    54

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

    55

        @param controller: Reference to project controller

    56

        @param tagname: Tagname of project POU edited

    57

        """

    58

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

    59

              size=wx.Size(600, 450), title=_('Block Properties'))

    60

    61

        # Init common sizers

    62

        self._init_sizers(2, 0, 1, 0, 3, 2)

    63

    64

        # Create static box around library panel

    65

        type_staticbox = wx.StaticBox(self, label=_('Type:'))

    66

        left_staticboxsizer = wx.StaticBoxSizer(type_staticbox, wx.VERTICAL)

    67

        self.LeftGridSizer.AddSizer(left_staticboxsizer, border=5, flag=wx.GROW)

    68

    69

        # Create Library panel and add it to static box

    70

        self.LibraryPanel = LibraryPanel(self)

    71

        # Set function to call when selection in Library panel changed

    72

        setattr(self.LibraryPanel, "_OnTreeItemSelected", 

    73

              self.OnLibraryTreeItemSelected)

    74

        left_staticboxsizer.AddWindow(self.LibraryPanel, 1, border=5, 

    75

              flag=wx.GROW|wx.TOP)

    76

    77

        # Create sizer for other block parameters

    78

        top_right_gridsizer = wx.FlexGridSizer(cols=2, hgap=0, rows=4, vgap=5)

    79

        top_right_gridsizer.AddGrowableCol(1)

    80

        self.RightGridSizer.AddSizer(top_right_gridsizer, flag=wx.GROW)

    81

    82

        # Create label for block name

    83

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

    84

        top_right_gridsizer.AddWindow(name_label, 

    85

              flag=wx.ALIGN_CENTER_VERTICAL)

    86

    87

        # Create text control for defining block name

    88

        self.BlockName = wx.TextCtrl(self)

    89

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

    90

        top_right_gridsizer.AddWindow(self.BlockName, flag=wx.GROW)

    91

    92

        # Create label for extended block input number

    93

        inputs_label = wx.StaticText(self, label=_('Inputs:'))

    94

        top_right_gridsizer.AddWindow(inputs_label, 

    95

              flag=wx.ALIGN_CENTER_VERTICAL)

    96

    97

        # Create spin control for defining extended block input number

    98

        self.Inputs = wx.SpinCtrl(self, min=2, max=20,

    99

              style=wx.SP_ARROW_KEYS)

   100

        self.Bind(wx.EVT_SPINCTRL, self.OnInputsChanged, self.Inputs)

   101

        top_right_gridsizer.AddWindow(self.Inputs, flag=wx.GROW)

   102

   103

        # Create label for block execution order

   104

        execution_order_label = wx.StaticText(self, 

   105

              label=_('Execution Order:'))

   106

        top_right_gridsizer.AddWindow(execution_order_label, 

   107

              flag=wx.ALIGN_CENTER_VERTICAL)

   108

   109

        # Create spin control for defining block execution order

   110

        self.ExecutionOrder = wx.SpinCtrl(self, min=0, style=wx.SP_ARROW_KEYS)

   111

        self.Bind(wx.EVT_SPINCTRL, self.OnExecutionOrderChanged, 

   112

                  self.ExecutionOrder)

   113

        top_right_gridsizer.AddWindow(self.ExecutionOrder, flag=wx.GROW)

   114

   115

        # Create label for block execution control

   116

        execution_control_label = wx.StaticText(self, 

   117

              label=_('Execution Control:'))

   118

        top_right_gridsizer.AddWindow(execution_control_label, 

   119

              flag=wx.ALIGN_CENTER_VERTICAL)

   120

   121

        # Create check box to enable block execution control

   122

        self.ExecutionControl = wx.CheckBox(self)

   123

        self.Bind(wx.EVT_CHECKBOX, self.OnExecutionOrderChanged, 

   124

                  self.ExecutionControl)

   125

        top_right_gridsizer.AddWindow(self.ExecutionControl, flag=wx.GROW)

   126

   127

        # Add preview panel and associated label to sizers

   128

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

   129

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

   130

   131

        # Add buttons sizer to sizers

   132

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

   133

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

   134

   135

        # Dictionary containing correspondence between parameter exchanged and

   136

        # control to fill with parameter value

   137

        self.ParamsControl = {

   138

            "extension": self.Inputs,

   139

            "executionOrder": self.ExecutionOrder,

   140

            "executionControl": self.ExecutionControl

   141

        }

   142

   143

        # Init controls value and sensibility

   144

        self.BlockName.SetValue("")

   145

        self.BlockName.Enable(False)

   146

        self.Inputs.Enable(False)

   147

   148

        # Variable containing last name typed

   149

        self.CurrentBlockName = None

   150

   151

        # Refresh Library panel values

   152

        self.LibraryPanel.SetBlockList(controller.GetBlockTypes(tagname))

   153

        self.LibraryPanel.SetFocus()

   154

   155

    def SetValues(self, values):

   156

        """

   157

        Set default block parameters

   158

        @param values: Block parameters values

   159

        """

   160

        # Extract block type defined in parameters

   161

        blocktype = values.get("type", None)

   162

   163

        # Select block type in library panel    

   164

        if blocktype is not None:

   165

            self.LibraryPanel.SelectTreeItem(blocktype, 

   166

                                             values.get("inputs", None))

   167

   168

        # Define regular expression for determine if block name is block

   169

        # default name

   170

        default_name_model = GetBlockTypeDefaultNameModel(blocktype)

   171

   172

        # For each parameters defined, set corresponding control value

   173

        for name, value in values.items():

   174

   175

            # Parameter is block name

   176

            if name == "name":

   177

                if value != "":

   178

                    # Set default graphic element name for testing

   179

                    self.DefaultElementName = value

   180

   181

                    # Test if block name is type default block name and save

   182

                    # block name if not (name have been typed by user)

   183

                    if default_name_model.match(value) is None:

   184

                        self.CurrentBlockName = value

   185

   186

                self.BlockName.ChangeValue(value)

   187

   188

            # Set value of other controls

   189

            else:

   190

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

   191

                if control is not None:

   192

                    control.SetValue(value)

   193

   194

        # Refresh preview panel

   195

        self.RefreshPreview()

   196

   197

    def GetValues(self):

   198

        """

   199

        Return block parameters defined in dialog

   200

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

   201

        """

   202

        values = self.LibraryPanel.GetSelectedBlock()

   203

        if self.BlockName.IsEnabled() and self.BlockName.GetValue() != "":

   204

            values["name"] = self.BlockName.GetValue()

   205

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

   206

        values.update({

   207

            name: control.GetValue()

   208

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

   209

        return values

   210

   211

    def OnOK(self, event):

   212

        """

   213

        Called when dialog OK button is pressed

   214

        Test if parameters defined are valid

   215

        @param event: wx.Event from OK button

   216

        """

   217

        message = None

   218

   219

        # Get block type selected

   220

        selected = self.LibraryPanel.GetSelectedBlock()

   221

   222

        # Get block type name and if block is a function block

   223

        block_name = self.BlockName.GetValue()

   224

        name_enabled = self.BlockName.IsEnabled()

   225

   226

        # Test that a type has been selected for block

   227

        if selected is None:

   228

            message = _("Form isn't complete. Valid block type must be selected!")

   229

   230

        # Test, if block is a function block, that a name have been defined

   231

        elif name_enabled and block_name == "":

   232

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

   233

   234

        # Show error message if an error is detected

   235

        if message is not None:

   236

            self.ShowErrorMessage(message)

   237

   238

        # Test block name validity if necessary

   239

        elif not name_enabled or self.TestElementName(block_name):

   240

            # Call BlockPreviewDialog function

   241

            BlockPreviewDialog.OnOK(self, event)

   242

   243

    def OnLibraryTreeItemSelected(self, event):

   244

        """

   245

        Called when block type selected in library panel

   246

        @param event: wx.TreeEvent

   247

        """

   248

        # Get type selected in library panel

   249

        values = self.LibraryPanel.GetSelectedBlock()

   250

   251

        # Get block type informations

   252

        blocktype = (self.Controller.GetBlockType(values["type"], 

   253

                                                  values["inputs"])

   254

                     if values is not None else None)

   255

   256

        # Set input number spin control according to block type informations

   257

        if blocktype is not None:

   258

            self.Inputs.SetValue(len(blocktype["inputs"]))

   259

            self.Inputs.Enable(blocktype["extensible"])

   260

        else:

   261

            self.Inputs.SetValue(2)

   262

            self.Inputs.Enable(False)

   263

   264

        # Update block name with default value if block type is a function and

   265

        # current block name wasn't typed by user

   266

        if blocktype is not None and blocktype["type"] != "function":

   267

            self.BlockName.Enable(True)

   268

   269

            if self.CurrentBlockName is None:

   270

                # Generate new block name according to block type, taking

   271

                # default element name if it was already a default name for this

   272

                # block type

   273

                default_name_model = GetBlockTypeDefaultNameModel(values["type"])

   274

                block_name = (

   275

                    self.DefaultElementName

   276

                    if (self.DefaultElementName is not None and 

   277

                        default_name_model.match(self.DefaultElementName))

   278

                    else self.Controller.GenerateNewName(

   279

                        self.TagName, None, values["type"]+"%d", 0))

   280

            else:

   281

                block_name = self.CurrentBlockName

   282

   283

            self.BlockName.ChangeValue(block_name)

   284

        else:

   285

            self.BlockName.Enable(False)

   286

            self.BlockName.ChangeValue("")

   287

   288

        # Refresh preview panel

   289

        self.RefreshPreview()

   290

   291

    def OnNameChanged(self, event):

   292

        """

   293

        Called when block name value changed

   294

        @param event: wx.TextEvent

   295

        """

   296

        if self.BlockName.IsEnabled():

   297

            # Save block name typed by user

   298

            self.CurrentBlockName = self.BlockName.GetValue()

   299

            self.RefreshPreview()

   300

        event.Skip()

   301

   302

    def OnInputsChanged(self, event):

   303

        """

   304

        Called when block inputs number changed

   305

        @param event: wx.SpinEvent

   306

        """

   307

        if self.Inputs.IsEnabled():

   308

            self.RefreshPreview()

   309

        event.Skip()

   310

   311

    def OnExecutionOrderChanged(self, event):

   312

        """

   313

        Called when block execution order value changed

   314

        @param event: wx.SpinEvent

   315

        """

   316

        self.RefreshPreview()

   317

        event.Skip()

   318

   319

    def OnExecutionControlChanged(self, event):

   320

        """

   321

        Called when block execution control value changed

   322

        @param event: wx.SpinEvent

   323

        """

   324

        self.RefreshPreview()

   325

        event.Skip()

   326

   327

    def RefreshPreview(self):

   328

        """

   329

        Refresh preview panel of graphic element

   330

        Override BlockPreviewDialog function

   331

        """

   332

        # Get type selected in library panel

   333

        values = self.LibraryPanel.GetSelectedBlock()

   334

   335

        # If a block type is selected in library panel

   336

        if values is not None:

   337

            # Set graphic element displayed, creating a FBD block element

   338

            self.Element = FBD_Block(self.Preview, values["type"], 

   339

                    (self.BlockName.GetValue()

   340

                     if self.BlockName.IsEnabled()

   341

                     else ""), 

   342

                    extension = self.Inputs.GetValue(), 

   343

                    inputs = values["inputs"], 

   344

                    executionControl = self.ExecutionControl.GetValue(), 

   345

                    executionOrder = self.ExecutionOrder.GetValue())

   346

   347

        # Reset graphic element displayed

   348

        else:

   349

            self.Element = None 

   350

   351

        # Call BlockPreviewDialog function

   352

        BlockPreviewDialog.RefreshPreview(self)