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

#Lesser 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

from wxPython.wx import *

    26

import wx

    27

    28

from GraphicCommons import *

    29

from plcopen.structures import *

    30

    31

    32

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

    33

#                         Function Block Diagram Block

    34

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

    35

    36

"""

    37

Class that implements the graphic representation of a function block

    38

"""

    39

    40

class FBD_Block(Graphic_Element):

    41

    42

    # Create a new block

    44

        Graphic_Element.__init__(self, parent)

    45

        self.Type = None

    47

        self.Name = name

    48

        self.Id = id

    49

        self.Inputs = []

    50

        self.Outputs = []

    52

    53

    # Destructor

    54

    def __del__(self):

    55

        self.Inputs = []

    56

        self.Outputs = []

    57

    58

    # Delete this block by calling the appropriate method

    59

    def Delete(self):

    60

        self.Parent.DeleteBlock(self)

    61

    62

    # Unconnect all inputs and outputs

    63

    def Clean(self):

    64

        for input in self.Inputs:

    65

            input.UnConnect(delete = True)

    66

        for output in self.Outputs:

    67

            output.UnConnect(delete = True)

    68

    69

    # Refresh the block bounding box

    70

    def RefreshBoundingBox(self):

    71

        dc = wxClientDC(self.Parent)

    72

        # Calculate the size of the name outside the block

    73

        text_width, text_height = dc.GetTextExtent(self.Name)

    74

        # Calculate the bounding box size

    75

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

    76

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

    77

        if self.Name != "":

    78

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

    79

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

    80

        else:

    81

            bbx_y = self.Pos.y

    82

            bbx_height = self.Size[1]

    83

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

    84

    85

    # Refresh the positions of the block connectors

    86

    def RefreshConnectors(self):

    87

        # Calculate the size for the connector lines

    88

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

    89

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

    90

        # Update inputs positions

    91

        position = BLOCK_LINE_SIZE + linesize / 2

    92

        for input in self.Inputs:

    93

            input.SetPosition(wxPoint(0, position))

    94

            position += linesize

    95

        # Update outputs positions

    96

        position = BLOCK_LINE_SIZE + linesize / 2

    97

        for output in self.Outputs:

    98

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

    99

            position += linesize

   100

        self.RefreshConnected()

   101

   102

    # Refresh the positions of wires connected to inputs and outputs

   103

    def RefreshConnected(self, exclude = []):

   104

        for input in self.Inputs:

   105

            input.MoveConnected(exclude)

   106

        for output in self.Outputs:

   107

            output.MoveConnected(exclude)

   108

   109

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

   120

        # Test each input connector

   121

        for input in self.Inputs:

   122

            input_pos = input.GetRelPosition()

   123

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

   124

                return input

   125

        # Test each output connector

   126

        for output in self.Outputs:

   127

            output_pos = output.GetRelPosition()

   128

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

   129

                return output

   130

        return None

   131

   132

    # Returns all the block connectors 

   133

    def GetConnectors(self):

   134

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

   135

   136

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

   137

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

   138

        # Test each input connector

   139

        for input in self.Inputs:

   140

            if input.TestPoint(pt, exclude):

   141

                return input

   142

        # Test each output connector

   143

        for output in self.Outputs:

   144

            if output.TestPoint(pt, exclude):

   145

                return output

   146

        return None

   147

   148

    # Changes the block type

   151

            self.Type = type

   153

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

   154

            # inputs and outputs

   155

            blocktype = GetBlockType(type)

   156

            if blocktype:

   157

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

   158

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

   159

                if blocktype["extensible"]:

   160

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

   161

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

   162

                        start += 1

   164

            else:

   165

                raise ValueError, "This block type isn't defined"

   166

            self.Clean()

   167

            # Extract the inputs properties and create the corresponding connector

   168

            self.Inputs = []

   169

            for input_name, input_type, input_modifier in inputs:

   171

                if input_modifier == "negated":

   172

                    connector.SetNegated(True)

   173

                elif input_modifier != "none":

   174

                    connector.SetEdge(input_modifier)

   175

                self.Inputs.append(connector)

   176

            # Extract the outputs properties and create the corresponding connector

   177

            self.Outputs = []

   178

            for output_name, output_type, output_modifier in outputs:

   179

                connector = Connector(self, output_name, output_type, wxPoint(0, 0), EAST)

   180

                if output_modifier == "negated":

   181

                    connector.SetNegated(True)

   182

                elif output_modifier != "none":

   183

                    connector.SetEdge(output_modifier)

   184

                self.Outputs.append(connector)

   185

            self.RefreshConnectors()

   186

            self.RefreshBoundingBox()

   187

   188

    # Returns the block type

   189

    def GetType(self):

   190

        return self.Type

   191

   192

    # Changes the block name

   193

    def SetName(self, name):

   194

        self.Name = name

   195

   196

    # Returs the block name

   197

    def GetName(self):

   198

        return self.Name

   199

   200

    # Changes the extension name

   201

    def SetExtension(self, extension):

   202

        self.Extension = extension

   203

   204

    # Returs the extension name

   205

    def GetExtension(self):

   206

        return self.Extension

   207

   208

    # Returns the block minimum size

   209

    def GetMinSize(self):

   210

        dc = wxClientDC(self.Parent)

   211

        text_width, text_height = dc.GetTextExtent(self.Type)

   212

        # Calculate the inputs maximum width

   213

        max_input = 0

   214

        for input in self.Inputs:

   215

            w, h = dc.GetTextExtent(input.GetName())

   216

            max_input = max(max_input, w)

   217

        # Calculate the outputs maximum width

   218

        max_output = 0

   219

        for output in self.Outputs:

   220

            w, h = dc.GetTextExtent(output.GetName())

   221

            max_output = max(max_output, w)

   222

        width = max(text_width + 10, max_input + max_output + 15)

   223

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

   224

        return width, height

   225

   226

    # Changes the negated property of the connector handled

   227

    def SetConnectorNegated(self, negated):

   228

        handle_type, handle = self.Handle

   229

        if handle_type == HANDLE_CONNECTOR:

   230

            handle.SetNegated(negated)

   231

            self.RefreshModel(False)

   232

   233

    # Changes the edge property of the connector handled

   234

    def SetConnectorEdge(self, edge):

   235

        handle_type, handle = self.Handle

   236

        if handle_type == HANDLE_CONNECTOR:

   237

            handle.SetEdge(edge)

   238

            self.RefreshModel(False)

   239

   240

    # Method called when a LeftDClick event have been generated

   242

        # Edit the block properties

   243

        self.Parent.EditBlockContent(self)

   244

   245

    # Method called when a RightUp event have been generated

   248

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

   249

        connector = self.TestConnector(pos, False)

   250

        if connector:

   251

            self.Handle = (HANDLE_CONNECTOR, connector)

   252

            self.Parent.PopupBlockMenu(connector)

   253

        else:

   254

            self.Parent.PopupBlockMenu()

   255

   256

    # Refreshes the block model

   257

    def RefreshModel(self, move=True):

   258

        self.Parent.RefreshBlockModel(self)

   259

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

   260

        if move:

   261

            for output in self.Outputs:

   262

                output.RefreshWires()

   263

   264

    # Draws block

   265

    def Draw(self, dc):

   266

        dc.SetPen(wxBLACK_PEN)

   267

        dc.SetBrush(wxWHITE_BRUSH)

   268

        # Draw a rectangle with the block size

   269

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

   270

        # Draw block name and block type

   271

        namewidth, nameheight = dc.GetTextExtent(self.Name)

   272

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

   273

                self.Pos.y - (nameheight + 2))

   274

        typewidth, typeheight = dc.GetTextExtent(self.Type)

   275

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

   276

                self.Pos.y + 5)

   277

        # Draw inputs and outputs connectors

   278

        for input in self.Inputs:

   279

            input.Draw(dc)

   280

        for output in self.Outputs:

   281

            output.Draw(dc)

   282

        Graphic_Element.Draw(self, dc)

   283

   284

   285

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

   286

#                        Function Block Diagram Variable

   287

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

   288

   289

"""

   290

Class that implements the graphic representation of a variable

   291

"""

   292

   293

class FBD_Variable(Graphic_Element):

   294

   295

    # Create a new variable

   296

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

   297

        Graphic_Element.__init__(self, parent)

   298

        self.Type = None

   299

        self.ValueType = None

   300

        self.Name = name

   301

        self.Id = id

   302

        self.Input = None

   303

        self.Output = None

   304

        self.SetType(type, value_type)

   305

   306

    # Destructor

   307

    def __del__(self):

   308

        self.Input = None

   309

        self.Output = None

   310

   311

    # Unconnect connector

   312

    def Clean(self):

   313

        if self.Input:

   314

            self.Input.UnConnect(delete = True)

   315

        if self.Output:

   316

            self.Output.UnConnect(delete = True)

   317

   318

    # Delete this variable by calling the appropriate method

   319

    def Delete(self):

   320

        self.Parent.DeleteVariable(self)

   321

   322

    # Refresh the variable bounding box

   323

    def RefreshBoundingBox(self):

   324

        dc = wxClientDC(self.Parent)

   325

        if self.Type in (OUTPUT, INOUT):

   326

            bbx_x = self.Pos.x - CONNECTOR_SIZE

   327

        else:

   328

            bbx_x = self.Pos.x

   329

        if self.Type == INOUT:

   330

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

   331

        else:

   332

            bbx_width = self.Size[0] + CONNECTOR_SIZE

   333

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

   334

   335

    # Refresh the position of the variable connector

   336

    def RefreshConnectors(self):

   337

        if self.Input:

   338

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

   339

        if self.Output:

   340

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

   341

        self.RefreshConnected(self)

   342

   343

    # Refresh the position of wires connected to connector

   344

    def RefreshConnected(self, exclude = []):

   345

        if self.Input:

   346

            self.Input.MoveConnected(exclude)

   347

        if self.Output:

   348

            self.Output.MoveConnected(exclude)

   349

   350

    # Test if point given is on the variable connector

   351

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

   352

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

   353

            return self.Input

   354

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

   355

            return self.Output

   356

        return None

   357

   358

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

   367

        # Test input connector if it exists

   368

        if self.Input:

   369

            input_pos = self.Input.GetRelPosition()

   370

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

   371

                return self.Input

   372

        # Test output connector if it exists

   373

        if self.Output:

   374

            output_pos = self.Output.GetRelPosition()

   375

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

   376

                return self.Output

   377

        return None

   378

   379

    # Returns all the block connectors 

   380

    def GetConnectors(self):

   381

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

   382

   383

    # Changes the negated property of the variable connector if handled

   384

    def SetConnectorNegated(self, negated):

   385

        handle_type, handle = self.Handle

   386

        if handle_type == HANDLE_CONNECTOR:

   387

            handle.SetNegated(negated)

   388

            self.RefreshModel(False)

   389

   390

    # Changes the variable type

   391

    def SetType(self, type, value_type):

   392

        if type != self.Type or value_type != self.ValueType:

   393

            self.Type = type

   394

            self.ValueType = value_type

   395

            self.Clean()

   396

            self.Input = None

   397

            self.Output = None

   398

            # Create an input or output connector according to variable type

   399

            if self.Type != INPUT:

   401

            if self.Type != OUTPUT:

   402

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

   403

            self.RefreshConnectors()

   404

   405

    # Returns the variable type

   406

    def GetType(self):

   407

        return self.Type

   408

   409

    # Changes the variable name

   410

    def SetName(self, name):

   411

        self.Name = name

   412

   413

    # Returns the variable name

   414

    def GetName(self):

   415

        return self.Name

   416

   417

    # Returns the variable minimum size

   418

    def GetMinSize(self):

   419

        dc = wxClientDC(self.Parent)

   420

        text_width, text_height = dc.GetTextExtent(self.Name)

   421

        return text_width + 10, text_height + 10

   422

   423

    # Method called when a LeftDClick event have been generated

   425

        # Edit the variable properties

   426

        self.Parent.EditVariableContent(self)

   427

   428

    # Method called when a RightUp event have been generated

   431

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

   433

        if connector:

   434

            self.Handle = (HANDLE_CONNECTOR, connector)

   435

            self.Parent.PopupVariableMenu(connector)

   436

        else:

   437

            self.Parent.PopupVariableMenu()

   438

   439

    # Refreshes the variable model

   440

    def RefreshModel(self, move=True):

   441

        self.Parent.RefreshVariableModel(self)

   442

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

   443

        # of wires connected to output connector

   444

        if move and self.Type != OUTPUT:

   445

            if self.Output:

   446

                self.Output.RefreshWires()

   447

   448

    # Draws variable

   449

    def Draw(self, dc):

   450

        dc.SetPen(wxBLACK_PEN)

   451

        dc.SetBrush(wxWHITE_BRUSH)

   452

        # Draw a rectangle with the variable size

   453

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

   454

        # Draw variable name

   455

        namewidth, nameheight = dc.GetTextExtent(self.Name)

   456

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

   457

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

   458

        # Draw connectors

   459

        if self.Input:

   460

            self.Input.Draw(dc)

   461

        if self.Output:    

   462

            self.Output.Draw(dc)

   463

        Graphic_Element.Draw(self, dc)

   464

   465

   466

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

   467

#                        Function Block Diagram Connector

   468

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

   469

   470

"""

   471

Class that implements the graphic representation of a connection

   472

"""

   473

   474

class FBD_Connector(Graphic_Element):

   475

   476

    # Create a new connection

   477

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

   478

        Graphic_Element.__init__(self, parent)

   479

        self.Type = type

   480

        self.Name = name

   481

        self.Id = id

   482

        self.Pos = wxPoint(0, 0)

   483

        self.Size = wxSize(0, 0)

   484

        # Create an input or output connector according to connection type

   485

        if self.Type == CONNECTOR:

   487

        else:

   488

            self.Connector = Connector(self, "", "ANY", wxPoint(0, 0), EAST)

   489

        self.RefreshConnectors()

   490

   491

    # Destructor

   492

    def __del__(self):

   493

        self.Connector = None

   494

   495

    # Unconnect connector

   496

    def Clean(self):

   497

        if self.Connector:

   498

            self.Connector.UnConnect()

   499

   500

    # Delete this connection by calling the appropriate method

   501

    def Delete(self):

   502

        self.Parent.DeleteConnection(self)

   503

   504

    # Refresh the connection bounding box

   505

    def RefreshBoundingBox(self):

   506

        dc = wxClientDC(self.Parent)

   507

        if self.Type == CONNECTOR:

   508

            bbx_x = self.Pos.x - CONNECTOR_SIZE

   509

        else:

   510

            bbx_x = self.Pos.x

   511

        bbx_width = self.Size[0] + CONNECTOR_SIZE

   512

        self.BoundingBox = wxRect(bbx_x, self.Pos.y, bbx_width, self.Size[1])

   513

   514

    # Refresh the position of the connection connector

   515

    def RefreshConnectors(self):

   516

        if self.Type == CONNECTOR:

   517

            self.Connector.SetPosition(wxPoint(0, self.Size[1] / 2))

   518

        else: