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

        if lines > 0:

    96

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

    97

            # Update inputs positions

    98

            position = BLOCK_LINE_SIZE + linesize / 2

    99

            for input in self.Inputs:

   100

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

   101

                position += linesize

   102

            # Update outputs positions

   103

            position = BLOCK_LINE_SIZE + linesize / 2

   104

            for output in self.Outputs:

   105

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

   106

                position += linesize

   107

        self.RefreshConnected()

   108

   109

    # Refresh the positions of wires connected to inputs and outputs

   110

    def RefreshConnected(self, exclude = []):

   111

        for input in self.Inputs:

   112

            input.MoveConnected(exclude)

   113

        for output in self.Outputs:

   114

            output.MoveConnected(exclude)

   115

   116

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

   117

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

   118

        # if a name is given

   119

        if name:

   120

            # Test each input and output connector

   121

            for input in self.Inputs:

   122

                if name == input.GetName():

   123

                    return input

   124

            for output in self.Outputs:

   125

                if name == output.GetName():

   126

                    return output

   127

        # Test each input connector

   128

        for input in self.Inputs:

   129

            input_pos = input.GetRelPosition()

   130

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

   131

                return input

   132

        # Test each output connector

   133

        for output in self.Outputs:

   134

            output_pos = output.GetRelPosition()

   135

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

   136

                return output

   137

        return None

   138

   139

    def GetInputTypes(self):

   140

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

   141

   142

    def SetOutputValues(self, values):

   143

        for output in self.Outputs:

   144

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

   145

   146

    def GetConnectionResultType(self, connector, connectortype):

   147

        resulttype = connectortype

   148

        for input in self.Inputs:

   149

            name = input.GetName()

   150

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

   151

                inputtype = input.GetConnectedType()

   152

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

   153

                    resulttype = inputtype

   154

        for output in self.Outputs:

   155

            name = output.GetName()

   156

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

   157

                outputtype = output.GetConnectedType()

   158

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

   159

                    resulttype = outputtype

   160

        return resulttype

   161

   162

    # Returns all the block connectors 

   163

    def GetConnectors(self):

   164

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

   165

   166

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

   167

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

   168

        # Test each input connector

   169

        for input in self.Inputs:

   170

            if input.TestPoint(pt, exclude):

   171

                return input

   172

        # Test each output connector

   173

        for output in self.Outputs:

   174

            if output.TestPoint(pt, exclude):

   175

                return output

   176

        return None

   177

   178

    # Changes the block type

   179

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

   180

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

   181

            if type != self.Type:

   182

                self.Type = type

   183

                dc = wx.ClientDC(self.Parent)

   184

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

   185

            self.Extension = extension

   186

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

   187

            # inputs and outputs

   188

            blocktype = GetBlockType(type, inputs)

   189

            if blocktype:

   190

                self.Colour = wx.BLACK

   191

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

   192

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

   193

                if blocktype["extensible"]:

   194

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

   195

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

   196

                        start += 1

   197

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

   198

            else:

   199

                self.Colour = wx.RED

   200

                if "inputs" in connectors:

   201

                    inputs = connectors["inputs"]

   202

                else:

   203

                    inputs = []

   204

                if "outputs" in connectors:

   205

                    outputs = connectors["outputs"]

   206

                else:

   207

                    outputs = []

   208

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

   209

            self.Clean()

   210

            # Extract the inputs properties and create the corresponding connector

   211

            self.Inputs = []

   212

            for input_name, input_type, input_modifier in inputs:

   213

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

   214

                if input_modifier == "negated":

   215

                    connector.SetNegated(True)

   216

                elif input_modifier != "none":

   217

                    connector.SetEdge(input_modifier)

   218

                self.Inputs.append(connector)

   219

            # Extract the outputs properties and create the corresponding connector

   220

            self.Outputs = []

   221

            for output_name, output_type, output_modifier in outputs:

   222

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

   223

                if output_modifier == "negated":

   224

                    connector.SetNegated(True)

   225

                elif output_modifier != "none":

   226

                    connector.SetEdge(output_modifier)

   227

                self.Outputs.append(connector)

   228

            self.RefreshMinSize()

   229

            self.RefreshConnectors()

   230

            self.RefreshBoundingBox()

   231

   232

    # Returns the block type

   233

    def GetType(self):

   234

        return self.Type

   235

   236

    # Changes the block name

   237

    def SetName(self, name):

   238

        self.Name = name

   239

        self.RefreshNameSize()

   240

   241

    # Returs the block name

   242

    def GetName(self):

   243

        return self.Name

   244

   245

    # Changes the extension name

   246

    def SetExtension(self, extension):

   247

        self.Extension = extension

   248

   249

    # Returs the extension name

   250

    def GetExtension(self):

   251

        return self.Extension

   252

   253

    # Refresh the block minimum size

   254

    def RefreshMinSize(self):

   255

        # Calculate the inputs maximum width

   256

        max_input = 0

   257

        for input in self.Inputs:

   258

            w, h = input.GetNameSize()

   259

            max_input = max(max_input, w)

   260

        # Calculate the outputs maximum width

   261

        max_output = 0

   262

        for output in self.Outputs:

   263

            w, h = output.GetNameSize()

   264

            max_output = max(max_output, w)

   265

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

   266

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

   267

        self.MinSize = width, height

   268

   269

    # Returns the block minimum size

   270

    def GetMinSize(self):

   271

        return self.MinSize

   272

   273

    # Changes the negated property of the connector handled

   274

    def SetConnectorNegated(self, negated):

   275

        handle_type, handle = self.Handle

   276

        if handle_type == HANDLE_CONNECTOR:

   277

            handle.SetNegated(negated)

   278

            self.RefreshModel(False)

   279

   280

    # Changes the edge property of the connector handled

   281

    def SetConnectorEdge(self, edge):

   282

        handle_type, handle = self.Handle

   283

        if handle_type == HANDLE_CONNECTOR:

   284

            handle.SetEdge(edge)

   285

            self.RefreshModel(False)

   286

   287

    # Method called when a LeftDClick event have been generated

   288

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

   289

        # Edit the block properties

   290

        self.Parent.EditBlockContent(self)

   291

   292

    # Method called when a RightUp event have been generated

   293

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

   294

        pos = GetScaledEventPosition(event, dc, scaling)

   295

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

   296

        connector = self.TestConnector(pos, False)

   297

        if connector:

   298

            self.Handle = (HANDLE_CONNECTOR, connector)

   299

            self.Parent.PopupBlockMenu(connector)

   300

        else:

   301

            self.Parent.PopupBlockMenu()

   302

   303

    # Refreshes the block model

   304

    def RefreshModel(self, move=True):

   305

        self.Parent.RefreshBlockModel(self)

   306

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

   307

        if move:

   308

            for output in self.Outputs:

   309

                output.RefreshWires()

   310

   311

    # Draws block

   312

    def Draw(self, dc):

   313

        dc.SetPen(self.Pen)

   314

        dc.SetBrush(wx.WHITE_BRUSH)

   315

        dc.SetTextForeground(self.Colour)

   316

        # Draw a rectangle with the block size

   317

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

   318

        # Draw block name and block type

   319

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

   320

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

   321

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

   322

                self.Pos.y + 5)

   323

        # Draw inputs and outputs connectors

   324

        for input in self.Inputs:

   325

            input.Draw(dc)

   326

        for output in self.Outputs:

   327

            output.Draw(dc)

   328

        Graphic_Element.Draw(self, dc)

   329

        dc.SetTextForeground(wx.BLACK)

   330

   331

   332

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

   333

#                        Function Block Diagram Variable

   334

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

   335

   336

"""

   337

Class that implements the graphic representation of a variable

   338

"""

   339

   340

class FBD_Variable(Graphic_Element):

   341

   342

    # Create a new variable

   343

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

   344

        Graphic_Element.__init__(self, parent)

   345

        self.Type = None

   346

        self.ValueType = None

   347

        self.Name = name

   348

        self.Id = id

   349

        self.Input = None

   350

        self.Output = None

   351

        self.RefreshNameSize()

   352

        self.SetType(type, value_type)

   353

   354

    # Destructor

   355

    def __del__(self):

   356

        self.Input = None

   357

        self.Output = None

   358

   359

    # Unconnect connector

   360

    def Clean(self):

   361

        if self.Input:

   362

            self.Input.UnConnect(delete = True)

   363

        if self.Output:

   364

            self.Output.UnConnect(delete = True)

   365

   366

    # Delete this variable by calling the appropriate method

   367

    def Delete(self):

   368

        self.Parent.DeleteVariable(self)

   369

   370

    # Refresh the size of text for name

   371

    def RefreshNameSize(self):

   372

        dc = wx.ClientDC(self.Parent)

   373

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

   374

   375

    # Refresh the variable bounding box

   376

    def RefreshBoundingBox(self):

   377

        if self.Type in (OUTPUT, INOUT):

   378

            bbx_x = self.Pos.x - CONNECTOR_SIZE

   379

        else:

   380

            bbx_x = self.Pos.x

   381

        if self.Type == INOUT:

   382

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

   383

        else:

   384

            bbx_width = self.Size[0] + CONNECTOR_SIZE

   385

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

   386

   387

    # Refresh the position of the variable connector

   388

    def RefreshConnectors(self):

   389

        if self.Input:

   390

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

   391

        if self.Output:

   392

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

   393

        self.RefreshConnected()

   394

   395

    # Refresh the position of wires connected to connector

   396

    def RefreshConnected(self, exclude = []):

   397

        if self.Input:

   398

            self.Input.MoveConnected(exclude)

   399

        if self.Output:

   400

            self.Output.MoveConnected(exclude)

   401

   402

    # Test if point given is on the variable connector

   403

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

   404

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

   405

            return self.Input

   406

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

   407

            return self.Output

   408

        return None

   409

   410

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

   411

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

   412

        # if a name is given

   413

        if name:

   414

            # Test input and output connector if they exists

   415

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

   416

                return self.Input

   417

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

   418

                return self.Output

   419

        # Test input connector if it exists

   420

        if self.Input:

   421

            input_pos = self.Input.GetRelPosition()

   422

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

   423

                return self.Input

   424

        # Test output connector if it exists

   425

        if self.Output:

   426

            output_pos = self.Output.GetRelPosition()

   427

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

   428

                return self.Output

   429

        return None

   430

   431

    # Returns all the block connectors 

   432

    def GetConnectors(self):

   433

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

   434

   435

    # Changes the negated property of the variable connector if handled

   436

    def SetConnectorNegated(self, negated):

   437

        handle_type, handle = self.Handle

   438

        if handle_type == HANDLE_CONNECTOR:

   439

            handle.SetNegated(negated)

   440

            self.RefreshModel(False)

   441

   442

    # Changes the variable type

   443

    def SetType(self, type, value_type):

   444

        if type != self.Type:

   445

            self.Type = type

   446

            self.Clean()

   447

            self.Input = None

   448

            self.Output = None

   449

            # Create an input or output connector according to variable type

   450

            if self.Type != INPUT:

   451

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

   452

            if self.Type != OUTPUT:

   453

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

   454

            self.RefreshConnectors()

   455

        elif value_type != self.ValueType:

   456

            if self.Input:

   457

                self.Input.SetType(value_type)

   458

            if self.Output:

   459

                self.Output.SetType(value_type)            

   460

        self.RefreshConnectors()

   461

   462

    # Returns the variable type

   463

    def GetType(self):

   464

        return self.Type

   465

   466

    # Changes the variable name

   467

    def SetName(self, name):

   468

        self.Name = name

   469

        self.RefreshNameSize()

   470

   471

    # Returns the variable name

   472

    def GetName(self):

   473

        return self.Name

   474

   475

    # Returns the variable minimum size

   476

    def GetMinSize(self):

   477

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

   478

   479

    # Method called when a LeftDClick event have been generated

   480

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

   481

        # Edit the variable properties

   482

        self.Parent.EditVariableContent(self)

   483

   484

    # Method called when a RightUp event have been generated

   485

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

   486

        self.Parent.PopupDefaultMenu()

   487

   488

    # Refreshes the variable model

   489

    def RefreshModel(self, move=True):

   490

        self.Parent.RefreshVariableModel(self)

   491

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

   492

        # of wires connected to output connector

   493

        if move and self.Type != OUTPUT:

   494

            if self.Output:

   495

                self.Output.RefreshWires()

   496

   497

    # Draws variable

   498

    def Draw(self, dc):

   499

        dc.SetPen(wx.BLACK_PEN)

   500

        dc.SetBrush(wx.WHITE_BRUSH)

   501

        # Draw a rectangle with the variable size

   502

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

   503

        # Draw variable name

   504

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

   505

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

   506

        # Draw connectors