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 = []

    45

        self.RealConnectors = None

    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

    def Flush(self):

    53

        for connector in self.Connectors:

    54

            if connector is not None:

    55

                connector.Flush()

    56

        self.Connectors = []

    57

    58

    # Make a clone of this LD_PowerRail

    59

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

    60

        powerrail = LD_PowerRail(parent, self.Type, id)

    61

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

    62

        if pos is not None:

    63

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

    64

        powerrail.Connectors = []

    65

        for connector in self.Connectors:

    66

            if connector is not None:

    67

                powerrail.Connectors.append(connector.Clone(powerrail))

    68

            else:

    69

                powerrail.Connectors.append(None)

    70

        return powerrail

    71

    72

    # Returns the RedrawRect

    73

    def GetRedrawRect(self, movex = 0, movey = 0):

    74

        rect = Graphic_Element.GetRedrawRect(self, movex, movey)

    75

        for connector in self.Connectors:

    76

            if connector is not None:

    77

                rect = rect.Union(connector.GetRedrawRect(movex, movey))

    78

        if movex != 0 or movey != 0:

    79

            for connector in self.Connectors:

    80

                if connector is not None and connector.IsConnected():

    81

                    rect = rect.Union(connector.GetConnectedRedrawRect(movex, movey))

    82

        return rect

    83

    84

    # Forbids to change the power rail size

    85

    def SetSize(self, width, height):

    86

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

    87

            Graphic_Element.SetSize(self, width, height)

    88

            self.RefreshConnectors()

    89

    90

    # Forbids to select a power rail

    91

    def HitTest(self, pt):

    92

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

    93

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

    94

        return False

    95

    96

    # Forbids to select a power rail

    97

    def IsInSelection(self, rect):

    98

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

    99

            return Graphic_Element.IsInSelection(self, rect)

   100

        return False

   101

   102

    # Deletes this power rail by calling the appropriate method

   103

    def Delete(self):

   104

        self.Parent.DeletePowerRail(self)

   105

   106

    # Unconnect all connectors

   107

    def Clean(self):

   108

        for connector in self.Connectors:

   109

            if connector:

   110

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

   111

   112

    # Refresh the power rail bounding box

   113

    def RefreshBoundingBox(self):

   114

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

   115

   116

    # Refresh the power rail size

   117

    def RefreshSize(self):

   118

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

   119

        self.RefreshBoundingBox()

   120

   121

    # Returns the block minimum size

   122

    def GetMinSize(self):

   123

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

   124

            return LD_POWERRAIL_WIDTH, self.Extensions[0] + self.Extensions[1]

   125

        else:

   126

            return LD_POWERRAIL_WIDTH, LD_LINE_SIZE * len(self.Connectors)

   127

   128

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

   129

    def AddConnector(self, connector = True):

   130

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

   131

   132

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

   133

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

   134

        if connector:

   135

            if self.Type == LEFTRAIL:

   136

                connector = Connector(self, "", "BOOL", wx.Point(self.Size[0], 0), EAST)

   137

            elif self.Type == RIGHTRAIL:

   138

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

   139

            self.Connectors.insert(idx, connector)

   140

        else:

   141

            self.Connectors.insert(idx, None)

   142

        self.RefreshSize()

   143

        self.RefreshConnectors()

   144

   145

    # Moves the divergence connector given

   146

    def MoveConnector(self, connector, movey):

   147

        position = connector.GetRelPosition()

   148

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

   149

        miny = self.Size[1]

   150

        maxy = 0

   151

        for connect in self.Connectors:

   152

            connect_pos = connect.GetRelPosition()

   153

            miny = min(miny, connect_pos.y - self.Extensions[0])

   154

            maxy = max(maxy, connect_pos.y - self.Extensions[0])

   155

        min_pos = self.Pos.y + miny

   156

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

   157

        if min_pos == self.Pos.y:

   158

            for connect in self.Connectors:

   159

                connect_pos = connect.GetRelPosition()

   160

                connect.SetPosition(wx.Point(connect_pos.x, connect_pos.y - miny))

   161

        self.Connectors.sort(lambda x, y: x.Pos.y.__cmp__(y.Pos.y))

   162

        maxy = 0

   163

        for connect in self.Connectors:

   164

            connect_pos = connect.GetRelPosition()

   165

            maxy = max(maxy, connect_pos.y)

   166

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

   167

        connector.MoveConnected()

   168

        self.RefreshBoundingBox()

   169

   170

    # Returns the index in connectors list for the connector given

   171

    def GetConnectorIndex(self, connector):

   172

        if connector in self.Connectors:

   173

            return self.Connectors.index(connector)

   174

        return None

   175

   176

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

   177

    def IsNullConnector(self, idx):

   178

        if idx < len(self.Connectors):

   179

            return self.Connectors[idx] == None

   180

        return False

   181

   182

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

   183

    def DeleteConnector(self, idx):

   184

        self.Connectors.pop(idx)

   185

        self.RefreshConnectors()

   186

        self.RefreshSize()

   187

   188

    # Refresh the positions of the power rail connectors

   189

    def RefreshConnectors(self):

   190

        scaling = self.Parent.GetScaling()

   191

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

   192

            height = self.Size[1] - self.Extensions[0] - self.Extensions[1]

   193

            interval = float(height) / float(max(len(self.Connectors) - 1, 1))

   194

            for i, connector in enumerate(self.Connectors):

   195

                if self.RealConnectors:

   196

                    position = self.Extensions[0] + int(round(self.RealConnectors[i] * height))

   197

                else:

   198

                    position = self.Extensions[0] + int(round(i * interval))

   199

                if scaling is not None:

   200

                    position = round(float(self.Pos.y + position) / float(scaling[1])) * scaling[1] - self.Pos.y

   201

                if self.Type == LEFTRAIL:

   202

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

   203

                elif self.Type == RIGHTRAIL:

   204

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

   205

        else:

   206

            position = self.Extensions[0]

   207

            for connector in self.Connectors:

   208

                if connector:

   209

                    if scaling is not None:

   210

                        ypos = round(float(self.Pos.y + position) / float(scaling[1])) * scaling[1] - self.Pos.y

   211

                    else:

   212

                        ypos = position

   213

                    if self.Type == LEFTRAIL:

   214

                        connector.SetPosition(wx.Point(self.Size[0], ypos))

   215

                    elif self.Type == RIGHTRAIL:

   216

                        connector.SetPosition(wx.Point(0, ypos))

   217

                position += LD_LINE_SIZE

   218

        self.RefreshConnected()

   219

   220

    # Refresh the position of wires connected to power rail

   221

    def RefreshConnected(self, exclude = []):

   222

        for connector in self.Connectors:

   223

            if connector:

   224

                connector.MoveConnected(exclude)

   225

   226

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

   227

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

   228

        # if a name is given

   229

        if name:

   230

            # Test each connector if it exists

   231

            for connector in self.Connectors:

   232

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

   233

                    return connector

   234

        for connector in self.Connectors:

   235

            if connector:

   236

                connector_pos = connector.GetRelPosition()

   237

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

   238

                    return connector

   239

        return None

   240

   241

    # Returns all the power rail connectors 

   242

    def GetConnectors(self):

   243

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

   244

   245

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

   246

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

   247

        for connector in self.Connectors:

   248

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

   249

                return connector

   250

        return None

   251

   252

    # Returns the power rail type

   253

    def SetType(self, type, connectors):

   254

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

   255

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

   256

            # the connectors list

   257

            self.Type = type

   258

            self.Clean()

   259

            self.Connectors = []

   260

            for connector in connectors:

   261

                self.AddConnector(connector)

   262

            self.RefreshSize()

   263

   264

    # Returns the power rail type

   265

    def GetType(self):

   266

        return self.Type

   267

   268

    # Method called when a LeftDown event have been generated

   269

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

   270

        self.RealConnectors = []

   271

        height = self.Size[1] - self.Extensions[0] - self.Extensions[1]

   272

        for connector in self.Connectors:

   273

            position = connector.GetRelPosition()

   274

            self.RealConnectors.append(float(position.y - self.Extensions[0])/float(max(1, height)))

   275

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

   276

   277

    # Method called when a LeftUp event have been generated

   278

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

   279

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

   280

        self.RealConnectors = None

   281

   282

    # Method called when a LeftDown event have been generated

   283

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

   284

        pos = GetScaledEventPosition(event, dc, scaling)

   285

        # Test if a connector have been handled

   286

        connector = self.TestConnector(pos, exclude=False)

   287

        if connector:

   288

            self.Handle = (HANDLE_CONNECTOR, connector)

   289

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

   290

            self.Selected = False

   291

            # Initializes the last position

   292

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

   293

        else:

   294

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

   295

   296

    # Method called when a LeftDClick event have been generated

   297

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

   298

        # Edit the powerrail properties

   299

        self.Parent.EditPowerRailContent(self)

   300

   301

    # Method called when a RightUp event have been generated

   302

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

   303

        handle_type, handle = self.Handle

   304

        if handle_type == HANDLE_CONNECTOR:

   305

            wires = handle.GetWires()

   306

            if len(wires) == 1:

   307

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

   308

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

   309

                else:

   310

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

   311

                block.RefreshModel(False)

   312

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

   313

        else:

   314

            self.Parent.PopupDefaultMenu()

   315

   316

    def Resize(self, x, y, width, height):

   317

        self.Move(x, y)

   318

        self.SetSize(LD_POWERRAIL_WIDTH, height)

   319

   320

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

   321

    def ProcessDragging(self, movex, movey, centered, scaling):

   322

        handle_type, handle = self.Handle

   323

        # A connector has been handled

   324

        if handle_type == HANDLE_CONNECTOR:

   325

            movey = max(-self.BoundingBox.y, movey)

   326

            if scaling is not None:

   327

                position = handle.GetRelPosition()

   328

                movey = round(float(self.Pos.y + position.y + movey) / float(scaling[1])) * scaling[1] - self.Pos.y - position.y

   329

            self.MoveConnector(handle, movey)

   330

            return 0, movey

   331

        else:

   332

            return Graphic_Element.ProcessDragging(self, movex, movey, centered, scaling)

   333

   334

    # Refreshes the power rail model

   335

    def RefreshModel(self, move=True):

   336

        self.Parent.RefreshPowerRailModel(self)

   337

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

   338

        # of wires connected to connectors

   339

        if move and self.Type == LEFTRAIL:

   340

            for connector in self.Connectors:

   341

                if connector:

   342

                    connector.RefreshWires()

   343

   344

    # Draws power rail

   345

    def Draw(self, dc):

   346

        Graphic_Element.Draw(self, dc)

   347

        dc.SetPen(wx.BLACK_PEN)

   348

        dc.SetBrush(wx.BLACK_BRUSH)

   349

        # Draw a rectangle with the power rail size

   350

        if self.Type == LEFTRAIL:

   351

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

   352

        else:

   353

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

   354

        # Draw connectors

   355

        for connector in self.Connectors:

   356

            if connector:

   357

                connector.Draw(dc)

   358

   359

   360

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

   361

#                         Ladder Diagram Contact

   362

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

   363

   364

"""

   365

Class that implements the graphic representation of a contact

   366

"""

   367

   368

class LD_Contact(Graphic_Element):

   369

   370

    # Create a new contact

   371

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

   372

        Graphic_Element.__init__(self, parent)

   373

        self.Type = type

   374

        self.Name = name

   375

        self.Id = id

   376

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

   377

        self.Errors = {}

   378

        # Create an input and output connector

   379

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

   380

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

   381

        self.Value = None

   382

        self.PreviousValue = False

   383

        self.PreviousSpreading = False

   384

        self.RefreshNameSize()

   385

        self.RefreshTypeSize()

   386

   387

    def Flush(self):

   388

        if self.Input is not None:

   389

            self.Input.Flush()

   390

            self.Input = None

   391

        if self.Output is not None:

   392

            self.Output.Flush()

   393

            self.Output = None

   394

   395

    def SetValue(self, value):

   396

        self.PreviousValue = self.Value

   397

        self.Value = value

   398

        if self.Value != self.PreviousValue:

   399

            self.Refresh()

   400

            self.SpreadCurrent()

   401

   402

    def SpreadCurrent(self):

   403

        spreading = self.Input.ReceivingCurrent()

   404

        if self.Value is not None:

   405

            if self.Type == CONTACT_NORMAL:

   406

                spreading &= self.Value

   407

            elif self.Type == CONTACT_REVERSE:

   408

                spreading &= not self.Value

   409

            elif self.Type == CONTACT_RISING:

   410

                spreading &= self.Value and not self.PreviousValue

   411

            elif self.Type == CONTACT_FALLING:

   412

                spreading &= self.Value and not self.PreviousValue

   413

            else:

   414

                spreading = False

   415

        if spreading and not self.PreviousSpreading:

   416

            self.Output.SpreadCurrent(True)

   417

        elif not spreading and self.PreviousSpreading:

   418

            self.Output.SpreadCurrent(False)

   419

        self.PreviousSpreading = spreading

   420

   421

    # Make a clone of this LD_Contact

   422

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

   423

        contact = LD_Contact(parent, self.Type, self.Name, id)

   424

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

   425

        if pos is not None:

   426

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

   427

        contact.Input = self.Input.Clone(contact)

   428

        contact.Output = self.Output.Clone(contact)

   429

        return contact

   430

   431

    # Returns the RedrawRect

   432

    def GetRedrawRect(self, movex = 0, movey = 0):

   433

        rect = Graphic_Element.GetRedrawRect(self, movex, movey)

   434

        rect = rect.Union(self.Input.GetRedrawRect(movex, movey))

   435

        rect = rect.Union(self.Output.GetRedrawRect(movex, movey))

   436

        if movex != 0 or movey != 0:

   437

            if self.Input.IsConnected():

   438

                rect = rect.Union(self.Input.GetConnectedRedrawRect(movex, movey))

   439

            if self.Output.IsConnected():

   440

                rect = rect.Union(self.Output.GetConnectedRedrawRect(movex, movey))

   441

        return rect

   442

   443

    def ProcessDragging(self, movex, movey, centered, scaling):

   444

        return Graphic_Element.ProcessDragging(self, movex, movey, centered, scaling, height_fac = 2)

   445

   446

    # Forbids to change the contact size

   447

    def SetSize(self, width, height):

   448

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

   449

            Graphic_Element.SetSize(self, width, height)

   450

            self.RefreshConnectors()

   451

   452

    # Delete this contact by calling the appropriate method

   453

    def Delete(self):

   454

        self.Parent.DeleteContact(self)

   455

   456

    # Unconnect input and output

   457

    def Clean(self):

   458

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

   459

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

   460

   461

    # Refresh the size of text for name

   462

    def RefreshNameSize(self):

   463

        if self.Name != "":

   464

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

   465

        else:

   466

            self.NameSize = 0, 0

   467

   468

    # Refresh the size of text for type

   469

    def RefreshTypeSize(self):

   470

        typetext = ""

   471

        if self.Type == CONTACT_REVERSE:

   472

            typetext = "/"

   473

        elif self.Type == CONTACT_RISING:

   474

            typetext = "P"

   475

        elif self.Type == CONTACT_FALLING:

   476

            typetext = "N"

   477

        if typetext != "":

   478

            self.TypeSize = self.Parent.GetTextExtent(typetext)

   479

        else:

   480

            self.TypeSize = 0, 0

   481

   482

    # Refresh the contact bounding box

   483

    def RefreshBoundingBox(self):

   484

        # Calculate the size of the name outside the contact

   485

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

   486

        # Calculate the bounding box size

   487

        if self.Name != "":

   488

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

   489

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

   490

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

   491

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

   492

        else:

   493

            bbx_x = self.Pos.x

   494

            bbx_width = self.Size[0]

   495

            bbx_y = self.Pos.y

   496

            bbx_height = self.Size[1]

   497

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

   498

   499

    # Returns the block minimum size