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

        # Create dialog main sizer

    62

        main_sizer = wx.FlexGridSizer(cols=1, hgap=0, rows=4, vgap=10)

    63

        main_sizer.AddGrowableCol(0)

    64

        main_sizer.AddGrowableRow(0)

    65

    66

        # Create a sizer for dividing FBD block parameters in two columns

    67

        column_sizer = wx.BoxSizer(wx.HORIZONTAL)

    68

        main_sizer.AddSizer(column_sizer, border=20, 

    69

              flag=wx.GROW|wx.TOP|wx.LEFT|wx.RIGHT)

    70

    71

        # Create static box around library panel

    72

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

    73

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

    74

        column_sizer.AddSizer(left_staticboxsizer, 1, border=5, 

    75

              flag=wx.GROW|wx.RIGHT)

    76

    77

        # Create Library panel and add it to static box

    78

        self.LibraryPanel = LibraryPanel(self)

    79

        # Set function to call when selection in Library panel changed

    80

        setattr(self.LibraryPanel, "_OnTreeItemSelected", 

    81

              self.OnLibraryTreeItemSelected)

    82

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

    83

              flag=wx.GROW|wx.TOP)

    84

    85

        # Create sizer for other block parameters and preview panle

    86

        right_gridsizer = wx.FlexGridSizer(cols=1, hgap=0, rows=3, vgap=5)

    87

        right_gridsizer.AddGrowableCol(0)

    88

        right_gridsizer.AddGrowableRow(2)

    89

        column_sizer.AddSizer(right_gridsizer, 1, border=5, 

    90

              flag=wx.GROW|wx.LEFT)

    91

    92

        # Create sizer for other block parameters

    93

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

    94

        top_right_gridsizer.AddGrowableCol(1)

    95

        right_gridsizer.AddSizer(top_right_gridsizer, flag=wx.GROW)

    96

    97

        # Create label for block name

    98

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

    99

        top_right_gridsizer.AddWindow(name_label, 

   100

              flag=wx.ALIGN_CENTER_VERTICAL)

   101

   102

        # Create text control for defining block name

   103

        self.BlockName = wx.TextCtrl(self)

   104

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

   105

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

   106

   107

        # Create label for extended block input number

   108

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

   109

        top_right_gridsizer.AddWindow(inputs_label, 

   110

              flag=wx.ALIGN_CENTER_VERTICAL)

   111

   112

        # Create spin control for defining extended block input number

   113

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

   114

              style=wx.SP_ARROW_KEYS)

   115

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

   116

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

   117

   118

        # Create label for block execution order

   119

        execution_order_label = wx.StaticText(self, 

   120

              label=_('Execution Order:'))

   121

        top_right_gridsizer.AddWindow(execution_order_label, 

   122

              flag=wx.ALIGN_CENTER_VERTICAL)

   123

   124

        # Create spin control for defining block execution order

   125

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

   126

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

   127

                  self.ExecutionOrder)

   128

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

   129

   130

        # Create label for block execution control

   131

        execution_control_label = wx.StaticText(self, 

   132

              label=_('Execution Control:'))

   133

        top_right_gridsizer.AddWindow(execution_control_label, 

   134

              flag=wx.ALIGN_CENTER_VERTICAL)

   135

   136

        # Create check box to enable block execution control

   137

        self.ExecutionControl = wx.CheckBox(self)

   138

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

   139

                  self.ExecutionControl)

   140

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

   141

   142

        # Add preview panel and associated label to sizers

   143

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

   144

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

   145

   146

        # Add buttons sizer to sizers

   147

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

   148

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

   149

   150

        self.SetSizer(main_sizer)

   151

   152

        # Dictionary containing correspondence between parameter exchanged and

   153

        # control to fill with parameter value

   154

        self.ParamsControl = {

   155

            "extension": self.Inputs,

   156

            "executionOrder": self.ExecutionOrder,

   157

            "executionControl": self.ExecutionControl

   158

        }

   159

   160

        # Init controls value and sensibility

   161

        self.BlockName.SetValue("")

   162

        self.BlockName.Enable(False)

   163

        self.Inputs.Enable(False)

   164

   165

        # Variable containing last name typed

   166

        self.CurrentBlockName = None

   167

   168

        # Refresh Library panel values

   169

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

   170

        self.LibraryPanel.SetFocus()

   171

   172

    def OnOK(self, event):

   173

        """

   174

        Called when dialog OK button is pressed

   175

        Test if parameters defined are valid

   176

        @param event: wx.Event from OK button

   177

        """

   178

        message = None

   179

   180

        # Get block type selected

   181

        selected = self.LibraryPanel.GetSelectedBlock()

   182

   183

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

   184

        block_name = self.BlockName.GetValue()

   185

        name_enabled = self.BlockName.IsEnabled()

   186

   187

        # Test that a type has been selected for block

   188

        if selected is None:

   189

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

   190

   191

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

   192

        elif name_enabled and block_name == "":

   193

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

   194

   195

        # Show error message if an error is detected

   196

        if message is not None:

   197

            self.ShowErrorMessage(message)

   198

   199

        # Test block name validity if necessary

   200

        elif not name_enabled or self.TestElementName(block_name):

   201

            # Call BlockPreviewDialog function

   202

            BlockPreviewDialog.OnOK(self, event)

   203

   204

    def SetValues(self, values):

   205

        """

   206

        Set default block parameters

   207

        @param values: Block parameters values

   208

        """

   209

        # Extract block type defined in parameters

   210

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

   211

   212

        # Define regular expression for determine if block name is block

   213

        # default name

   214

        default_name_model = GetBlockTypeDefaultNameModel(blocktype)

   215

   216

        # For each parameters defined, set corresponding control value

   217

        for name, value in values.items():

   218

   219

            # Parameter is block name

   220

            if name == "name":

   221

                if value != "":

   222

                    # Set default graphic element name for testing

   223

                    self.DefaultElementName = value

   224

   225

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

   226

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

   227

                    if default_name_model.match(value) is None:

   228

                        self.CurrentBlockName = value

   229

   230

                self.BlockName.ChangeValue(value)

   231

   232

            # Set value of other controls

   233

            else:

   234

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

   235

                if control is not None:

   236

                    control.SetValue(value)

   237

   238

        # Select block type in library panel    

   239

        if blocktype is not None:

   240

            self.LibraryPanel.SelectTreeItem(blocktype, 

   241

                                             values.get("inputs", None))

   242

   243

        # Refresh preview panel

   244

        self.RefreshPreview()

   245

   246

    def GetValues(self):

   247

        """

   248

        Return block parameters defined in dialog

   249

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

   250

        """

   251

        values = self.LibraryPanel.GetSelectedBlock()

   252

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

   253

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

   254

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

   255

        values.update({

   256

            name: control.GetValue()

   257

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

   258

        return values

   259

   260

    def OnLibraryTreeItemSelected(self, event):

   261

        """

   262

        Called when block type selected in library panel

   263

        @param event: wx.TreeEvent

   264

        """

   265

        # Get type selected in library panel

   266

        values = self.LibraryPanel.GetSelectedBlock()

   267

   268

        # Get block type informations

   269

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

   270

                                                  values["inputs"])

   271

                     if values is not None else None)

   272

   273

        # Set input number spin control according to block type informations

   274

        if blocktype is not None:

   275

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

   276

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

   277

        else:

   278

            self.Inputs.SetValue(2)

   279

            self.Inputs.Enable(False)

   280

   281

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

   282

        # current block name wasn't typed by user

   283

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

   284

            self.BlockName.Enable(True)

   285

   286

            if self.CurrentBlockName is None:

   287

                # Generate new block name according to block type, taking

   288

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

   289

                # block type

   290

                default_name_model = GetBlockTypeDefaultNameModel(values["type"])

   291

                block_name = (

   292

                    self.DefaultElementName

   293

                    if (self.DefaultElementName is not None and 

   294

                        default_name_model.match(self.DefaultElementName))

   295

                    else self.Controller.GenerateNewName(

   296

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

   297

            else:

   298

                block_name = self.CurrentBlockName

   299

   300

            self.BlockName.ChangeValue(block_name)

   301

        else:

   302

            self.BlockName.Enable(False)

   303

            self.BlockName.ChangeValue("")

   304

   305

        # Refresh preview panel

   306

        self.RefreshPreview()

   307

   308

    def OnNameChanged(self, event):

   309

        """

   310

        Called when block name value changed

   311

        @param event: wx.TextEvent

   312

        """

   313

        if self.BlockName.IsEnabled():

   314

            # Save block name typed by user

   315

            self.CurrentBlockName = self.BlockName.GetValue()

   316

            self.RefreshPreview()

   317

        event.Skip()

   318

   319

    def OnInputsChanged(self, event):

   320

        """

   321

        Called when block inputs number changed

   322

        @param event: wx.SpinEvent

   323

        """

   324

        if self.Inputs.IsEnabled():

   325

            self.RefreshPreview()

   326

        event.Skip()

   327

   328

    def OnExecutionOrderChanged(self, event):

   329

        """

   330

        Called when block execution order value changed

   331

        @param event: wx.SpinEvent

   332

        """

   333

        self.RefreshPreview()

   334

        event.Skip()

   335

   336

    def OnExecutionControlChanged(self, event):

   337

        """

   338

        Called when block execution control value changed

   339

        @param event: wx.SpinEvent

   340

        """

   341

        self.RefreshPreview()

   342

        event.Skip()

   343

   344

    def RefreshPreview(self):

   345

        """

   346

        Refresh preview panel of graphic element

   347

        Override BlockPreviewDialog function

   348

        """

   349

        # Get type selected in library panel

   350

        values = self.LibraryPanel.GetSelectedBlock()

   351

   352

        # If a block type is selected in library panel

   353

        if values is not None:

   354

            # Set graphic element displayed, creating a FBD block element

   355

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

   356

                    (self.BlockName.GetValue()

   357

                     if self.BlockName.IsEnabled()

   358

                     else ""), 

   359

                    extension = self.Inputs.GetValue(), 

   360

                    inputs = values["inputs"], 

   361

                    executionControl = self.ExecutionControl.GetValue(), 

   362

                    executionOrder = self.ExecutionOrder.GetValue())

   363

   364

        # Reset graphic element displayed

   365

        else:

   366

            self.Element = None 

   367

   368

        # Call BlockPreviewDialog function

   369

        BlockPreviewDialog.RefreshPreview(self)