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

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

    58

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

    59

        if pos is not None:

    60

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

    61

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

    62

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

    63

        return block

    64

    65

    # Destructor

    66

    def __del__(self):

    67

        self.Inputs = []

    68

        self.Outputs = []

    69

    70

    # Delete this block by calling the appropriate method

    71

    def Delete(self):

    72

        self.Parent.DeleteBlock(self)

    73

    74

    # Unconnect all inputs and outputs

    75

    def Clean(self):

    76

        for input in self.Inputs:

    77

            input.UnConnect(delete = True)

    78

        for output in self.Outputs:

    79

            output.UnConnect(delete = True)

    80

    81

    # Refresh the size of text for name

    82

    def RefreshNameSize(self):

    83

        dc = wx.ClientDC(self.Parent)

    84

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

    85

    86

    # Refresh the size of text for execution order

    87

    def RefreshExecutionOrderSize(self):

    88

        dc = wx.ClientDC(self.Parent)

    89

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

    90

    91

    # Refresh the block bounding box

    92

    def RefreshBoundingBox(self):

    93

        # Calculate the size of the name outside the block

    94

        text_width, text_height = self.NameSize

    95

        # Calculate the bounding box size

    96

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

    97

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

    98

        if self.Name != "":

    99

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

   100

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

   101

        else:

   102

            bbx_y = self.Pos.y

   103

            bbx_height = self.Size[1]

   104

        if self.ExecutionOrder != 0:

   105

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

   106

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

   107

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

   108

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

   109

   110

    # Refresh the positions of the block connectors

   111

    def RefreshConnectors(self):

   112

        # Calculate the size for the connector lines

   113

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

   114

        if lines > 0:

   115

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

   116

            # Update inputs positions

   117

            position = BLOCK_LINE_SIZE + linesize / 2

   118

            for input in self.Inputs:

   119

                input.SetPosition(wx.Point(0, position))

   120

                position += linesize

   121

            # Update outputs positions

   122

            position = BLOCK_LINE_SIZE + linesize / 2

   123

            for output in self.Outputs:

   124

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

   125

                position += linesize

   126

        self.RefreshConnected()

   127

   128

    # Refresh the positions of wires connected to inputs and outputs

   129

    def RefreshConnected(self, exclude = []):

   130

        for input in self.Inputs:

   131

            input.MoveConnected(exclude)

   132

        for output in self.Outputs:

   133

            output.MoveConnected(exclude)

   134

   135

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

   136

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

   137

        # if a name is given

   138

        if name:

   139

            # Test each input and output connector

   140

            for input in self.Inputs:

   141

                if name == input.GetName():

   142

                    return input

   143

            for output in self.Outputs:

   144

                if name == output.GetName():

   145

                    return output

   146

        # Test each input connector

   147

        for input in self.Inputs:

   148

            input_pos = input.GetRelPosition()

   149

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

   150

                return input

   151

        # Test each output connector

   152

        for output in self.Outputs:

   153

            output_pos = output.GetRelPosition()

   154

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

   155

                return output

   156

        return None

   157

   158

    def GetInputTypes(self):

   159

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

   160

   161

    def SetOutputValues(self, values):

   162

        for output in self.Outputs:

   163

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

   164

   165

    def GetConnectionResultType(self, connector, connectortype):

   166

        resulttype = connectortype

   167

        for input in self.Inputs:

   168

            name = input.GetName()

   169

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

   170

                inputtype = input.GetConnectedType()

   171

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

   172

                    resulttype = inputtype

   173

        for output in self.Outputs:

   174

            name = output.GetName()

   175

            if output != connector and name == "OUT":

   176

                outputtype = output.GetConnectedType()

   177

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

   178

                    resulttype = outputtype

   179

        return resulttype

   180

   181

    # Returns all the block connectors 

   182

    def GetConnectors(self):

   183

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

   184

   185

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

   186

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

   187

        # Test each input connector

   188

        for input in self.Inputs:

   189

            if input.TestPoint(pt, exclude):

   190

                return input

   191

        # Test each output connector

   192

        for output in self.Outputs:

   193

            if output.TestPoint(pt, exclude):

   194

                return output

   195

        return None

   196

   197

    # Changes the block type

   198

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

   199

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

   200

            if type != self.Type:

   201

                self.Type = type

   202

                dc = wx.ClientDC(self.Parent)

   203

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

   204

            self.Extension = extension

   205

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

   206

            # inputs and outputs

   207

            blocktype = GetBlockType(type, inputs)

   208

            if blocktype:

   209

                self.Colour = wx.BLACK

   210

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

   211

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

   212

                if blocktype["extensible"]:

   213

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

   214

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

   215

                        start += 1

   216

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

   217

            else:

   218

                self.Colour = wx.RED

   219

                if "inputs" in connectors:

   220

                    inputs = connectors["inputs"]

   221

                else:

   222

                    inputs = []

   223

                if "outputs" in connectors:

   224

                    outputs = connectors["outputs"]

   225

                else:

   226

                    outputs = []

   227

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

   228

            self.Clean()

   229

            # Extract the inputs properties and create the corresponding connector

   230

            self.Inputs = []

   231

            for input_name, input_type, input_modifier in inputs:

   232

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

   233

                if input_modifier == "negated":

   234

                    connector.SetNegated(True)

   235

                elif input_modifier != "none":

   236

                    connector.SetEdge(input_modifier)

   237

                self.Inputs.append(connector)

   238

            # Extract the outputs properties and create the corresponding connector

   239

            self.Outputs = []

   240

            for output_name, output_type, output_modifier in outputs:

   241

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

   242

                if output_modifier == "negated":

   243

                    connector.SetNegated(True)

   244

                elif output_modifier != "none":

   245

                    connector.SetEdge(output_modifier)

   246

                self.Outputs.append(connector)

   247

            self.RefreshMinSize()

   248

            self.RefreshConnectors()

   249

            self.RefreshBoundingBox()

   250

   251

    # Returns the block type

   252

    def GetType(self):

   253

        return self.Type

   254

   255

    # Changes the block name

   256

    def SetName(self, name):

   257

        self.Name = name

   258

        self.RefreshNameSize()

   259

   260

    # Returs the block name

   261

    def GetName(self):

   262

        return self.Name

   263

   264

    # Changes the extension name

   265

    def SetExtension(self, extension):

   266

        self.Extension = extension

   267

   268

    # Returs the extension name

   269

    def GetExtension(self):

   270

        return self.Extension

   271

   272

    # Changes the execution order

   273

    def SetExecutionOrder(self, executionOrder):

   274

        self.ExecutionOrder = executionOrder

   275

        self.RefreshExecutionOrderSize()

   276

   277

    # Returs the execution order

   278

    def GetExecutionOrder(self):

   279

        return self.ExecutionOrder

   280

   281

    # Refresh the block minimum size

   282

    def RefreshMinSize(self):

   283

        # Calculate the inputs maximum width

   284

        max_input = 0

   285

        for input in self.Inputs:

   286

            w, h = input.GetNameSize()

   287

            max_input = max(max_input, w)

   288

        # Calculate the outputs maximum width

   289

        max_output = 0

   290

        for output in self.Outputs:

   291

            w, h = output.GetNameSize()

   292

            max_output = max(max_output, w)

   293

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

   294

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

   295

        self.MinSize = width, height

   296

   297

    # Returns the block minimum size

   298

    def GetMinSize(self):

   299

        return self.MinSize

   300

   301

    # Changes the negated property of the connector handled

   302

    def SetConnectorNegated(self, negated):

   303

        handle_type, handle = self.Handle

   304

        if handle_type == HANDLE_CONNECTOR:

   305

            handle.SetNegated(negated)

   306

            self.RefreshModel(False)

   307

   308

    # Changes the edge property of the connector handled

   309

    def SetConnectorEdge(self, edge):

   310

        handle_type, handle = self.Handle

   311

        if handle_type == HANDLE_CONNECTOR:

   312

            handle.SetEdge(edge)

   313

            self.RefreshModel(False)

   314

   315

    # Method called when a LeftDClick event have been generated

   316

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

   317

        # Edit the block properties

   318

        self.Parent.EditBlockContent(self)

   319

   320

    # Method called when a RightUp event have been generated

   321

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

   322

        pos = GetScaledEventPosition(event, dc, scaling)

   323

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

   324

        connector = self.TestConnector(pos, False)

   325

        if connector:

   326

            self.Handle = (HANDLE_CONNECTOR, connector)

   327

            self.Parent.PopupBlockMenu(connector)

   328

        else:

   329

            self.Parent.PopupBlockMenu()

   330

   331

    # Refreshes the block model

   332

    def RefreshModel(self, move=True):

   333

        self.Parent.RefreshBlockModel(self)

   334

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

   335

        if move:

   336

            for output in self.Outputs:

   337

                output.RefreshWires()

   338

   339

    # Draws block

   340

    def Draw(self, dc):

   341

        dc.SetPen(self.Pen)

   342

        dc.SetBrush(wx.WHITE_BRUSH)

   343

        dc.SetTextForeground(self.Colour)

   344

        # Draw a rectangle with the block size

   345

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

   346

        # Draw block name and block type

   347

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

   348

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

   349

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

   350

                self.Pos.y + 5)

   351

        # Draw inputs and outputs connectors

   352

        for input in self.Inputs:

   353

            input.Draw(dc)

   354

        for output in self.Outputs:

   355

            output.Draw(dc)

   356

        if self.ExecutionOrder != 0:

   357

            # Draw block execution order

   358

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

   359

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

   360

        Graphic_Element.Draw(self, dc)

   361

        dc.SetTextForeground(wx.BLACK)

   362

   363

   364

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

   365

#                        Function Block Diagram Variable

   366

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

   367

   368

"""

   369

Class that implements the graphic representation of a variable

   370

"""

   371

   372

class FBD_Variable(Graphic_Element):

   373

   374

    # Create a new variable

   375

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

   376

        Graphic_Element.__init__(self, parent)

   377

        self.Type = None

   378

        self.ValueType = None

   379

        self.Id = id

   380

        self.SetName(name)

   381

        self.SetExecutionOrder(executionOrder)

   382

        self.Input = None

   383

        self.Output = None

   384

        self.SetType(type, value_type)

   385

   386

    # Make a clone of this FBD_Variable

   387

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

   388

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

   389

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

   390

        if pos is not None:

   391

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

   392

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

   393

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

   394

        return variable

   395

   396

    # Destructor

   397

    def __del__(self):

   398

        self.Input = None

   399

        self.Output = None

   400

   401

    # Unconnect connector

   402

    def Clean(self):

   403

        if self.Input:

   404

            self.Input.UnConnect(delete = True)

   405

        if self.Output:

   406

            self.Output.UnConnect(delete = True)

   407

   408

    # Delete this variable by calling the appropriate method

   409

    def Delete(self):

   410

        self.Parent.DeleteVariable(self)

   411

   412

    # Refresh the size of text for name

   413

    def RefreshNameSize(self):

   414

        dc = wx.ClientDC(self.Parent)

   415

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

   416

   417

    # Refresh the size of text for execution order

   418

    def RefreshExecutionOrderSize(self):

   419

        dc = wx.ClientDC(self.Parent)

   420

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

   421

   422

    # Refresh the variable bounding box

   423

    def RefreshBoundingBox(self):

   424

        if self.Type in (OUTPUT, INOUT):

   425

            bbx_x = self.Pos.x - CONNECTOR_SIZE

   426

        else:

   427

            bbx_x = self.Pos.x

   428

        if self.Type == INOUT:

   429

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

   430

        else:

   431

            bbx_width = self.Size[0] + CONNECTOR_SIZE

   432

        bbx_height = self.Size[1]

   433

        if self.ExecutionOrder != 0:

   434

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

   435

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

   436

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

   437

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

   438

   439

    # Refresh the position of the variable connector

   440

    def RefreshConnectors(self):

   441

        if self.Input:

   442

            self.Input.SetPosition(wx.Point(0, self.Size[1] / 2))

   443

        if self.Output:

   444

            self.Output.SetPosition(wx.Point(self.Size[0], self.Size[1] / 2))

   445

        self.RefreshConnected()

   446

   447

    # Refresh the position of wires connected to connector

   448

    def RefreshConnected(self, exclude = []):

   449

        if self.Input:

   450

            self.Input.MoveConnected(exclude)

   451

        if self.Output:

   452

            self.Output.MoveConnected(exclude)

   453

   454

    # Test if point given is on the variable connector

   455

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

   456

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

   457

            return self.Input

   458

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

   459

            return self.Output

   460

        return None

   461

   462

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

   463

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

   464

        # if a name is given

   465

        if name:

   466

            # Test input and output connector if they exists

   467

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

   468

                return self.Input

   469

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

   470

                return self.Output

   471

        # Test input connector if it exists

   472

        if self.Input:

   473

            input_pos = self.Input.GetRelPosition()

   474

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

   475

                return self.Input

   476

        # Test output connector if it exists

   477

        if self.Output:

   478

            output_pos = self.Output.GetRelPosition()

   479

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

   480

                return self.Output

   481

        return None

   482

   483

    # Returns all the block connectors 

   484

    def GetConnectors(self):

   485

        return {"input" : self.Input, "output" : self.Output}

   486

   487

    # Changes the negated property of the variable connector if handled

   488

    def SetConnectorNegated(self, negated):

   489

        handle_type, handle = self.Handle

   490

        if handle_type == HANDLE_CONNECTOR:

   491

            handle.SetNegated(negated)

   492

            self.RefreshModel(False)

   493

   494

    # Changes the variable type

   495

    def SetType(self, type, value_type):

   496

        if type != self.Type:

   497

            self.Type = type

   498

            self.Clean()

   499

            self.Input = None

   500

            self.Output = None

   501

            # Create an input or output connector according to variable type

   502

            if self.Type != INPUT:

   503

                self.Input = Connector(self, "", value_type, wx.Point(0, 0), WEST, onlyone = True)

   504

            if self.Type != OUTPUT: