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 = {}):

    43

        Graphic_Element.__init__(self, parent)

    44

        self.Type = None

    45

        self.Extension = None

    46

        self.Name = name

    47

        self.Id = id

    48

        self.Inputs = []

    49

        self.Outputs = []

    50

        self.RefreshNameSize()

    51

        self.Colour = wx.BLACK

    52

        self.Pen = wx.BLACK_PEN

    53

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

    54

    55

    # Destructor

    56

    def __del__(self):

    57

        self.Inputs = []

    58

        self.Outputs = []

    59

    60

    # Delete this block by calling the appropriate method

    61

    def Delete(self):

    62

        self.Parent.DeleteBlock(self)

    63

    64

    # Unconnect all inputs and outputs

    65

    def Clean(self):

    66

        for input in self.Inputs:

    67

            input.UnConnect(delete = True)

    68

        for output in self.Outputs:

    69

            output.UnConnect(delete = True)

    70

    71

    # Refresh the size of text for name

    72

    def RefreshNameSize(self):

    73

        dc = wx.ClientDC(self.Parent)

    74

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

    75

    76

    # Refresh the block bounding box

    77

    def RefreshBoundingBox(self):

    78

        # Calculate the size of the name outside the block

    79

        text_width, text_height = self.NameSize

    80

        # Calculate the bounding box size

    81

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

    82

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

    83

        if self.Name != "":

    84

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

    85

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

    86

        else:

    87

            bbx_y = self.Pos.y

    88

            bbx_height = self.Size[1]

    89

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

    90

    91

    # Refresh the positions of the block connectors

    92

    def RefreshConnectors(self):

    93

        # Calculate the size for the connector lines

    94

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

    95

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

    96

        # Update inputs positions

    97

        position = BLOCK_LINE_SIZE + linesize / 2

    98

        for input in self.Inputs:

    99

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

   100

            position += linesize

   101

        # Update outputs positions

   102

        position = BLOCK_LINE_SIZE + linesize / 2

   103

        for output in self.Outputs:

   104

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

   105

            position += linesize

   106

        self.RefreshConnected()

   107

   108

    # Refresh the positions of wires connected to inputs and outputs

   109

    def RefreshConnected(self, exclude = []):

   110

        for input in self.Inputs:

   111

            input.MoveConnected(exclude)

   112

        for output in self.Outputs:

   113

            output.MoveConnected(exclude)

   114

   115

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

   116

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

   117

        # if a name is given

   118

        if name:

   119

            # Test each input and output connector

   120

            for input in self.Inputs:

   121

                if name == input.GetName():

   122

                    return input

   123

            for output in self.Outputs:

   124

                if name == output.GetName():

   125

                    return output

   126

        # Test each input connector

   127

        for input in self.Inputs:

   128

            input_pos = input.GetRelPosition()

   129

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

   130

                return input

   131

        # Test each output connector

   132

        for output in self.Outputs:

   133

            output_pos = output.GetRelPosition()

   134

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

   135

                return output

   136

        return None

   137

   138

    def GetInputTypes(self):

   139

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

   140

   141

    def GetConnectionResultType(self, connector):

   142

        resulttype = None

   143

        for input in self.Inputs:

   144

            name = input.GetName()

   145

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

   146

                inputtype = input.GetConnectedType()

   147

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

   148

                    resulttype = inputtype

   149

        for output in self.Outputs:

   150

            name = output.GetName()

   151

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

   152

                outputtype = output.GetConnectedType()

   153

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

   154

                    resulttype = outputtype

   155

        return resulttype

   156

   157

    # Returns all the block connectors 

   158

    def GetConnectors(self):

   159

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

   160

   161

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

   162

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

   163

        # Test each input connector

   164

        for input in self.Inputs:

   165

            if input.TestPoint(pt, exclude):

   166

                return input

   167

        # Test each output connector

   168

        for output in self.Outputs:

   169

            if output.TestPoint(pt, exclude):

   170

                return output

   171

        return None

   172

   173

    # Changes the block type

   174

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

   175

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

   176

            if type != self.Type:

   177

                self.Type = type

   178

                dc = wx.ClientDC(self.Parent)

   179

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

   180

            self.Extension = extension

   181

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

   182

            # inputs and outputs

   183

            blocktype = GetBlockType(type, inputs)

   184

            if blocktype:

   185

                self.Colour = wx.BLACK

   186

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

   187

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

   188

                if blocktype["extensible"]:

   189

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

   190

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

   191

                        start += 1

   192

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

   193

            else:

   194

                self.Colour = wx.RED

   195

                if "inputs" in connectors:

   196

                    inputs = connectors["inputs"]

   197

                else:

   198

                    inputs = []

   199

                if "outputs" in connectors:

   200

                    outputs = connectors["outputs"]

   201

                else:

   202

                    outputs = []

   203

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

   204

            self.Clean()

   205

            # Extract the inputs properties and create the corresponding connector

   206

            self.Inputs = []

   207

            for input_name, input_type, input_modifier in inputs:

   208

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

   209

                if input_modifier == "negated":

   210

                    connector.SetNegated(True)

   211

                elif input_modifier != "none":

   212

                    connector.SetEdge(input_modifier)

   213

                self.Inputs.append(connector)

   214

            # Extract the outputs properties and create the corresponding connector

   215

            self.Outputs = []

   216

            for output_name, output_type, output_modifier in outputs:

   217

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

   218

                if output_modifier == "negated":

   219

                    connector.SetNegated(True)

   220

                elif output_modifier != "none":

   221

                    connector.SetEdge(output_modifier)

   222

                self.Outputs.append(connector)

   223

            self.RefreshMinSize()

   224

            self.RefreshConnectors()

   225

            self.RefreshBoundingBox()

   226

   227

    # Returns the block type

   228

    def GetType(self):

   229

        return self.Type

   230

   231

    # Changes the block name

   232

    def SetName(self, name):

   233

        self.Name = name

   234

        self.RefreshNameSize()

   235

   236

    # Returs the block name

   237

    def GetName(self):

   238

        return self.Name

   239

   240

    # Changes the extension name

   241

    def SetExtension(self, extension):

   242

        self.Extension = extension

   243

   244

    # Returs the extension name

   245

    def GetExtension(self):

   246

        return self.Extension

   247

   248

    # Refresh the block minimum size

   249

    def RefreshMinSize(self):

   250

        # Calculate the inputs maximum width

   251

        max_input = 0

   252

        for input in self.Inputs:

   253

            w, h = input.GetNameSize()

   254

            max_input = max(max_input, w)

   255

        # Calculate the outputs maximum width

   256

        max_output = 0

   257

        for output in self.Outputs:

   258

            w, h = output.GetNameSize()

   259

            max_output = max(max_output, w)

   260

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

   261

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

   262

        self.MinSize = width, height

   263

   264

    # Returns the block minimum size

   265

    def GetMinSize(self):

   266

        return self.MinSize

   267

   268

    # Changes the negated property of the connector handled

   269

    def SetConnectorNegated(self, negated):

   270

        handle_type, handle = self.Handle

   271

        if handle_type == HANDLE_CONNECTOR:

   272

            handle.SetNegated(negated)

   273

            self.RefreshModel(False)

   274

   275

    # Changes the edge property of the connector handled

   276

    def SetConnectorEdge(self, edge):

   277

        handle_type, handle = self.Handle

   278

        if handle_type == HANDLE_CONNECTOR:

   279

            handle.SetEdge(edge)

   280

            self.RefreshModel(False)

   281

   282

    # Method called when a LeftDClick event have been generated

   283

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

   284

        # Edit the block properties

   285

        self.Parent.EditBlockContent(self)

   286

   287

    # Method called when a RightUp event have been generated

   288

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

   289

        pos = GetScaledEventPosition(event, dc, scaling)

   290

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

   291

        connector = self.TestConnector(pos, False)

   292

        if connector:

   293

            self.Handle = (HANDLE_CONNECTOR, connector)

   294

            self.Parent.PopupBlockMenu(connector)

   295

        else:

   296

            self.Parent.PopupBlockMenu()

   297

   298

    # Refreshes the block model

   299

    def RefreshModel(self, move=True):

   300

        self.Parent.RefreshBlockModel(self)

   301

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

   302

        if move:

   303

            for output in self.Outputs:

   304

                output.RefreshWires()

   305

   306

    # Draws block

   307

    def Draw(self, dc):

   308

        dc.SetPen(self.Pen)

   309

        dc.SetBrush(wx.WHITE_BRUSH)

   310

        dc.SetTextForeground(self.Colour)

   311

        # Draw a rectangle with the block size

   312

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

   313

        # Draw block name and block type

   314

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

   315

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

   316

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

   317

                self.Pos.y + 5)

   318

        # Draw inputs and outputs connectors

   319

        for input in self.Inputs:

   320

            input.Draw(dc)

   321

        for output in self.Outputs:

   322

            output.Draw(dc)

   323

        Graphic_Element.Draw(self, dc)

   324

        dc.SetTextForeground(wx.BLACK)

   325

   326

   327

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

   328

#                        Function Block Diagram Variable

   329

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

   330

   331

"""

   332

Class that implements the graphic representation of a variable

   333

"""

   334

   335

class FBD_Variable(Graphic_Element):

   336

   337

    # Create a new variable

   338

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

   339

        Graphic_Element.__init__(self, parent)

   340

        self.Type = None

   341

        self.ValueType = None

   342

        self.Name = name

   343

        self.Id = id

   344

        self.Input = None

   345

        self.Output = None

   346

        self.RefreshNameSize()

   347

        self.SetType(type, value_type)

   348

   349

    # Destructor

   350

    def __del__(self):

   351

        self.Input = None

   352

        self.Output = None

   353

   354

    # Unconnect connector

   355

    def Clean(self):

   356

        if self.Input:

   357

            self.Input.UnConnect(delete = True)

   358

        if self.Output:

   359

            self.Output.UnConnect(delete = True)

   360

   361

    # Delete this variable by calling the appropriate method

   362

    def Delete(self):

   363

        self.Parent.DeleteVariable(self)

   364

   365

    # Refresh the size of text for name

   366

    def RefreshNameSize(self):

   367

        dc = wx.ClientDC(self.Parent)

   368

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

   369

   370

    # Refresh the variable bounding box

   371

    def RefreshBoundingBox(self):

   372

        if self.Type in (OUTPUT, INOUT):

   373

            bbx_x = self.Pos.x - CONNECTOR_SIZE

   374

        else:

   375

            bbx_x = self.Pos.x

   376

        if self.Type == INOUT:

   377

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

   378

        else:

   379

            bbx_width = self.Size[0] + CONNECTOR_SIZE

   380

        self.BoundingBox = wx.Rect(bbx_x, self.Pos.y, bbx_width + 1, self.Size[1] + 1)

   381

   382

    # Refresh the position of the variable connector

   383

    def RefreshConnectors(self):

   384

        if self.Input:

   385

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

   386

        if self.Output:

   387

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

   388

        self.RefreshConnected()

   389

   390

    # Refresh the position of wires connected to connector

   391

    def RefreshConnected(self, exclude = []):

   392

        if self.Input:

   393

            self.Input.MoveConnected(exclude)

   394

        if self.Output:

   395

            self.Output.MoveConnected(exclude)

   396

   397

    # Test if point given is on the variable connector

   398

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

   399

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

   400

            return self.Input

   401

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

   402

            return self.Output

   403

        return None

   404

   405

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

   406

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

   407

        # if a name is given

   408

        if name:

   409

            # Test input and output connector if they exists

   410

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

   411

                return self.Input

   412

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

   413

                return self.Output

   414

        # Test input connector if it exists

   415

        if self.Input:

   416

            input_pos = self.Input.GetRelPosition()

   417

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

   418

                return self.Input

   419

        # Test output connector if it exists

   420

        if self.Output:

   421

            output_pos = self.Output.GetRelPosition()

   422

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

   423

                return self.Output

   424

        return None

   425

   426

    # Returns all the block connectors 

   427

    def GetConnectors(self):

   428

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

   429

   430

    # Changes the negated property of the variable connector if handled

   431

    def SetConnectorNegated(self, negated):

   432

        handle_type, handle = self.Handle

   433

        if handle_type == HANDLE_CONNECTOR:

   434

            handle.SetNegated(negated)

   435

            self.RefreshModel(False)

   436

   437

    # Changes the variable type

   438

    def SetType(self, type, value_type):

   439

        if type != self.Type:

   440

            self.Type = type

   441

            self.Clean()

   442

            self.Input = None

   443

            self.Output = None

   444

            # Create an input or output connector according to variable type

   445

            if self.Type != INPUT:

   446

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

   447

            if self.Type != OUTPUT:

   448

                self.Output = Connector(self, "", value_type, wx.Point(0, 0), EAST)

   449

            self.RefreshConnectors()

   450

        elif value_type != self.ValueType:

   451

            if self.Input:

   452

                self.Input.SetType(value_type)

   453

            if self.Output:

   454

                self.Output.SetType(value_type)            

   455

        self.RefreshConnectors()

   456

   457

    # Returns the variable type

   458

    def GetType(self):

   459

        return self.Type

   460

   461

    # Changes the variable name

   462

    def SetName(self, name):

   463

        self.Name = name

   464

        self.RefreshNameSize()

   465

   466

    # Returns the variable name

   467

    def GetName(self):

   468

        return self.Name

   469

   470

    # Returns the variable minimum size

   471

    def GetMinSize(self):

   472

        return self.NameSize[0] + 10, self.NameSize[1] + 10

   473

   474

    # Method called when a LeftDClick event have been generated

   475

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

   476

        # Edit the variable properties

   477

        self.Parent.EditVariableContent(self)

   478

   479

    # Method called when a RightUp event have been generated

   480

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

   481

        pos = GetScaledEventPosition(event, dc, scaling)

   482

        # Popup the menu with special items for a variable and a connector if it's handled

   483

        connector = self.TestConnector(pos, False)

   484

        if connector:

   485

            self.Handle = (HANDLE_CONNECTOR, connector)

   486

            self.Parent.PopupVariableMenu(connector)

   487

        else:

   488

            self.Parent.PopupVariableMenu()

   489

   490

    # Refreshes the variable model

   491

    def RefreshModel(self, move=True):

   492

        self.Parent.RefreshVariableModel(self)

   493

        # If variable has moved and variable is not of type OUTPUT, refresh the model

   494

        # of wires connected to output connector

   495

        if move and self.Type != OUTPUT:

   496

            if self.Output:

   497

                self.Output.RefreshWires()

   498

   499

    # Draws variable

   500

    def Draw(self, dc):

   501

        dc.SetPen(wx.BLACK_PEN)

   502

        dc.SetBrush(wx.WHITE_BRUSH)

   503

        # Draw a rectangle with the variable size

   504

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

   505

        # Draw variable name

   506

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

   507

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