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

    # 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 block bounding box

    87

    def RefreshBoundingBox(self):

    88

        # Calculate the size of the name outside the block

    89

        text_width, text_height = self.NameSize

    90

        # Calculate the bounding box size

    91

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

    92

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

    93

        if self.Name != "":

    94

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

    95

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

    96

        else:

    97

            bbx_y = self.Pos.y

    98

            bbx_height = self.Size[1]

    99

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

   100

   101

    # Refresh the positions of the block connectors

   102

    def RefreshConnectors(self):

   103

        # Calculate the size for the connector lines

   104

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

   105

        if lines > 0:

   106

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

   107

            # Update inputs positions

   108

            position = BLOCK_LINE_SIZE + linesize / 2

   109

            for input in self.Inputs:

   110

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

   111

                position += linesize

   112

            # Update outputs positions

   113

            position = BLOCK_LINE_SIZE + linesize / 2

   114

            for output in self.Outputs:

   115

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

   116

                position += linesize

   117

        self.RefreshConnected()

   118

   119

    # Refresh the positions of wires connected to inputs and outputs

   120

    def RefreshConnected(self, exclude = []):

   121

        for input in self.Inputs:

   122

            input.MoveConnected(exclude)

   123

        for output in self.Outputs:

   124

            output.MoveConnected(exclude)

   125

   126

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

   127

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

   128

        # if a name is given

   129

        if name:

   130

            # Test each input and output connector

   131

            for input in self.Inputs:

   132

                if name == input.GetName():

   133

                    return input

   134

            for output in self.Outputs:

   135

                if name == output.GetName():

   136

                    return output

   137

        # Test each input connector

   138

        for input in self.Inputs:

   139

            input_pos = input.GetRelPosition()

   140

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

   141

                return input

   142

        # Test each output connector

   143

        for output in self.Outputs:

   144

            output_pos = output.GetRelPosition()

   145

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

   146

                return output

   147

        return None

   148

   149

    def GetInputTypes(self):

   150

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

   151

   152

    def SetOutputValues(self, values):

   153

        for output in self.Outputs:

   154

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

   155

   156

    def GetConnectionResultType(self, connector, connectortype):

   157

        resulttype = connectortype

   158

        for input in self.Inputs:

   159

            name = input.GetName()

   160

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

   161

                inputtype = input.GetConnectedType()

   162

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

   163

                    resulttype = inputtype

   164

        for output in self.Outputs:

   165

            name = output.GetName()

   166

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

   167

                outputtype = output.GetConnectedType()

   168

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

   169

                    resulttype = outputtype

   170

        return resulttype

   171

   172

    # Returns all the block connectors 

   173

    def GetConnectors(self):

   174

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

   175

   176

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

   177

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

   178

        # Test each input connector

   179

        for input in self.Inputs:

   180

            if input.TestPoint(pt, exclude):

   181

                return input

   182

        # Test each output connector

   183

        for output in self.Outputs:

   184

            if output.TestPoint(pt, exclude):

   185

                return output

   186

        return None

   187

   188

    # Changes the block type

   189

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

   190

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

   191

            if type != self.Type:

   192

                self.Type = type

   193

                dc = wx.ClientDC(self.Parent)

   194

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

   195

            self.Extension = extension

   196

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

   197

            # inputs and outputs

   198

            blocktype = GetBlockType(type, inputs)

   199

            if blocktype:

   200

                self.Colour = wx.BLACK

   201

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

   202

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

   203

                if blocktype["extensible"]:

   204

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

   205

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

   206

                        start += 1

   207

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

   208

            else:

   209

                self.Colour = wx.RED

   210

                if "inputs" in connectors:

   211

                    inputs = connectors["inputs"]

   212

                else:

   213

                    inputs = []

   214

                if "outputs" in connectors:

   215

                    outputs = connectors["outputs"]

   216

                else:

   217

                    outputs = []

   218

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

   219

            self.Clean()

   220

            # Extract the inputs properties and create the corresponding connector

   221

            self.Inputs = []

   222

            for input_name, input_type, input_modifier in inputs:

   223

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

   224

                if input_modifier == "negated":

   225

                    connector.SetNegated(True)

   226

                elif input_modifier != "none":

   227

                    connector.SetEdge(input_modifier)

   228

                self.Inputs.append(connector)

   229

            # Extract the outputs properties and create the corresponding connector

   230

            self.Outputs = []

   231

            for output_name, output_type, output_modifier in outputs:

   232

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

   233

                if output_modifier == "negated":

   234

                    connector.SetNegated(True)

   235

                elif output_modifier != "none":

   236

                    connector.SetEdge(output_modifier)

   237

                self.Outputs.append(connector)

   238

            self.RefreshMinSize()

   239

            self.RefreshConnectors()

   240

            self.RefreshBoundingBox()

   241

   242

    # Returns the block type

   243

    def GetType(self):

   244

        return self.Type

   245

   246

    # Changes the block name

   247

    def SetName(self, name):

   248

        self.Name = name

   249

        self.RefreshNameSize()

   250

   251

    # Returs the block name

   252

    def GetName(self):

   253

        return self.Name

   254

   255

    # Changes the extension name

   256

    def SetExtension(self, extension):

   257

        self.Extension = extension

   258

   259

    # Returs the extension name

   260

    def GetExtension(self):

   261

        return self.Extension

   262

   263

    # Refresh the block minimum size

   264

    def RefreshMinSize(self):

   265

        # Calculate the inputs maximum width

   266

        max_input = 0

   267

        for input in self.Inputs:

   268

            w, h = input.GetNameSize()

   269

            max_input = max(max_input, w)

   270

        # Calculate the outputs maximum width

   271

        max_output = 0

   272

        for output in self.Outputs:

   273

            w, h = output.GetNameSize()

   274

            max_output = max(max_output, w)

   275

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

   276

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

   277

        self.MinSize = width, height

   278

   279

    # Returns the block minimum size

   280

    def GetMinSize(self):

   281

        return self.MinSize

   282

   283

    # Changes the negated property of the connector handled

   284

    def SetConnectorNegated(self, negated):

   285

        handle_type, handle = self.Handle

   286

        if handle_type == HANDLE_CONNECTOR:

   287

            handle.SetNegated(negated)

   288

            self.RefreshModel(False)

   289

   290

    # Changes the edge property of the connector handled

   291

    def SetConnectorEdge(self, edge):

   292

        handle_type, handle = self.Handle

   293

        if handle_type == HANDLE_CONNECTOR:

   294

            handle.SetEdge(edge)

   295

            self.RefreshModel(False)

   296

   297

    # Method called when a LeftDClick event have been generated

   298

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

   299

        # Edit the block properties

   300

        self.Parent.EditBlockContent(self)

   301

   302

    # Method called when a RightUp event have been generated

   303

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

   304

        pos = GetScaledEventPosition(event, dc, scaling)

   305

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

   306

        connector = self.TestConnector(pos, False)

   307

        if connector:

   308

            self.Handle = (HANDLE_CONNECTOR, connector)

   309

            self.Parent.PopupBlockMenu(connector)

   310

        else:

   311

            self.Parent.PopupBlockMenu()

   312

   313

    # Refreshes the block model

   314

    def RefreshModel(self, move=True):

   315

        self.Parent.RefreshBlockModel(self)

   316

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

   317

        if move:

   318

            for output in self.Outputs:

   319

                output.RefreshWires()

   320

   321

    # Draws block

   322

    def Draw(self, dc):

   323

        dc.SetPen(self.Pen)

   324

        dc.SetBrush(wx.WHITE_BRUSH)

   325

        dc.SetTextForeground(self.Colour)

   326

        # Draw a rectangle with the block size

   327

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

   328

        # Draw block name and block type

   329

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

   330

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

   331

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

   332

                self.Pos.y + 5)

   333

        # Draw inputs and outputs connectors

   334

        for input in self.Inputs:

   335

            input.Draw(dc)

   336

        for output in self.Outputs:

   337

            output.Draw(dc)

   338

        Graphic_Element.Draw(self, dc)

   339

        dc.SetTextForeground(wx.BLACK)

   340

   341

   342

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

   343

#                        Function Block Diagram Variable

   344

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

   345

   346

"""

   347

Class that implements the graphic representation of a variable

   348

"""

   349

   350

class FBD_Variable(Graphic_Element):

   351

   352

    # Create a new variable

   353

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

   354

        Graphic_Element.__init__(self, parent)

   355

        self.Type = None

   356

        self.ValueType = None

   357

        self.Name = name

   358

        self.Id = id

   359

        self.Input = None

   360

        self.Output = None

   361

        self.RefreshNameSize()

   362

        self.SetType(type, value_type)

   363

   364

    # Make a clone of this FBD_Variable

   365

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

   366

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

   367

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

   368

        if pos is not None:

   369

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

   370

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

   371

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

   372

        return variable

   373

   374

    # Destructor

   375

    def __del__(self):

   376

        self.Input = None

   377

        self.Output = None

   378

   379

    # Unconnect connector

   380

    def Clean(self):

   381

        if self.Input:

   382

            self.Input.UnConnect(delete = True)

   383

        if self.Output:

   384

            self.Output.UnConnect(delete = True)

   385

   386

    # Delete this variable by calling the appropriate method

   387

    def Delete(self):

   388

        self.Parent.DeleteVariable(self)

   389

   390

    # Refresh the size of text for name

   391

    def RefreshNameSize(self):

   392

        dc = wx.ClientDC(self.Parent)

   393

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

   394

   395

    # Refresh the variable bounding box

   396

    def RefreshBoundingBox(self):

   397

        if self.Type in (OUTPUT, INOUT):

   398

            bbx_x = self.Pos.x - CONNECTOR_SIZE

   399

        else:

   400

            bbx_x = self.Pos.x

   401

        if self.Type == INOUT:

   402

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

   403

        else:

   404

            bbx_width = self.Size[0] + CONNECTOR_SIZE

   405

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

   406

   407

    # Refresh the position of the variable connector

   408

    def RefreshConnectors(self):

   409

        if self.Input:

   410

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

   411

        if self.Output:

   412

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

   413

        self.RefreshConnected()

   414

   415

    # Refresh the position of wires connected to connector

   416

    def RefreshConnected(self, exclude = []):

   417

        if self.Input:

   418

            self.Input.MoveConnected(exclude)

   419

        if self.Output:

   420

            self.Output.MoveConnected(exclude)

   421

   422

    # Test if point given is on the variable connector

   423

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

   424

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

   425

            return self.Input

   426

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

   427

            return self.Output

   428

        return None

   429

   430

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

   431

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

   432

        # if a name is given

   433

        if name:

   434

            # Test input and output connector if they exists

   435

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

   436

                return self.Input

   437

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

   438

                return self.Output

   439

        # Test input connector if it exists

   440

        if self.Input:

   441

            input_pos = self.Input.GetRelPosition()

   442

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

   443

                return self.Input

   444

        # Test output connector if it exists

   445

        if self.Output:

   446

            output_pos = self.Output.GetRelPosition()

   447

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

   448

                return self.Output

   449

        return None

   450

   451

    # Returns all the block connectors 

   452

    def GetConnectors(self):

   453

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

   454

   455

    # Changes the negated property of the variable connector if handled

   456

    def SetConnectorNegated(self, negated):

   457

        handle_type, handle = self.Handle

   458

        if handle_type == HANDLE_CONNECTOR:

   459

            handle.SetNegated(negated)

   460

            self.RefreshModel(False)

   461

   462

    # Changes the variable type

   463

    def SetType(self, type, value_type):

   464

        if type != self.Type:

   465

            self.Type = type

   466

            self.Clean()

   467

            self.Input = None

   468

            self.Output = None

   469

            # Create an input or output connector according to variable type

   470

            if self.Type != INPUT:

   471

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

   472

            if self.Type != OUTPUT:

   473

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

   474

            self.RefreshConnectors()

   475

        elif value_type != self.ValueType:

   476

            if self.Input:

   477

                self.Input.SetType(value_type)

   478

            if self.Output:

   479

                self.Output.SetType(value_type)            

   480

        self.RefreshConnectors()

   481

   482

    # Returns the variable type

   483

    def GetType(self):

   484

        return self.Type

   485

   486

    # Changes the variable name

   487

    def SetName(self, name):

   488

        self.Name = name

   489

        self.RefreshNameSize()

   490

   491

    # Returns the variable name

   492

    def GetName(self):

   493

        return self.Name

   494

   495

    # Returns the variable minimum size

   496

    def GetMinSize(self):

   497

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

   498

   499

    # Method called when a LeftDClick event have been generated

   500

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

   501

        # Edit the variable properties

   502

        self.Parent.EditVariableContent(self)

   503

   504

    # Method called when a RightUp event have been generated

   505

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