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

        else:

    65

            powerrail.SetPosition(self.Pos.x, self.Pos.y)

    66

        powerrail.Connectors = []

    67

        for connector in self.Connectors:

    68

            if connector is not None:

    69

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

    70

            else:

    71

                powerrail.Connectors.append(None)

    72

        return powerrail

    73

    74

    def GetConnectorTranslation(self, element):

    75

        return dict(zip([connector for connector in self.Connectors if connector is not None],

    76

                        [connector for connector in element.Connectors if connector is not None]))

    77

    78

    # Returns the RedrawRect

    79

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

    80

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

    81

        for connector in self.Connectors:

    82

            if connector is not None:

    83

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

    84

        if movex != 0 or movey != 0:

    85

            for connector in self.Connectors:

    86

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

    87

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

    88

        return rect

    89

    90

    # Forbids to change the power rail size

    91

    def SetSize(self, width, height):

    92

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

    93

            Graphic_Element.SetSize(self, width, height)

    94

            self.RefreshConnectors()

    95

    96

    # Forbids to select a power rail

    97

    def HitTest(self, pt):

    98

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

    99

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

   100

        return False

   101

   102

    # Forbids to select a power rail

   103

    def IsInSelection(self, rect):

   104

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

   105

            return Graphic_Element.IsInSelection(self, rect)

   106

        return False

   107

   108

    # Deletes this power rail by calling the appropriate method

   109

    def Delete(self):

   110

        self.Parent.DeletePowerRail(self)

   111

   112

    # Unconnect all connectors

   113

    def Clean(self):

   114

        for connector in self.Connectors:

   115

            if connector:

   116

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

   117

   118

    # Refresh the power rail bounding box

   119

    def RefreshBoundingBox(self):

   120

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

   121

   122

    # Refresh the power rail size

   123

    def RefreshSize(self):

   124

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

   125

        self.RefreshBoundingBox()

   126

   127

    # Returns the block minimum size

   128

    def GetMinSize(self):

   129

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

   130

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

   131

        else:

   132

            return LD_POWERRAIL_WIDTH, LD_LINE_SIZE * len(self.Connectors)

   133

   134

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

   135

    def AddConnector(self, connector = True):

   136

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

   137

   138

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

   139

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

   140

        if connector:

   141

            if self.Type == LEFTRAIL:

   142

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

   143

            elif self.Type == RIGHTRAIL:

   144

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

   145

            self.Connectors.insert(idx, connector)

   146

        else:

   147

            self.Connectors.insert(idx, None)

   148

        self.RefreshSize()

   149

        self.RefreshConnectors()

   150

   151

    # Moves the divergence connector given

   152

    def MoveConnector(self, connector, movey):

   153

        position = connector.GetRelPosition()

   154

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

   155

        miny = self.Size[1]

   156

        maxy = 0

   157

        for connect in self.Connectors:

   158

            connect_pos = connect.GetRelPosition()

   159

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

   160

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

   161

        min_pos = self.Pos.y + miny

   162

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

   163

        if min_pos == self.Pos.y:

   164

            for connect in self.Connectors:

   165

                connect_pos = connect.GetRelPosition()

   166

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

   167

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

   168

        maxy = 0

   169

        for connect in self.Connectors:

   170

            connect_pos = connect.GetRelPosition()

   171

            maxy = max(maxy, connect_pos.y)

   172

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

   173

        connector.MoveConnected()

   174

        self.RefreshBoundingBox()

   175

   176

    # Returns the index in connectors list for the connector given

   177

    def GetConnectorIndex(self, connector):

   178

        if connector in self.Connectors:

   179

            return self.Connectors.index(connector)

   180

        return None

   181

   182

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

   183

    def IsNullConnector(self, idx):

   184

        if idx < len(self.Connectors):

   185

            return self.Connectors[idx] == None

   186

        return False

   187

   188

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

   189

    def DeleteConnector(self, idx):

   190

        self.Connectors.pop(idx)

   191

        self.RefreshConnectors()

   192

        self.RefreshSize()

   193

   194

    # Refresh the positions of the power rail connectors

   195

    def RefreshConnectors(self):

   196

        scaling = self.Parent.GetScaling()

   197

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

   198

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

   199

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

   200

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

   201

                if self.RealConnectors:

   202

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

   203

                else:

   204

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

   205

                if scaling is not None:

   206

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

   207

                if self.Type == LEFTRAIL:

   208

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

   209

                elif self.Type == RIGHTRAIL:

   210

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

   211

        else:

   212

            position = self.Extensions[0]

   213

            for connector in self.Connectors:

   214

                if connector:

   215

                    if scaling is not None:

   216

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

   217

                    else:

   218

                        ypos = position

   219

                    if self.Type == LEFTRAIL:

   220

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

   221

                    elif self.Type == RIGHTRAIL:

   222

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

   223

                position += LD_LINE_SIZE

   224

        self.RefreshConnected()

   225

   226

    # Refresh the position of wires connected to power rail

   227

    def RefreshConnected(self, exclude = []):

   228

        for connector in self.Connectors:

   229

            if connector:

   230

                connector.MoveConnected(exclude)

   231

   232

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

   233

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

   234

        # if a name is given

   235

        if name:

   236

            # Test each connector if it exists

   237

            for connector in self.Connectors:

   238

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

   239

                    return connector

   240

        for connector in self.Connectors:

   241

            if connector:

   242

                connector_pos = connector.GetRelPosition()

   243

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

   244

                    return connector

   245

        return None

   246

   247

    # Returns all the power rail connectors 

   248

    def GetConnectors(self):

   249

        connectors = [connector for connector in self.Connectors if connector]

   250

        if self.Type == LEFTRAIL:

   251

            return {"inputs": [], "outputs": connectors}

   252

        else:

   253

            return {"inputs": connectors, "outputs": []}

   254

   255

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

   256

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

   257

        for connector in self.Connectors:

   258

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

   259

                return connector

   260

        return None

   261

   262

    # Returns the power rail type

   263

    def SetType(self, type, connectors):

   264

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

   265

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

   266

            # the connectors list

   267

            self.Type = type

   268

            self.Clean()

   269

            self.Connectors = []

   270

            for connector in connectors:

   271

                self.AddConnector(connector)

   272

            self.RefreshSize()

   273

   274

    # Returns the power rail type

   275

    def GetType(self):

   276

        return self.Type

   277

   278

    # Method called when a LeftDown event have been generated

   279

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

   280

        self.RealConnectors = []

   281

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

   282

        if height > 0:

   283

            for connector in self.Connectors:

   284

                position = connector.GetRelPosition()

   285

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

   286

        elif len(self.Connectors) > 1:

   287

            self.RealConnectors = map(lambda x : x * 1 / (len(self.Connectors) - 1), xrange(len(self.Connectors)))

   288

        else:

   289

            self.RealConnectors = [0.5]

   290

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

   291

   292

    # Method called when a LeftUp event have been generated

   293

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

   294

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

   295

        self.RealConnectors = None

   296

   297

    # Method called when a LeftDown event have been generated

   298

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

   299

        pos = GetScaledEventPosition(event, dc, scaling)

   300

        # Test if a connector have been handled

   301

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

   302

        if connector:

   303

            self.Handle = (HANDLE_CONNECTOR, connector)

   304

            wx.CallAfter(self.Parent.SetCurrentCursor, 1)

   305

            self.Selected = False

   306

            # Initializes the last position

   307

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

   308

        else:

   309

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

   310

   311

    # Method called when a LeftDClick event have been generated

   312

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

   313

        # Edit the powerrail properties

   314

        self.Parent.EditPowerRailContent(self)

   315

   316

    # Method called when a RightUp event have been generated

   317

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

   318

        handle_type, handle = self.Handle

   319

        if handle_type == HANDLE_CONNECTOR:

   320

            wires = handle.GetWires()

   321

            if len(wires) == 1:

   322

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

   323

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

   324

                else:

   325

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

   326

                block.RefreshModel(False)

   327

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

   328

        else:

   329

            self.Parent.PopupDefaultMenu()

   330

   331

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

   332

        self.Move(x, y)

   333

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

   334

            self.SetSize(width, height)

   335

        else:

   336

            self.SetSize(LD_POWERRAIL_WIDTH, height)

   337

   338

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

   339

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

   340

        handle_type, handle = self.Handle

   341

        # A connector has been handled

   342

        if handle_type == HANDLE_CONNECTOR:

   343

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

   344

            if scaling is not None:

   345

                position = handle.GetRelPosition()

   346

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

   347

            self.MoveConnector(handle, movey)

   348

            return 0, movey

   349

        else:

   350

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

   351

   352

    # Refreshes the power rail model

   353

    def RefreshModel(self, move=True):

   354

        self.Parent.RefreshPowerRailModel(self)

   355

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

   356

        # of wires connected to connectors

   357

        if move and self.Type == LEFTRAIL:

   358

            for connector in self.Connectors:

   359

                if connector:

   360

                    connector.RefreshWires()

   361

   362

    # Draws power rail

   363

    def Draw(self, dc):

   364

        Graphic_Element.Draw(self, dc)

   365

        dc.SetPen(wx.BLACK_PEN)

   366

        dc.SetBrush(wx.BLACK_BRUSH)

   367

        # Draw a rectangle with the power rail size

   368

        if self.Type == LEFTRAIL:

   369

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

   370

        else:

   371

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

   372

        # Draw connectors

   373

        for connector in self.Connectors:

   374

            if connector:

   375

                connector.Draw(dc)

   376

   377

   378

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

   379

#                         Ladder Diagram Contact

   380

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

   381

   382

"""

   383

Class that implements the graphic representation of a contact

   384

"""

   385

   386

class LD_Contact(Graphic_Element, DebugDataConsumer):

   387

   388

    # Create a new contact

   389

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

   390

        Graphic_Element.__init__(self, parent)

   391

        DebugDataConsumer.__init__(self)

   392

        self.Type = type

   393

        self.Name = name

   394

        self.Id = id

   395

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

   396

        self.Errors = {}

   397

        # Create an input and output connector

   398

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

   399

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

   400

        self.PreviousValue = False

   401

        self.PreviousSpreading = False

   402

        self.RefreshNameSize()

   403

        self.RefreshTypeSize()

   404

   405

    def Flush(self):

   406

        if self.Input is not None:

   407

            self.Input.Flush()

   408

            self.Input = None

   409

        if self.Output is not None:

   410

            self.Output.Flush()

   411

            self.Output = None

   412

   413

    def SetForced(self, forced):

   414

        if self.Forced != forced:

   415

            self.Forced = forced

   416

            if self.Visible:

   417

                self.Parent.UpdateRefreshRect(self.GetRedrawRect())

   418

   419

    def SetValue(self, value):

   420

        self.PreviousValue = self.Value

   421

        self.Value = value

   422

        if self.Value != self.PreviousValue:

   423

            if self.Visible:

   424

                self.Parent.UpdateRefreshRect(self.GetRedrawRect())

   425

            self.SpreadCurrent()

   426

   427

    def SpreadCurrent(self):

   428

        if self.Parent.Debug:

   429

            if self.Value is None:

   430

                self.Value = False

   431

            spreading = self.Input.ReceivingCurrent()

   432

            if self.Type == CONTACT_NORMAL:

   433

                spreading &= self.Value

   434

            elif self.Type == CONTACT_REVERSE:

   435

                spreading &= not self.Value

   436

            elif self.Type == CONTACT_RISING:

   437

                spreading &= self.Value and not self.PreviousValue

   438

            elif self.Type == CONTACT_FALLING:

   439

                spreading &= self.Value and not self.PreviousValue

   440

            else:

   441

                spreading = False

   442

            if spreading and not self.PreviousSpreading:

   443

                self.Output.SpreadCurrent(True)

   444

            elif not spreading and self.PreviousSpreading:

   445

                self.Output.SpreadCurrent(False)

   446

            self.PreviousSpreading = spreading

   447

   448

    # Make a clone of this LD_Contact

   449

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

   450

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

   451

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

   452

        if pos is not None:

   453

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

   454

        else:

   455

            contact.SetPosition(self.Pos.x, self.Pos.y)

   456

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

   457

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

   458

        return contact

   459

   460

    def GetConnectorTranslation(self, element):

   461

        return {self.Input : element.Input, self.Output : element.Output}

   462

   463

    # Returns the RedrawRect

   464

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

   465

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

   466

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

   467

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

   468

        if movex != 0 or movey != 0:

   469

            if self.Input.IsConnected():

   470

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

   471

            if self.Output.IsConnected():

   472

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

   473

        return rect

   474

   475

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

   476

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

   477

   478

    # Forbids to change the contact size

   479

    def SetSize(self, width, height):

   480

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

   481

            Graphic_Element.SetSize(self, width, height)

   482

            self.RefreshConnectors()

   483

   484

    # Delete this contact by calling the appropriate method

   485

    def Delete(self):

   486

        self.Parent.DeleteContact(self)

   487

   488

    # Unconnect input and output

   489

    def Clean(self):

   490

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

   491

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

   492

   493

    # Refresh the size of text for name

   494

    def RefreshNameSize(self):

   495

        if self.Name != "":

   496

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

   497

        else: