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

#                         Set Block Parameters Dialog

    35

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

    36

    37

"""

    38

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

    39

element

    40

"""

    41

    42

class FBDBlockDialog(BlockPreviewDialog):

    43

    44

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

    45

        """

    46

        Constructor

    47

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

    48

        @param controller: Reference to project controller

    49

        @param tagname: Tagname of project POU edited

    50

        """

    51

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

    52

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

    53

    54

        # Create dialog main sizer

    55

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

    56

        main_sizer.AddGrowableCol(0)

    57

        main_sizer.AddGrowableRow(0)

    58

    59

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

    60

        column_sizer = wx.BoxSizer(wx.HORIZONTAL)

    61

        main_sizer.AddSizer(column_sizer, border=20, 

    62

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

    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

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

    68

              flag=wx.GROW|wx.RIGHT)

    69

    70

        # Create Library panel and add it to static box

    71

        self.LibraryPanel = LibraryPanel(self)

    72

        # Set function to call when selection in Library panel changed

    73

        setattr(self.LibraryPanel, "_OnTreeItemSelected", 

    74

              self.OnLibraryTreeItemSelected)

    75

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

    76

              flag=wx.GROW|wx.TOP)

    77

    78

        # Create sizer for other block parameters and preview panle

    79

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

    80

        right_gridsizer.AddGrowableCol(0)

    81

        right_gridsizer.AddGrowableRow(2)

    82

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

    83

              flag=wx.GROW|wx.LEFT)

    84

    85

        # Create sizer for other block parameters

    86

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

    87

        top_right_gridsizer.AddGrowableCol(1)

    88

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

    89

    90

        # Create label for block name

    91

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

    92

        top_right_gridsizer.AddWindow(name_label, 

    93

              flag=wx.ALIGN_CENTER_VERTICAL)

    94

    95

        # Create text control for defining block name

    96

        self.BlockName = wx.TextCtrl(self)

    97

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

    98

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

    99

   100

        # Create label for extended block input number

   101

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

   102

        top_right_gridsizer.AddWindow(inputs_label, 

   103

              flag=wx.ALIGN_CENTER_VERTICAL)

   104

   105

        # Create spin control for defining extended block input number

   106

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

   107

              style=wx.SP_ARROW_KEYS)

   108

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

   109

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

   110

   111

        # Create label for block execution order

   112

        execution_order_label = wx.StaticText(self, 

   113

              label=_('Execution Order:'))

   114

        top_right_gridsizer.AddWindow(execution_order_label, 

   115

              flag=wx.ALIGN_CENTER_VERTICAL)

   116

   117

        # Create spin control for defining block execution order

   118

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

   119

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

   120

                  self.ExecutionOrder)

   121

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

   122

   123

        # Create label for block execution control

   124

        execution_control_label = wx.StaticText(self, 

   125

              label=_('Execution Control:'))

   126

        top_right_gridsizer.AddWindow(execution_control_label, 

   127

              flag=wx.ALIGN_CENTER_VERTICAL)

   128

   129

        # Create check box to enable block execution control

   130

        self.ExecutionControl = wx.CheckBox(self)

   131

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

   132

                  self.ExecutionControl)

   133

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

   134

   135

        # Add preview panel and associated label to sizers

   136

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

   137

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

   138

   139

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

   140

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

   141

   142

        self.SetSizer(main_sizer)

   143

   144

        self.ParamsControl = {

   145

            "extension": self.Inputs,

   146

            "executionOrder": self.ExecutionOrder,

   147

            "executionControl": self.ExecutionControl

   148

        }

   149

   150

        # Init controls value and sensibility

   151

        self.BlockName.SetValue("")

   152

        self.BlockName.Enable(False)

   153

        self.Inputs.Enable(False)

   154

   155

        # Variable containing last name typed

   156

        self.CurrentBlockName = None

   157

   158

        # Refresh Library panel values

   159

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

   160

        self.LibraryPanel.SetFocus()

   161

   162

    def OnOK(self, event):

   163

        """

   164

        Called when dialog OK button is pressed

   165

        Test if parameters defined are valid

   166

        @param event: wx.Event from OK button

   167

        """

   168

        message = None

   169

   170

        # Get block type selected

   171

        selected = self.LibraryPanel.GetSelectedBlock()

   172

   173

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

   174

        block_name = self.BlockName.GetValue()

   175

        name_enabled = self.BlockName.IsEnabled()

   176

   177

        # Test that a type has been selected for block

   178

        if selected is None:

   179

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

   180

   181

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

   182

        elif name_enabled and block_name == "":

   183

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

   184

   185

        # Show error message if an error is detected

   186

        if message is not None:

   187

            self.ShowMessage(message)

   188

   189

        # Test block name validity if necessary

   190

        elif not name_enabled or self.TestBlockName(block_name):

   191

            BlockPreviewDialog.OnOK(self, event)

   192

   193

    def SetValues(self, values):

   194

        """

   195

        Set default block parameters

   196

        @param values: Block parameters values

   197

        """

   198

        # Extract block type defined in parameters

   199

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

   200

   201

        # Define regular expression for determine if block name is block

   202

        # default name

   203

        default_name_model = re.compile(

   204

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

   205

   206

        # Select block type in library panel    

   207

        if blocktype is not None:

   208

            self.LibraryPanel.SelectTreeItem(blocktype, 

   209

                                             values.get("inputs", None))

   210

   211

        # For each parameters defined, set corresponding control value

   212

        for name, value in values.items():

   213

            if name == "name":

   214

                # Parameter is block name

   215

                if value != "":

   216

                    # Set default block name for testing

   217

                    self.DefaultBlockName = value

   218

   219

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

   220

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

   221

                    if default_name_model.match(value) is None:

   222

                        self.CurrentBlockName = value

   223

   224

                self.BlockName.ChangeValue(value)

   225

   226

            else:

   227

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

   228

                if control is not None:

   229

                    control.SetValue(value)

   230

   231

        # Refresh preview panel

   232

        self.RefreshPreview()

   233

   234

    def GetValues(self):

   235

        """

   236

        Return block parameters defined in dialog

   237

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

   238

        """

   239

        values = self.LibraryPanel.GetSelectedBlock()

   240

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

   241

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

   242

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

   243

        values.update({

   244

            name: control.GetValue()

   245

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

   246

        return values

   247

   248

    def OnLibraryTreeItemSelected(self, event):

   249

        """

   250

        Called when block type selected in library panel

   251

        @param event: wx.TreeEvent

   252

        """

   253

        # Get type selected in library panel

   254

        values = self.LibraryPanel.GetSelectedBlock()

   255

   256

        # Get block type informations

   257

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

   258

                                                  values["inputs"])

   259

                     if values is not None else None)

   260

   261

        # Set input number spin control according to block type informations

   262

        if blocktype is not None:

   263

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

   264

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

   265

        else:

   266

            self.Inputs.SetValue(2)

   267

            self.Inputs.Enable(False)

   268

   269

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

   270

        # current block name wasn't typed by user

   271

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

   272

            self.BlockName.Enable(True)

   273

            self.BlockName.ChangeValue(

   274

                self.CurrentBlockName

   275

                if self.CurrentBlockName is not None

   276

                else self.Controller.GenerateNewName(

   277

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

   278

        else:

   279

            self.BlockName.Enable(False)

   280

            self.BlockName.ChangeValue("")

   281

   282

        # Refresh preview panel

   283

        self.RefreshPreview()

   284

   285

    def OnNameChanged(self, event):

   286

        """

   287

        Called when block name value changed

   288

        @param event: wx.TextEvent

   289

        """

   290

        if self.BlockName.IsEnabled():

   291

            # Save block name typed by user

   292

            self.CurrentBlockName = self.BlockName.GetValue()

   293

            self.RefreshPreview()

   294

        event.Skip()

   295

   296

    def OnInputsChanged(self, event):

   297

        """

   298

        Called when block inputs number changed

   299

        @param event: wx.SpinEvent

   300

        """

   301

        if self.Inputs.IsEnabled():

   302

            self.RefreshPreview()

   303

        event.Skip()

   304

   305

    def OnExecutionOrderChanged(self, event):

   306

        """

   307

        Called when block execution order value changed

   308

        @param event: wx.SpinEvent

   309

        """

   310

        self.RefreshPreview()

   311

        event.Skip()

   312

   313

    def OnExecutionControlChanged(self, event):

   314

        """

   315

        Called when block execution control value changed

   316

        @param event: wx.SpinEvent

   317

        """

   318

        self.RefreshPreview()

   319

        event.Skip()

   320

   321

    def RefreshPreview(self):

   322

        """

   323

        Refresh preview panel of graphic element

   324

        Override BlockPreviewDialog function

   325

        """

   326

        # Get type selected in library panel

   327

        values = self.LibraryPanel.GetSelectedBlock()

   328

   329

        # If a block type is selected in library panel

   330

        if values is not None:

   331

            blockname = (self.BlockName.GetValue()

   332

                         if self.BlockName.IsEnabled()

   333

                         else "")

   334

   335

            # Set graphic element displayed, creating a FBD block element

   336

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

   337

                    blockname, 

   338

                    extension = self.Inputs.GetValue(), 

   339

                    inputs = values["inputs"], 

   340

                    executionControl = self.ExecutionControl.GetValue(), 

   341

                    executionOrder = self.ExecutionOrder.GetValue())

   342

   343

        # Reset graphic element displayed

   344

        else:

   345

            self.Block = None 

   346

   347

        # Call BlockPreviewDialog function

   348

        BlockPreviewDialog.RefreshPreview(self)