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):

    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

    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

        # Calculate the size for the connector lines

   127

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

   128

        if lines > 0:

   129

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

   130

            # Update inputs positions

   131

            position = BLOCK_LINE_SIZE + linesize / 2

   132

            for input in self.Inputs:

   133

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

   134

                position += linesize

   135

            # Update outputs positions

   136

            position = BLOCK_LINE_SIZE + linesize / 2

   137

            for output in self.Outputs:

   138

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

   139

                position += linesize

   140

        self.RefreshConnected()

   141

   142

    # Refresh the positions of wires connected to inputs and outputs

   143

    def RefreshConnected(self, exclude = []):

   144

        for input in self.Inputs:

   145

            input.MoveConnected(exclude)

   146

        for output in self.Outputs:

   147

            output.MoveConnected(exclude)

   148

   149

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

   150

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

   151

        # if a name is given

   152

        if name:

   153

            # Test each input and output connector

   154

            for input in self.Inputs:

   155

                if name == input.GetName():

   156

                    return input

   157

            for output in self.Outputs:

   158

                if name == output.GetName():

   159

                    return output

   160

        # Test each input connector

   161

        for input in self.Inputs:

   162

            input_pos = input.GetRelPosition()

   163

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

   164

                return input

   165

        # Test each output connector

   166

        for output in self.Outputs:

   167

            output_pos = output.GetRelPosition()

   168

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

   169

                return output

   170

        return None

   171

   172

    def GetInputTypes(self):

   173

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

   174

   175

    def SetOutputValues(self, values):

   176

        for output in self.Outputs:

   177

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

   178

   179

    def GetConnectionResultType(self, connector, connectortype):

   180

        resulttype = connectortype

   181

        for input in self.Inputs:

   182

            name = input.GetName()

   183

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

   184

                inputtype = input.GetConnectedType()

   185

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

   186

                    resulttype = inputtype

   187

        for output in self.Outputs:

   188

            name = output.GetName()

   190

                outputtype = output.GetConnectedType()

   191

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

   192

                    resulttype = outputtype

   193

        return resulttype

   194

   195

    # Returns all the block connectors 

   196

    def GetConnectors(self):

   197

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

   198

   199

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

   200

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

   201

        # Test each input connector

   202

        for input in self.Inputs:

   203

            if input.TestPoint(pt, exclude):

   204

                return input

   205

        # Test each output connector

   206

        for output in self.Outputs:

   207

            if output.TestPoint(pt, exclude):

   208

                return output

   209

        return None

   210

   211

    # Changes the block type

   212

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

   213

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

   214

            if type != self.Type:

   215

                self.Type = type

   216

                dc = wx.ClientDC(self.Parent)

   217

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

   218

            self.Extension = extension

   219

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

   220

            # inputs and outputs

   221

            blocktype = GetBlockType(type, inputs)

   222

            if blocktype:

   223

                self.Colour = wx.BLACK

   224

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

   225

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

   226

                if blocktype["extensible"]:

   227

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

   228

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

   229

                        start += 1

   230

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

   231

            else:

   232

                self.Colour = wx.RED

   233

                if "inputs" in connectors:

   234

                    inputs = connectors["inputs"]

   235

                else:

   236

                    inputs = []

   237

                if "outputs" in connectors:

   238

                    outputs = connectors["outputs"]

   239

                else:

   240

                    outputs = []

   241

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

   242

            self.Clean()

   243

            # Extract the inputs properties and create the corresponding connector

   244

            self.Inputs = []

   245

            for input_name, input_type, input_modifier in inputs:

   246

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

   247

                if input_modifier == "negated":

   248

                    connector.SetNegated(True)

   249

                elif input_modifier != "none":

   250

                    connector.SetEdge(input_modifier)

   251

                self.Inputs.append(connector)

   252

            # Extract the outputs properties and create the corresponding connector

   253

            self.Outputs = []

   254

            for output_name, output_type, output_modifier in outputs:

   255

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

   256

                if output_modifier == "negated":

   257

                    connector.SetNegated(True)

   258

                elif output_modifier != "none":

   259

                    connector.SetEdge(output_modifier)

   260

                self.Outputs.append(connector)

   261

            self.RefreshMinSize()

   262

            self.RefreshConnectors()

   263

            self.RefreshBoundingBox()

   264

   265

    # Returns the block type

   266

    def GetType(self):

   267

        return self.Type

   268

   269

    # Changes the block name

   270

    def SetName(self, name):

   271

        self.Name = name

   272

        self.RefreshNameSize()

   273

   274

    # Returs the block name

   275

    def GetName(self):

   276

        return self.Name

   277

   278

    # Changes the extension name

   279

    def SetExtension(self, extension):

   280

        self.Extension = extension

   281

   282

    # Returs the extension name

   283

    def GetExtension(self):

   284

        return self.Extension

   285

   286

    # Changes the execution order

   287

    def SetExecutionOrder(self, executionOrder):

   288

        self.ExecutionOrder = executionOrder

   289

        self.RefreshExecutionOrderSize()

   290

   291

    # Returs the execution order

   292

    def GetExecutionOrder(self):

   293

        return self.ExecutionOrder

   294

   295

    # Refresh the block minimum size

   296

    def RefreshMinSize(self):

   297

        # Calculate the inputs maximum width

   298

        max_input = 0

   299

        for input in self.Inputs:

   300

            w, h = input.GetNameSize()

   301

            max_input = max(max_input, w)

   302

        # Calculate the outputs maximum width

   303

        max_output = 0

   304

        for output in self.Outputs:

   305

            w, h = output.GetNameSize()

   306

            max_output = max(max_output, w)

   307

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

   308

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

   309

        self.MinSize = width, height

   310

   311

    # Returns the block minimum size

   312

    def GetMinSize(self):

   313

        return self.MinSize

   314

   315

    # Changes the negated property of the connector handled

   316

    def SetConnectorNegated(self, negated):

   317

        handle_type, handle = self.Handle

   318

        if handle_type == HANDLE_CONNECTOR:

   319

            handle.SetNegated(negated)

   320

            self.RefreshModel(False)

   321

   322

    # Changes the edge property of the connector handled

   323

    def SetConnectorEdge(self, edge):

   324

        handle_type, handle = self.Handle

   325

        if handle_type == HANDLE_CONNECTOR:

   326

            handle.SetEdge(edge)

   327

            self.RefreshModel(False)

   328

   329

    # Method called when a LeftDClick event have been generated

   330

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

   331

        # Edit the block properties

   332

        self.Parent.EditBlockContent(self)

   333

   334

    # Method called when a RightUp event have been generated

   335

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

   336

        pos = GetScaledEventPosition(event, dc, scaling)

   337

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

   338

        connector = self.TestConnector(pos, False)

   339

        if connector:

   340

            self.Handle = (HANDLE_CONNECTOR, connector)

   341

            self.Parent.PopupBlockMenu(connector)

   342

        else:

   343

            self.Parent.PopupBlockMenu()

   344

   345

    # Refreshes the block model

   346

    def RefreshModel(self, move=True):

   347

        self.Parent.RefreshBlockModel(self)

   348

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

   349

        if move:

   350

            for output in self.Outputs:

   351

                output.RefreshWires()

   352

   353

    # Draws block

   354

    def Draw(self, dc):

   356

        dc.SetPen(self.Pen)

   357

        dc.SetBrush(wx.WHITE_BRUSH)

   358

        dc.SetTextForeground(self.Colour)

   359

        # Draw a rectangle with the block size

   360

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

   361

        # Draw block name and block type

   362

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

   363

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

   364

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

   365

                self.Pos.y + 5)

   366

        # Draw inputs and outputs connectors

   367

        for input in self.Inputs:

   368

            input.Draw(dc)

   369

        for output in self.Outputs:

   370

            output.Draw(dc)

   371

        if self.ExecutionOrder != 0:

   372

            # Draw block execution order

   373

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

   374

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

   375

        dc.SetTextForeground(wx.BLACK)

   376

   377

   378

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

   379

#                        Function Block Diagram Variable

   380

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

   381

   382

"""

   383

Class that implements the graphic representation of a variable

   384

"""

   385

   386

class FBD_Variable(Graphic_Element):

   387

   388

    # Create a new variable

   389

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

   390

        Graphic_Element.__init__(self, parent)

   391

        self.Type = None

   392

        self.ValueType = None

   393

        self.Id = id

   394

        self.SetName(name)

   395

        self.SetExecutionOrder(executionOrder)

   396

        self.Input = None

   397

        self.Output = None

   398

        self.SetType(type, value_type)

   399

   400

    # Make a clone of this FBD_Variable

   401

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

   402

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

   403

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

   404

        if pos is not None:

   405

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

   410

        return variable

   411

   412

    # Destructor

   413

    def __del__(self):

   414

        self.Input = None

   415

        self.Output = None

   416

   427

    # Unconnect connector

   428

    def Clean(self):

   429

        if self.Input:

   430

            self.Input.UnConnect(delete = True)

   431

        if self.Output:

   432

            self.Output.UnConnect(delete = True)

   433

   434

    # Delete this variable by calling the appropriate method

   435

    def Delete(self):

   436

        self.Parent.DeleteVariable(self)

   437

   438

    # Refresh the size of text for name

   439

    def RefreshNameSize(self):

   440

        dc = wx.ClientDC(self.Parent)

   441

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

   442

   443

    # Refresh the size of text for execution order

   444

    def RefreshExecutionOrderSize(self):

   445

        dc = wx.ClientDC(self.Parent)

   446

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

   447

   448

    # Refresh the variable bounding box

   449

    def RefreshBoundingBox(self):

   450

        if self.Type in (OUTPUT, INOUT):

   451

            bbx_x = self.Pos.x - CONNECTOR_SIZE

   452

        else:

   453

            bbx_x = self.Pos.x

   454

        if self.Type == INOUT:

   455

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

   456

        else:

   457

            bbx_width = self.Size[0] + CONNECTOR_SIZE

   458

        bbx_height = self.Size[1]

   459

        if self.ExecutionOrder != 0:

   460

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

   461

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

   462

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

   463

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

   464

   465

    # Refresh the position of the variable connector

   466

    def RefreshConnectors(self):

   467

        if self.Input:

   468

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

   469

        if self.Output:

   470

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

   471

        self.RefreshConnected()

   472

   473

    # Refresh the position of wires connected to connector

   474

    def RefreshConnected(self, exclude = []):

   475

        if self.Input:

   476

            self.Input.MoveConnected(exclude)

   477

        if self.Output:

   478

            self.Output.MoveConnected(exclude)

   479

   480

    # Test if point given is on the variable connector

   481

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

   482

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

   483

            return self.Input

   484

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

   485

            return self.Output

   486

        return None

   487

   488

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

   489

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

   490

        # if a name is given

   491

        if name:

   492

            # Test input and output connector if they exists

   493

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

   494

                return self.Input

   495

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

   496

                return self.Output

   497

        # Test input connector if it exists

   498

        if self.Input:

   499

            input_pos = self.Input.GetRelPosition()

   500

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

   501

                return self.Input

   502

        # Test output connector if it exists

   503

        if self.Output: