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 wx

    26

    27

from GraphicCommons import *

    28

from plcopen.structures import *

    29

from plcopen.structures import IsOfType

    30

    31

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

    32

#                         Function Block Diagram Block

    33

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

    34

    35

"""

    36

Class that implements the graphic representation of a function block

    37

"""

    38

    39

class FBD_Block(Graphic_Element):

    40

    41

    # Create a new block

    42

    def __init__(self, parent, type, name, id = None, extension = 0, inputs = None, connectors = {}, executionOrder = 0):

    43

        Graphic_Element.__init__(self, parent)

    44

        self.Type = None

    45

        self.Extension = None

    46

        self.Id = id

    47

        self.SetName(name)

    48

        self.SetExecutionOrder(executionOrder)

    49

        self.Inputs = []

    50

        self.Outputs = []

    51

        self.Colour = wx.BLACK

    52

        self.Pen = wx.BLACK_PEN

    53

        self.SetType(type, extension, inputs, connectors)

    54

    55

    # Make a clone of this FBD_Block

    56

    def Clone(self, id = None, name = "", pos = None):

    57

        if self.Name != "" and name == "":

    58

            name = self.Name

    59

        block = FBD_Block(self.Parent, self.Type, name, id, self.Extension)

    60

        block.SetSize(self.Size[0], self.Size[1])

    61

        if pos is not None:

    62

            block.SetPosition(pos.x, pos.y)

    63

        block.Inputs = [input.Clone(block) for input in self.Inputs]

    64

        block.Outputs = [output.Clone(block) for output in self.Outputs]

    65

        return block

    66

    67

    # Destructor

    68

    def __del__(self):

    69

        self.Inputs = []

    70

        self.Outputs = []

    71

    72

    # Returns the RedrawRect

    73

    def GetRedrawRect(self, movex = 0, movey = 0):

    74

        rect = Graphic_Element.GetRedrawRect(self, movex, movey)

    75

        if movex != 0 or movey != 0:

    76

            for input in self.Inputs:

    77

                if input.IsConnected():

    78

                    rect = rect.Union(input.GetConnectedRedrawRect(movex, movey))

    79

            for output in self.Outputs:

    80

                if output.IsConnected():

    81

                    rect = rect.Union(output.GetConnectedRedrawRect(movex, movey))

    82

        return rect

    83

    84

    # Delete this block by calling the appropriate method

    85

    def Delete(self):

    86

        self.Parent.DeleteBlock(self)

    87

    88

    # Unconnect all inputs and outputs

    89

    def Clean(self):

    90

        for input in self.Inputs:

    91

            input.UnConnect(delete = True)

    92

        for output in self.Outputs:

    93

            output.UnConnect(delete = True)

    94

    95

    # Refresh the size of text for name

    96

    def RefreshNameSize(self):

    97

        dc = wx.ClientDC(self.Parent)

    98

        self.NameSize = dc.GetTextExtent(self.Name)

    99

   100

    # Refresh the size of text for execution order

   101

    def RefreshExecutionOrderSize(self):

   102

        dc = wx.ClientDC(self.Parent)

   103

        self.ExecutionOrderSize = dc.GetTextExtent(str(self.ExecutionOrder))

   104

   105

    # Refresh the block bounding box

   106

    def RefreshBoundingBox(self):

   107

        # Calculate the size of the name outside the block

   108

        text_width, text_height = self.NameSize

   109

        # Calculate the bounding box size

   110

        bbx_x = self.Pos.x - max(min(1, len(self.Inputs)) * CONNECTOR_SIZE, (text_width - self.Size[0]) / 2)

   111

        bbx_width = self.Size[0] + 1 + (min(1, len(self.Inputs)) + min(1, len(self.Outputs))) * CONNECTOR_SIZE

   112

        if self.Name != "":

   113

            bbx_y = self.Pos.y - (text_height + 2)

   114

            bbx_height = self.Size[1] + (text_height + 2)

   115

        else:

   116

            bbx_y = self.Pos.y

   117

            bbx_height = self.Size[1]

   118

        if self.ExecutionOrder != 0:

   119

            bbx_x = min(bbx_x, self.Pos.x + self.Size[0] - self.ExecutionOrderSize[0])

   120

            bbx_width = max(bbx_width, bbx_width + self.Pos.x + self.ExecutionOrderSize[0] - bbx_x - self.Size[0])

   121

            bbx_height = bbx_height + (self.ExecutionOrderSize[1] + 2)

   122

        self.BoundingBox = wx.Rect(bbx_x, bbx_y, bbx_width + 1, bbx_height + 1)

   123

   124

    # Refresh the positions of the block connectors

   125

    def RefreshConnectors(self):

   126

        scaling = self.Parent.GetScaling()

   127

        # Calculate the size for the connector lines

   128

        lines = max(len(self.Inputs), len(self.Outputs))

   129

        if lines > 0:

   130

            linesize = max((self.Size[1] - BLOCK_LINE_SIZE) / lines, BLOCK_LINE_SIZE)

   131

            # Update inputs and outputs positions

   132

            position = BLOCK_LINE_SIZE + linesize / 2

   133

            for i in xrange(lines):

   134

                if scaling is not None:

   135

                    ypos = round(float(self.Pos.y + position) / float(scaling[1])) * scaling[1] - self.Pos.y

   136

                else:

   137

                    ypos = position

   138

                if i < len(self.Inputs):

   139

                    self.Inputs[i].SetPosition(wx.Point(0, ypos))

   140

                if i < len(self.Outputs):

   141

                    self.Outputs[i].SetPosition(wx.Point(self.Size[0], ypos))

   142

                position += linesize

   143

        self.RefreshConnected()

   144

   145

    # Refresh the positions of wires connected to inputs and outputs

   146

    def RefreshConnected(self, exclude = []):

   147

        for input in self.Inputs:

   148

            input.MoveConnected(exclude)

   149

        for output in self.Outputs:

   150

            output.MoveConnected(exclude)

   151

   152

    # Returns the block connector that starts with the point given if it exists 

   153

    def GetConnector(self, position, name = None):

   154

        # if a name is given

   155

        if name:

   156

            # Test each input and output connector

   157

            for input in self.Inputs:

   158

                if name == input.GetName():

   159

                    return input

   160

            for output in self.Outputs:

   161

                if name == output.GetName():

   162

                    return output

   163

        # Test each input connector

   164

        for input in self.Inputs:

   165

            input_pos = input.GetRelPosition()

   166

            if position.x == self.Pos.x + input_pos.x and position.y == self.Pos.y + input_pos.y:

   167

                return input

   168

        # Test each output connector

   169

        for output in self.Outputs:

   170

            output_pos = output.GetRelPosition()

   171

            if position.x == self.Pos.x + output_pos.x and position.y == self.Pos.y + output_pos.y:

   172

                return output

   173

        return None

   174

   175

    def GetInputTypes(self):

   176

        return tuple([input.GetType(True) for input in self.Inputs])

   177

   178

    def SetOutputValues(self, values):

   179

        for output in self.Outputs:

   180

            output.SetValue(values.get(ouput.getName(), None))

   181

   182

    def GetConnectionResultType(self, connector, connectortype):

   183

        resulttype = connectortype

   184

        for input in self.Inputs:

   185

            name = input.GetName()

   186

            if input != connector and (name.startswith("IN") or name in ["MN", "MX"]):

   187

                inputtype = input.GetConnectedType()

   188

                if resulttype is None or inputtype is not None and IsOfType(inputtype, resulttype):

   189

                    resulttype = inputtype

   190

        for output in self.Outputs:

   191

            name = output.GetName()

   192

            if output != connector and name == "OUT" and not IsEndType(output.GetType()):

   193

                outputtype = output.GetConnectedType()

   194

                if resulttype is None or outputtype is not None and IsOfType(outputtype, resulttype):

   195

                    resulttype = outputtype

   196

        return resulttype

   197

   198

    # Returns all the block connectors

   199

    def GetConnectors(self):

   200

        return {"inputs" : self.Inputs, "outputs" : self.Outputs}

   201

   202

    # Test if point given is on one of the block connectors

   203

    def TestConnector(self, pt, exclude = True):

   204

        # Test each input connector

   205

        for input in self.Inputs:

   206

            if input.TestPoint(pt, exclude):

   207

                return input

   208

        # Test each output connector

   209

        for output in self.Outputs:

   210

            if output.TestPoint(pt, exclude):

   211

                return output

   212

        return None

   213

   214

    # Changes the block type

   215

    def SetType(self, type, extension, inputs = None, connectors = {}):

   216

        if type != self.Type or self.Extension != extension: 

   217

            if type != self.Type:

   218

                self.Type = type

   219

                dc = wx.ClientDC(self.Parent)

   220

                self.TypeSize = dc.GetTextExtent(self.Type)

   221

            self.Extension = extension

   222

            # Find the block definition from type given and create the corresponding

   223

            # inputs and outputs

   224

            blocktype = GetBlockType(type, inputs)

   225

            if blocktype:

   226

                self.Colour = wx.BLACK

   227

                inputs = [input for input in blocktype["inputs"]]

   228

                outputs = [output for output in blocktype["outputs"]]

   229

                if blocktype["extensible"]:

   230

                    start = int(inputs[-1][0].replace("IN", ""))

   231

                    for i in xrange(self.Extension - len(blocktype["inputs"])):

   232

                        start += 1

   233

                        inputs.append(("IN%d"%start, inputs[-1][1], inputs[-1][2]))

   234

            else:

   235

                self.Colour = wx.RED

   236

                if "inputs" in connectors:

   237

                    inputs = connectors["inputs"]

   238

                else:

   239

                    inputs = []

   240

                if "outputs" in connectors:

   241

                    outputs = connectors["outputs"]

   242

                else:

   243

                    outputs = []

   244

            self.Pen = wx.Pen(self.Colour)

   245

            self.Clean()

   246

            # Extract the inputs properties and create the corresponding connector

   247

            self.Inputs = []

   248

            for input_name, input_type, input_modifier in inputs:

   249

                connector = Connector(self, input_name, input_type, wx.Point(0, 0), WEST, onlyone = True)

   250

                if input_modifier == "negated":

   251

                    connector.SetNegated(True)

   252

                elif input_modifier != "none":

   253

                    connector.SetEdge(input_modifier)

   254

                self.Inputs.append(connector)

   255

            # Extract the outputs properties and create the corresponding connector

   256

            self.Outputs = []

   257

            for output_name, output_type, output_modifier in outputs:

   258

                connector = Connector(self, output_name, output_type, wx.Point(0, 0), EAST)

   259

                if output_modifier == "negated":

   260

                    connector.SetNegated(True)

   261

                elif output_modifier != "none":

   262

                    connector.SetEdge(output_modifier)

   263

                self.Outputs.append(connector)

   264

            self.RefreshMinSize()

   265

            self.RefreshConnectors()

   266

            self.RefreshBoundingBox()

   267

   268

    # Returns the block type

   269

    def GetType(self):

   270

        return self.Type

   271

   272

    # Changes the block name

   273

    def SetName(self, name):

   274

        self.Name = name

   275

        self.RefreshNameSize()

   276

   277

    # Returs the block name

   278

    def GetName(self):

   279

        return self.Name

   280

   281

    # Changes the extension name

   282

    def SetExtension(self, extension):

   283

        self.Extension = extension

   284

   285

    # Returs the extension name

   286

    def GetExtension(self):

   287

        return self.Extension

   288

   289

    # Changes the execution order

   290

    def SetExecutionOrder(self, executionOrder):

   291

        self.ExecutionOrder = executionOrder

   292

        self.RefreshExecutionOrderSize()

   293

   294

    # Returs the execution order

   295

    def GetExecutionOrder(self):

   296

        return self.ExecutionOrder

   297

   298

    # Refresh the block minimum size

   299

    def RefreshMinSize(self):

   300

        # Calculate the inputs maximum width

   301

        max_input = 0

   302

        for input in self.Inputs:

   303

            w, h = input.GetNameSize()

   304

            max_input = max(max_input, w)

   305

        # Calculate the outputs maximum width

   306

        max_output = 0

   307

        for output in self.Outputs:

   308

            w, h = output.GetNameSize()

   309

            max_output = max(max_output, w)

   310

        width = max(self.TypeSize[0] + 10, max_input + max_output + 15)

   311

        height = (max(len(self.Inputs), len(self.Outputs)) + 1) * BLOCK_LINE_SIZE

   312

        self.MinSize = width, height

   313

   314

    # Returns the block minimum size

   315

    def GetMinSize(self):

   316

        return self.MinSize

   317

   318

    # Changes the negated property of the connector handled

   319

    def SetConnectorNegated(self, negated):

   320

        handle_type, handle = self.Handle

   321

        if handle_type == HANDLE_CONNECTOR:

   322

            handle.SetNegated(negated)

   323

            self.RefreshModel(False)

   324

   325

    # Changes the edge property of the connector handled

   326

    def SetConnectorEdge(self, edge):

   327

        handle_type, handle = self.Handle

   328

        if handle_type == HANDLE_CONNECTOR:

   329

            handle.SetEdge(edge)

   330

            self.RefreshModel(False)

   331

   332

    # Method called when a LeftDClick event have been generated

   333

    def OnLeftDClick(self, event, dc, scaling):

   334

        # Edit the block properties

   335

        self.Parent.EditBlockContent(self)

   336

   337

    # Method called when a RightUp event have been generated

   338

    def OnRightUp(self, event, dc, scaling):

   339

        pos = GetScaledEventPosition(event, dc, scaling)

   340

        # Popup the menu with special items for a block and a connector if one is handled

   341

        connector = self.TestConnector(pos, False)

   342

        if connector:

   343

            self.Handle = (HANDLE_CONNECTOR, connector)

   344

            self.Parent.PopupBlockMenu(connector)

   345

        else:

   346

            self.Parent.PopupBlockMenu()

   347

   348

    # Refreshes the block model

   349

    def RefreshModel(self, move=True):

   350

        self.Parent.RefreshBlockModel(self)

   351

        # If block has moved, refresh the model of wires connected to outputs

   352

        if move:

   353

            for output in self.Outputs:

   354

                output.RefreshWires()

   355

   356

    # Draws block

   357

    def Draw(self, dc):

   358

        Graphic_Element.Draw(self, dc)

   359

        dc.SetPen(self.Pen)

   360

        dc.SetBrush(wx.WHITE_BRUSH)

   361

        dc.SetTextForeground(self.Colour)

   362

        # Draw a rectangle with the block size

   363

        dc.DrawRectangle(self.Pos.x, self.Pos.y, self.Size[0] + 1, self.Size[1] + 1)

   364

        # Draw block name and block type

   365

        dc.DrawText(self.Name, self.Pos.x + (self.Size[0] - self.NameSize[0]) / 2,

   366

                self.Pos.y - (self.NameSize[1] + 2))

   367

        dc.DrawText(self.Type, self.Pos.x + (self.Size[0] - self.TypeSize[0]) / 2,

   368

                self.Pos.y + 5)

   369

        # Draw inputs and outputs connectors

   370

        for input in self.Inputs:

   371

            input.Draw(dc)

   372

        for output in self.Outputs:

   373

            output.Draw(dc)

   374

        if self.ExecutionOrder != 0:

   375

            # Draw block execution order

   376

            dc.DrawText(str(self.ExecutionOrder), self.Pos.x + self.Size[0] - self.ExecutionOrderSize[0],

   377

                    self.Pos.y + self.Size[1] + 2)

   378

        dc.SetTextForeground(wx.BLACK)

   379

   380

   381

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

   382

#                        Function Block Diagram Variable

   383

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

   384

   385

"""

   386

Class that implements the graphic representation of a variable

   387

"""

   388

   389

class FBD_Variable(Graphic_Element):

   390

   391

    # Create a new variable

   392

    def __init__(self, parent, type, name, value_type, id = None, executionOrder = 0):

   393

        Graphic_Element.__init__(self, parent)

   394

        self.Type = None

   395

        self.ValueType = None

   396

        self.Id = id

   397

        self.SetName(name)

   398

        self.SetExecutionOrder(executionOrder)

   399

        self.Input = None

   400

        self.Output = None

   401

        self.SetType(type, value_type)

   402

   403

    # Make a clone of this FBD_Variable

   404

    def Clone(self, id = None, pos = None):

   405

        variable = FBD_Variable(self.Parent, self.Type, self.Name, self.ValueType, id)

   406

        variable.SetSize(self.Size[0], self.Size[1])

   407

        if pos is not None:

   408

            variable.SetPosition(pos.x, pos.y)

   409

        if self.Input:

   410

            variable.Input = self.Input.Clone(variable)

   411

        if self.Output:

   412

            variable.Output = self.Output.Clone(variable)

   413

        return variable

   414

   415

    # Destructor

   416

    def __del__(self):

   417

        self.Input = None

   418

        self.Output = None

   419

   420

    # Returns the RedrawRect

   421

    def GetRedrawRect(self, movex = 0, movey = 0):

   422

        rect = Graphic_Element.GetRedrawRect(self, movex, movey)

   423

        if movex != 0 or movey != 0:

   424

            if self.Input and self.Input.IsConnected():

   425

                rect = rect.Union(self.Input.GetConnectedRedrawRect(movex, movey))

   426

            if self.Output and self.Output.IsConnected():

   427

                rect = rect.Union(self.Output.GetConnectedRedrawRect(movex, movey))

   428

        return rect

   429

   430

    # Unconnect connector

   431

    def Clean(self):

   432

        if self.Input:

   433

            self.Input.UnConnect(delete = True)

   434

        if self.Output:

   435

            self.Output.UnConnect(delete = True)

   436

   437

    # Delete this variable by calling the appropriate method

   438

    def Delete(self):

   439

        self.Parent.DeleteVariable(self)

   440

   441

    # Refresh the size of text for name

   442

    def RefreshNameSize(self):

   443

        dc = wx.ClientDC(self.Parent)

   444

        self.NameSize = dc.GetTextExtent(self.Name)

   445

   446

    # Refresh the size of text for execution order

   447

    def RefreshExecutionOrderSize(self):

   448

        dc = wx.ClientDC(self.Parent)

   449

        self.ExecutionOrderSize = dc.GetTextExtent(str(self.ExecutionOrder))

   450

   451

    # Refresh the variable bounding box

   452

    def RefreshBoundingBox(self):

   453

        if self.Type in (OUTPUT, INOUT):

   454

            bbx_x = self.Pos.x - CONNECTOR_SIZE

   455

        else:

   456

            bbx_x = self.Pos.x

   457

        if self.Type == INOUT:

   458

            bbx_width = self.Size[0] + 2 * CONNECTOR_SIZE

   459

        else:

   460

            bbx_width = self.Size[0] + CONNECTOR_SIZE

   461

        bbx_height = self.Size[1]

   462

        if self.ExecutionOrder != 0:

   463

            bbx_x = min(bbx_x, self.Pos.x + self.Size[0] - self.ExecutionOrderSize[0])

   464

            bbx_width = max(bbx_width, bbx_width + self.Pos.x + self.ExecutionOrderSize[0] - bbx_x - self.Size[0])

   465

            bbx_height = bbx_height + (self.ExecutionOrderSize[1] + 2)

   466

        self.BoundingBox = wx.Rect(bbx_x, self.Pos.y, bbx_width + 1, bbx_height + 1)

   467

   468

    # Refresh the position of the variable connector

   469

    def RefreshConnectors(self):

   470

        scaling = self.Parent.GetScaling()

   471

        if scaling is not None:

   472

            position = round(float(self.Pos.y + self.Size[1] / 2) / float(scaling[1])) * scaling[1] - self.Pos.y

   473

        else:

   474

            position = self.Size[1] / 2

   475

        if self.Input:

   476

            self.Input.SetPosition(wx.Point(0, position))

   477

        if self.Output:

   478

            self.Output.SetPosition(wx.Point(self.Size[0], position))

   479

        self.RefreshConnected()

   480

   481

    # Refresh the position of wires connected to connector

   482

    def RefreshConnected(self, exclude = []):

   483

        if self.Input:

   484

            self.Input.MoveConnected(exclude)

   485

        if self.Output:

   486

            self.Output.MoveConnected(exclude)

   487

   488

    # Test if point given is on the variable connector

   489

    def TestConnector(self, pt, exclude=True):

   490

        if self.Input and self.Input.TestPoint(pt, exclude):

   491

            return self.Input

   492

        if self.Output and self.Output.TestPoint(pt, exclude):

   493

            return self.Output

   494

        return None

   495

   496

    # Returns the block connector that starts with the point given if it exists 

   497

    def GetConnector(self, position, name = None):

   498

        # if a name is given

   499

        if name:

   500

            # Test input and output connector if they exists

   501

            if self.Input and name == self.Input.GetName():

   502

                return self.Input