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

    30

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

    31

#                         Ladder Diagram PowerRail

    32

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

    33

    34

"""

    35

Class that implements the graphic representation of a power rail

    36

"""

    37

    38

class LD_PowerRail(Graphic_Element):

    39

    40

    # Create a new power rail

    41

    def __init__(self, parent, type, id = None, connectors = [True]):

    42

        Graphic_Element.__init__(self, parent)

    43

        self.Type = None

    44

        self.Connectors = []

    46

        self.Id = id

    47

        self.Extensions = [LD_LINE_SIZE / 2, LD_LINE_SIZE / 2]

    48

        if len(connectors) < 1:

    49

            connectors = [True]

    50

        self.SetType(type, connectors)

    51

    52

    # Destructor

    53

    def __del__(self):

    54

        self.Connectors = []

    55

    56

    # Forbids to change the power rail size

    57

    def SetSize(self, width, height):

    58

        if self.Parent.GetDrawingMode() == FREEDRAWING_MODE:

    59

            Graphic_Element.SetSize(self, width, height)

    60

            self.RefreshConnectors()

    61

    62

    # Forbids to select a power rail

    63

    def HitTest(self, pt):

    64

        if self.Parent.GetDrawingMode() == FREEDRAWING_MODE:

    65

            return Graphic_Element.HitTest(self, pt) or self.TestConnector(pt, False) != None

    66

        return False

    67

    68

    # Forbids to select a power rail

    69

    def IsInSelection(self, rect):

    70

        if self.Parent.GetDrawingMode() == FREEDRAWING_MODE:

    71

            return Graphic_Element.IsInSelection(self, rect)

    72

        return False

    73

    74

    # Deletes this power rail by calling the appropriate method

    75

    def Delete(self):

    76

        self.Parent.DeletePowerRail(self)

    77

    78

    # Unconnect all connectors

    79

    def Clean(self):

    80

        for connector in self.Connectors:

    81

            if connector:

    82

                connector.UnConnect(delete = self.Parent.GetDrawingMode() == FREEDRAWING_MODE)

    83

    84

    # Refresh the power rail bounding box

    85

    def RefreshBoundingBox(self):

    86

        dc = wx.ClientDC(self.Parent)

    87

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

    88

    89

    # Refresh the power rail size

    90

    def RefreshSize(self):

    91

        self.Size = wx.Size(2, LD_LINE_SIZE * len(self.Connectors))

    92

        self.RefreshBoundingBox()

    93

    94

    # Returns the block minimum size

    95

    def GetMinSize(self):

    96

        return 2, LD_LINE_SIZE * len(self.Connectors)

    97

    98

    # Add a connector or a blank to this power rail at the last place

    99

    def AddConnector(self, connector = True):

   100

        self.InsertConnector(len(self.Connectors), connector)

   101

   102

    # Add a connector or a blank to this power rail at the place given

   103

    def InsertConnector(self, idx, connector = True):

   104

        if connector:

   105

            if self.Type == LEFTRAIL:

   106

                connector = Connector(self, "", "BOOL", wx.Point(2, 0), EAST)

   107

            elif self.Type == RIGHTRAIL:

   108

                connector = Connector(self, "", "BOOL", wx.Point(0, 0), WEST)

   109

            self.Connectors.insert(idx, connector)

   110

        else:

   111

            self.Connectors.insert(idx, None)

   112

        self.RefreshSize()

   113

        self.RefreshConnectors()

   114

   115

    # Moves the divergence connector given

   116

    def MoveConnector(self, connector, movey):

   117

        position = connector.GetRelPosition()

   118

        connector.SetPosition(wx.Point(position.x, position.y + movey))

   119

        miny = self.Size[1]

   120

        maxy = 0

   121

        for connect in self.Connectors:

   122

            connect_pos = connect.GetRelPosition()

   123

            miny = min(miny, connect_pos.y)

   124

            maxy = max(maxy, connect_pos.y)

   125

        min_pos = self.Pos.y + miny - self.Extensions[0]

   126

        self.Pos.y = min(min_pos, self.Pos.y)

   127

        if min_pos == self.Pos.y:

   128

            for connect in self.Connectors:

   129

                connect_pos = connect.GetRelPosition()

   130

                connect.SetPosition(wx.Point(connect_pos.x, connect_pos.y - miny + self.Extensions[0]))

   131

        self.Size[1] = max(maxy - miny + self.Extensions[0] + self.Extensions[1], self.Size[1])

   132

        connector.MoveConnected()

   133

        self.RefreshBoundingBox()

   134

   135

    # Returns the index in connectors list for the connector given

   136

    def GetConnectorIndex(self, connector):

   137

        if connector in self.Connectors:

   138

            return self.Connectors.index(connector)

   139

        return None

   140

   141

    # Returns if there is a connector in connectors list at the index given

   142

    def IsNullConnector(self, idx):

   143

        if idx < len(self.Connectors):

   144

            return self.Connectors[idx] == None

   145

        return False

   146

   147

    # Delete the connector or blank from connectors list at the index given

   148

    def DeleteConnector(self, idx):

   149

        self.Connectors.pop(idx)

   150

        self.RefreshConnectors()

   151

        self.RefreshSize()

   152

   153

    # Refresh the positions of the power rail connectors

   154

    def RefreshConnectors(self):

   173

        self.RefreshConnected()

   174

   175

    # Refresh the position of wires connected to power rail

   176

    def RefreshConnected(self, exclude = []):

   177

        for connector in self.Connectors:

   178

            if connector:

   179

                connector.MoveConnected(exclude)

   180

   181

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

   182

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

   183

        # if a name is given

   184

        if name:

   185

            # Test each connector if it exists

   186

            for connector in self.Connectors:

   187

                if connector and name == connector.GetName():

   188

                    return connector

   189

        for connector in self.Connectors:

   190

            if connector:

   191

                connector_pos = connector.GetRelPosition()

   192

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

   193

                    return connector

   194

        return None

   195

   196

    # Returns all the power rail connectors 

   197

    def GetConnectors(self):

   198

        return [connector for connector in self.Connectors if connector]

   199

   200

    # Test if point given is on one of the power rail connectors

   201

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

   202

        for connector in self.Connectors:

   203

            if connector and connector.TestPoint(pt, exclude):

   204

                return connector

   205

        return None

   206

   207

    # Returns the power rail type

   208

    def SetType(self, type, connectors):

   209

        if type != self.Type or len(self.Connectors) != len(connectors):

   210

            # Create a connector or a blank according to 'connectors' and add it in

   211

            # the connectors list

   212

            self.Type = type

   213

            self.Clean()

   214

            self.Connectors = []

   215

            for connector in connectors:

   216

                self.AddConnector(connector)

   217

            self.RefreshSize()

   218

   219

    # Returns the power rail type

   220

    def GetType(self):

   221

        return self.Type

   222

   223

    # Method called when a LeftDown event have been generated

   224

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

   225

        pos = GetScaledEventPosition(event, dc, scaling)

   226

        # Test if a connector have been handled

   227

        connector = self.TestConnector(pos, False)

   228

        if connector:

   229

            self.Handle = (HANDLE_CONNECTOR, connector)

   230

            self.Parent.SetCursor(wx.StockCursor(wx.CURSOR_HAND))

   231

            self.Selected = False

   232

            # Initializes the last position

   233

            self.oldPos = GetScaledEventPosition(event, dc, scaling)

   234

        else:

   241

            Graphic_Element.OnLeftDown(self, event, dc, scaling)

   242

   243

    # Method called when a LeftUp event have been generated

   244

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

   245

        self.RealConnectors = None

   246

        handle_type, handle = self.Handle

   247

        if handle_type == HANDLE_CONNECTOR:

   248

            wires = handle.GetWires()

   249

            if len(wires) != 1:

   250

                return

   251

            if handle == wires[0][0].StartConnected:

   252

                block = wires[0][0].EndConnected.GetParentBlock()

   253

            else:

   254

                block = wires[0][0].StartConnected.GetParentBlock()

   255

            block.RefreshModel(False)

   256

        Graphic_Element.OnLeftUp(self, event, dc, scaling)

   257

   258

    # Method called when a LeftDClick event have been generated

   259

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

   260

        # Edit the powerrail properties

   261

        self.Parent.EditPowerRailContent(self)

   262

   263

    # Method called when a RightUp event have been generated

   264

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

   265

        pos = GetScaledEventPosition(event, dc, scaling)

   266

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

   267

        connector = self.TestConnector(pos, False)

   268

        if connector:

   269

            self.Handle = (HANDLE_CONNECTOR, connector)

   270

        #    self.Parent.PopupDivergenceMenu(True)

   271

        #else:

   272

            # Popup the divergence menu without delete branch

   273

        #    self.Parent.PopupDivergenceMenu(False)

   274

   275

    # Refreshes the divergence state according to move defined and handle selected

   276

    def ProcessDragging(self, movex, movey):

   277

        handle_type, handle = self.Handle

   278

        # A connector has been handled

   279

        if handle_type == HANDLE_CONNECTOR:

   280

            self.MoveConnector(handle, movey)

   281

        else:

   282

            Graphic_Element.ProcessDragging(self, movex, movey)

   283

   284

    # Refreshes the power rail model

   285

    def RefreshModel(self, move=True):

   286

        self.Parent.RefreshPowerRailModel(self)

   287

        # If power rail has moved and power rail is of type LEFT, refresh the model 

   288

        # of wires connected to connectors

   289

        if move and self.Type == LEFTRAIL:

   290

            for connector in self.Connectors:

   291

                if connector:

   292

                    connector.RefreshWires()

   293

   294

    # Draws power rail

   295

    def Draw(self, dc):

   296

        dc.SetPen(wx.BLACK_PEN)

   297

        dc.SetBrush(wx.BLACK_BRUSH)

   298

        # Draw a rectangle with the power rail size

   299

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

   300

        # Draw connectors

   301

        for connector in self.Connectors:

   302

            if connector:

   303

                connector.Draw(dc)

   304

        Graphic_Element.Draw(self, dc)

   305

   306

   307

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

   308

#                         Ladder Diagram Contact

   309

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

   310

   311

"""

   312

Class that implements the graphic representation of a contact

   313

"""

   314

   315

class LD_Contact(Graphic_Element):

   316

   317

    # Create a new contact

   318

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

   319

        Graphic_Element.__init__(self, parent)

   320

        self.Type = type

   321

        self.Name = name

   322

        self.Id = id

   323

        self.Size = wx.Size(LD_ELEMENT_SIZE[0], LD_ELEMENT_SIZE[1])

   324

        # Create an input and output connector

   325

        self.Input = Connector(self, "", "BOOL", wx.Point(0, self.Size[1] / 2 + 1), WEST)

   326

        self.Output = Connector(self, "", "BOOL", wx.Point(self.Size[0], self.Size[1] / 2 + 1), EAST)

   327

        self.RefreshNameSize()

   328

        self.RefreshTypeSize()

   329

   330

    # Destructor

   331

    def __del__(self):

   332

        self.Input = None

   333

        self.Output = None

   334

   335

    # Forbids to change the contact size

   336

    def SetSize(self, width, height):

   337

        if self.Parent.GetDrawingMode() == FREEDRAWING_MODE:

   338

            Graphic_Element.SetSize(self, width, height)

   339

            self.RefreshConnectors()

   340

   341

    # Delete this contact by calling the appropriate method

   342

    def Delete(self):

   343

        self.Parent.DeleteContact(self)

   344

   345

    # Unconnect input and output

   346

    def Clean(self):

   347

        self.Input.UnConnect(delete = self.Parent.GetDrawingMode() == FREEDRAWING_MODE)

   348

        self.Output.UnConnect(delete = self.Parent.GetDrawingMode() == FREEDRAWING_MODE)

   349

   350

    # Refresh the size of text for name

   351

    def RefreshNameSize(self):

   352

        dc = wx.ClientDC(self.Parent)

   353

        if self.Name != "":

   354

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

   355

        else:

   356

            self.NameSize = 0, 0

   357

   358

    # Refresh the size of text for type

   359

    def RefreshTypeSize(self):

   360

        dc = wx.ClientDC(self.Parent)

   361

        typetext = ""

   362

        if self.Type == CONTACT_REVERSE:

   363

            typetext = "/"

   364

        elif self.Type == CONTACT_RISING:

   365

            typetext = "P"

   366

        elif self.Type == CONTACT_FALLING:

   367

            typetext = "N"

   368

        if typetext != "":

   369

            self.TypeSize = dc.GetTextExtent(typetext)

   370

        else:

   371

            self.TypeSize = 0, 0

   372

   373

    # Refresh the contact bounding box

   374

    def RefreshBoundingBox(self):

   375

        dc = wx.ClientDC(self.Parent)

   376

        # Calculate the size of the name outside the contact

   377

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

   378

        # Calculate the bounding box size

   379

        if self.Name != "":

   380

            bbx_x = self.Pos.x - max(0, (text_width - self.Size[0]) / 2)

   381

            bbx_width = max(self.Size[0], text_width)

   382

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

   383

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

   384

        else:

   385

            bbx_x = self.Pos.x

   386

            bbx_width = self.Size[0]

   387

            bbx_y = self.Pos.y

   388

            bbx_height = self.Size[1]

   389

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

   390

   391

    # Returns the block minimum size

   392

    def GetMinSize(self):

   393

        return LD_ELEMENT_SIZE

   394

   395

    # Refresh the position of wire connected to contact

   396

    def RefreshConnected(self, exclude = []):

   397

        self.Input.MoveConnected(exclude)

   398

        self.Output.MoveConnected(exclude)

   399

   400

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

   401

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

   402

        # if a name is given

   403

        if name:

   404

            # Test input and output connector

   405

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

   406

                return self.Input

   407

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

   408

                return self.Output

   409

        # Test input connector

   410

        input_pos = self.Input.GetRelPosition()

   411

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

   412

            return self.Input

   413

        # Test output connector

   414

        output_pos = self.Output.GetRelPosition()

   415

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

   416

            return self.Output

   417

        return None

   418

   419

    # Returns input and output contact connectors 

   420

    def GetConnectors(self):

   421

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

   422

   423

    # Test if point given is on contact input or output connector

   424

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

   425

        # Test input connector

   426

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

   427

            return self.Input

   428

        # Test output connector

   429

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

   430

            return self.Output

   431

        return None

   432

   433

    # Refresh the positions of the block connectors

   434

    def RefreshConnectors(self):

   435

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

   436

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

   437

        self.RefreshConnected()

   438

   439

    # Changes the contact name

   440

    def SetName(self, name):

   441

        self.Name = name

   442

        self.RefreshNameSize()

   443

   444

    # Returns the contact name

   445

    def GetName(self):

   446

        return self.Name

   447

   448

    # Changes the contact type

   449

    def SetType(self, type):

   450

        self.Type = type

   451

        self.RefreshTypeSize()

   452

   453

    # Returns the contact type

   454

    def GetType(self):

   455

        return self.Type

   456

   457

    # Method called when a LeftDClick event have been generated

   458

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

   459

        # Edit the contact properties

   460

        self.Parent.EditContactContent(self)

   461

   462

    # Refreshes the contact model

   463

    def RefreshModel(self, move=True):

   464

        self.Parent.RefreshContactModel(self)

   465

        # If contact has moved, refresh the model of wires connected to output

   466

        if move:

   467

            self.Output.RefreshWires()

   468

   469

    # Draws contact

   470

    def Draw(self, dc):

   471

        dc.SetPen(wx.BLACK_PEN)

   472

        dc.SetBrush(wx.BLACK_BRUSH)

   473

        # Draw two rectangles for representing the contact

   474

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

   475

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

   476

        # Draw contact name

   477

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

   478

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

   479

        # Draw the modifier symbol in the middle of contact

   480

        typetext = ""

   481

        if self.Type == CONTACT_REVERSE:

   482

            typetext = "/"

   483

        elif self.Type == CONTACT_RISING:

   484

            typetext = "P"

   485

        elif self.Type == CONTACT_FALLING:

   486

            typetext = "N"

   487

        if typetext != "":

   488

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

   489

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

   490

        # Draw input and output connectors

   491

        self.Input.Draw(dc)

   492

        self.Output.Draw(dc)

   493

        Graphic_Element.Draw(self, dc)

   494

   495

   496

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

   497

#                         Ladder Diagram Coil

   498

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

   499

   500

"""

   501

Class that implements the graphic representation of a coil

   502

"""

   503

   504

class LD_Coil(Graphic_Element):

   505

   506

    # Create a new coil

   507

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

   508

        Graphic_Element.__init__(self, parent)