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

def GetWireSize(block):

    31

    if isinstance(block, SFC_Step):

    32

        return SFC_WIRE_MIN_SIZE + block.GetActionExtraLineNumber() * SFC_ACTION_MIN_SIZE[1]

    33

    else:

    34

        return SFC_WIRE_MIN_SIZE

    35

    36

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

    37

#                         Sequencial Function Chart Step

    38

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

    39

    40

"""

    41

Class that implements the graphic representation of a step

    42

"""

    43

    44

class SFC_Step(Graphic_Element):

    45

    46

    # Create a new step

    47

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

    48

        Graphic_Element.__init__(self, parent)

    49

        self.Name = name

    50

        self.Initial = initial

    51

        self.Id = id

    52

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

    53

        # Create an input and output connector

    54

        if not self.Initial:

    55

            self.Input = Connector(self, "", None, wx.Point(self.Size[0] / 2, 0), NORTH)

    56

        else:

    57

            self.Input = None

    58

        self.Output = None

    59

        self.Action = None

    60

    61

    # Destructor

    62

    def __del__(self):

    63

        self.Input = None

    64

        self.Output = None

    65

        self.Action = None

    66

    67

    # Make a clone of this SFC_Step

    70

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

    71

        if pos is not None:

    72

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

    79

        return step

    80

    99

    # Delete this step by calling the appropriate method

   100

    def Delete(self):

   101

        self.Parent.DeleteStep(self)

   102

   103

    # Unconnect input and output

   104

    def Clean(self):

   105

        if self.Input:

   106

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

   107

        if self.Output:

   108

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

   109

        if self.Action:

   110

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

   111

   112

    # Add output connector to step

   113

    def AddInput(self):

   114

        if not self.Input:

   115

            self.Input = Connector(self, "", None, wx.Point(self.Size[0] / 2, 0), NORTH)

   116

            self.RefreshBoundingBox()

   117

   118

    # Remove output connector from step

   119

    def RemoveInput(self):

   120

        if self.Input:

   121

            self.Input.UnConnect()

   122

            self.Input = None

   123

            self.RefreshBoundingBox()

   124

   125

    # Add output connector to step

   126

    def AddOutput(self):

   127

        if not self.Output:

   128

            self.Output = Connector(self, "", None, wx.Point(self.Size[0] / 2, self.Size[1]), SOUTH)

   129

            self.RefreshBoundingBox()

   130

   131

    # Remove output connector from step

   132

    def RemoveOutput(self):

   133

        if self.Output:

   134

            self.Output.UnConnect()

   135

            self.Output = None

   136

            self.RefreshBoundingBox()

   137

   138

    # Add action connector to step

   139

    def AddAction(self):

   140

        if not self.Action:

   141

            self.Action = Connector(self, "", None, wx.Point(self.Size[0], self.Size[1] / 2), EAST)

   142

            self.RefreshBoundingBox()

   143

   144

    # Remove action connector from step

   145

    def RemoveAction(self):

   146

        if self.Action:

   147

            self.Action.UnConnect()

   148

            self.Action = None

   149

            self.RefreshBoundingBox()

   150

   151

    # Refresh the step bounding box

   152

    def RefreshBoundingBox(self):

   153

        dc = wx.ClientDC(self.Parent)

   154

        # Calculate the bounding box size

   155

        if self.Action:

   156

            bbx_width = self.Size[0] + CONNECTOR_SIZE

   157

        else:

   158

            bbx_width = self.Size[0]

   159

        if self.Initial:

   160

            bbx_y = self.Pos.y

   161

            bbx_height = self.Size[1]

   162

            if self.Output:

   163

                bbx_height += CONNECTOR_SIZE

   164

        else:

   165

            bbx_y = self.Pos.y - CONNECTOR_SIZE

   166

            bbx_height = self.Size[1] + CONNECTOR_SIZE

   167

            if self.Output:

   168

                bbx_height += CONNECTOR_SIZE

   169

        #self.BoundingBox = wx.Rect(self.Pos.x, bbx_y, bbx_width + 1, bbx_height + 1)

   170

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

   171

   172

    # Refresh the positions of the step connectors

   173

    def RefreshConnectors(self):

   174

        # Update input position if it exists

   175

        if self.Input:

   176

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

   177

        # Update output position

   178

        if self.Output:

   179

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

   180

        # Update action position if it exists

   181

        if self.Action:

   182

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

   183

        self.RefreshConnected()

   184

   185

    # Refresh the position of wires connected to step

   186

    def RefreshConnected(self, exclude = []):

   187

        if self.Input:

   188

            self.Input.MoveConnected(exclude)

   189

        if self.Output:

   190

            self.Output.MoveConnected(exclude)

   191

        if self.Action:

   192

            self.Action.MoveConnected(exclude)

   193

   194

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

   195

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

   196

        # if a name is given

   197

        if name:

   198

            # Test input, output and action connector if they exists

   199

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

   200

                return self.Input

   201

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

   202

                return self.Output

   203

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

   204

                return self.Action

   205

        # Test input connector if it exists

   206

        if self.Input:

   207

            input_pos = self.Input.GetRelPosition()

   208

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

   209

                return self.Input

   210

        # Test output connector if it exists

   211

        if self.Output:

   212

            output_pos = self.Output.GetRelPosition()

   213

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

   214

                return self.Output

   215

        # Test action connector if it exists

   216

        if self.Action:

   217

            action_pos = self.Action.GetRelPosition()

   218

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

   219

                return self.Action

   220

        return None

   221

   222

    # Returns input and output step connectors 

   223

    def GetConnectors(self):

   224

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

   225

   226

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

   227

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

   228

        # Test input connector if it exists

   229

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

   230

            return self.Input

   231

        # Test output connector

   232

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

   233

            return self.Output

   234

        # Test action connector

   235

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

   236

            return self.Action

   237

        return None

   238

   239

    # Changes the step name

   240

    def SetName(self, name):

   241

        self.Name = name

   242

   243

    # Returns the step name

   244

    def GetName(self):

   245

        return self.Name

   246

   247

    # Returns the step initial property

   248

    def GetInitial(self):

   249

        return self.Initial

   250

   251

    # Returns the connector connected to input

   252

    def GetPreviousConnector(self):

   253

        if self.Input:

   254

            wires = self.Input.GetWires()

   255

            if len(wires) == 1:

   256

                return wires[0][0].EndConnected

   257

        return None

   258

   259

    # Returns the connector connected to output

   260

    def GetNextConnector(self):

   261

        if self.Output:

   262

            wires = self.Output.GetWires()

   263

            if len(wires) == 1:

   264

                return wires[0][0].StartConnected

   265

        return None

   266

   267

    # Returns the connector connected to action

   268

    def GetActionConnector(self):

   269

        if self.Action:

   270

            wires = self.Action.GetWires()

   271

            if len(wires) == 1:

   272

                return wires[0][0].StartConnected

   273

        return None

   274

   275

    # Returns the number of action line

   276

    def GetActionExtraLineNumber(self):

   277

        if self.Action:

   278

            wires = self.Action.GetWires()

   279

            if len(wires) != 1:

   280

                return 0

   281

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

   282

            return max(0, action_block.GetLineNumber() - 1)

   283

        return 0

   284

   285

    # Returns the step minimum size

   286

    def GetMinSize(self):

   287

        dc = wx.ClientDC(self.Parent)

   288

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

   289

        if self.Initial:

   290

            return text_width + 14, text_height + 14

   291

        else:

   292

            return text_width + 10, text_height + 10

   293

   294

    # Updates the step size

   295

    def UpdateSize(self, width, height):

   296

        diffx = self.Size.GetWidth() / 2 - width / 2

   297

        diffy = height - self.Size.GetHeight()

   298

        self.Move(diffx, 0)

   299

        Graphic_Element.SetSize(self, width, height)

   300

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

   301

            self.RefreshConnected()

   302

        else:

   303

            self.RefreshOutputPosition((0, diffy))

   304

   305

    # Align input element with this step

   306

    def RefreshInputPosition(self):

   307

        if self.Input:

   308

            current_pos = self.Input.GetPosition(False)

   309

            input = self.GetPreviousConnector()

   310

            if input:

   311

                input_pos = input.GetPosition(False)

   312

                diffx = current_pos.x - input_pos.x

   313

                input_block = input.GetParentBlock()

   314

                if isinstance(input_block, SFC_Divergence):

   315

                    input_block.MoveConnector(input, diffx)

   316

                else:

   317

                    if isinstance(input_block, SFC_Step):

   318

                        input_block.MoveActionBlock((diffx, 0))

   319

                    input_block.Move(diffx, 0)

   320

                    input_block.RefreshInputPosition()

   321

   322

    # Align output element with this step

   323

    def RefreshOutputPosition(self, move = None):

   324

        if self.Output:

   325

            wires = self.Output.GetWires()

   326

            if len(wires) != 1:

   327

                return

   328

            current_pos = self.Output.GetPosition(False)

   329

            output = wires[0][0].StartConnected

   330

            output_pos = output.GetPosition(False)

   331

            diffx = current_pos.x - output_pos.x

   332

            output_block = output.GetParentBlock()

   333

            wire_size = SFC_WIRE_MIN_SIZE + self.GetActionExtraLineNumber() * SFC_ACTION_MIN_SIZE[1]

   334

            diffy = wire_size - output_pos.y + current_pos.y

   335

            if diffy != 0:

   336

                if isinstance(output_block, SFC_Step):

   337

                    output_block.MoveActionBlock((diffx, diffy))

   338

                wires[0][0].SetPoints([wx.Point(current_pos.x, current_pos.y + wire_size),

   339

                    wx.Point(current_pos.x, current_pos.y)])

   340

                if not isinstance(output_block, SFC_Divergence) or output_block.GetConnectors()["inputs"].index(output) == 0:

   341

                    output_block.Move(diffx, diffy, self.Parent.Wires)

   342

                    output_block.RefreshOutputPosition((diffx, diffy))

   343

                else:

   344

                    output_block.RefreshPosition()

   345

            elif move:

   346

                if isinstance(output_block, SFC_Step):

   347

                    output_block.MoveActionBlock(move)

   348

                wires[0][0].Move(move[0], move[1], True)

   349

                if not isinstance(output_block, SFC_Divergence) or output_block.GetConnectors()["inputs"].index(output) == 0:

   350

                    output_block.Move(move[0], move[1], self.Parent.Wires)

   351

                    output_block.RefreshOutputPosition(move)

   352

                else:

   353

                    output_block.RefreshPosition()

   354

            elif isinstance(output_block, SFC_Divergence):

   355

                output_block.MoveConnector(output, diffx)

   356

            else:

   357

                if isinstance(output_block, SFC_Step):

   358

                    output_block.MoveActionBlock((diffx, 0))

   359

                output_block.Move(diffx, 0)

   360

                output_block.RefreshOutputPosition()

   361

   362

    # Refresh action element with this step

   363

    def MoveActionBlock(self, move):

   364

        if self.Action:

   365

            wires = self.Action.GetWires()

   366

            if len(wires) != 1:

   367

                return

   368

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

   369

            action_block.Move(move[0], move[1], self.Parent.Wires)

   370

            wires[0][0].Move(move[0], move[1], True)

   371

   372

    # Resize the divergence from position and size given

   373

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

   374

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

   375

            self.UpdateSize(width, height)

   376

        else:

   377

            Graphic_Element.Resize(self, x, y, width, height)

   378

   379

    # Method called when a LeftDClick event have been generated

   380

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

   381

        # Edit the step properties

   382

        self.Parent.EditStepContent(self)

   383

   384

    # Method called when a RightUp event have been generated

   385

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

   386

        # Popup the menu with special items for a step

   387

        self.Parent.PopupDefaultMenu()

   388

   389

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

   390

    def ProcessDragging(self, movex, movey):

   391

        handle_type, handle = self.Handle

   392

        if handle_type == HANDLE_MOVE:

   393

            movex = max(-self.BoundingBox.x, movex)

   394

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

   395

            action_block = None

   396

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

   397

                self.Move(movex, movey)

   398

                self.RefreshConnected()

   399

                return movex, movey

   400

            elif self.Initial:

   401

                self.MoveActionBlock((movex, movey))

   402

                self.Move(movex, movey, self.Parent.Wires)

   403

                self.RefreshOutputPosition((movex, movey))

   404

                return movex, movey

   405

            else:

   406

                self.MoveActionBlock((movex, 0))

   407

                self.Move(movex, 0)

   408

                self.RefreshInputPosition()

   409

                self.RefreshOutputPosition()

   410

                return movex, 0

   411

        else:

   412

            return Graphic_Element.ProcessDragging(self, movex, movey)

   413

   414

    # Refresh input element model

   415

    def RefreshInputModel(self):

   416

        if self.Input:

   417

            input = self.GetPreviousConnector()

   418

            if input:                

   419

                input_block = input.GetParentBlock()

   420

                input_block.RefreshModel(False)

   421

                if not isinstance(input_block, SFC_Divergence):

   422

                    input_block.RefreshInputModel()

   423

   424

    # Refresh output element model

   425

    def RefreshOutputModel(self, move=False):

   426

        if self.Output:

   427

            output = self.GetNextConnector()

   428

            if output:

   429

                output_block = output.GetParentBlock()

   430

                output_block.RefreshModel(False)

   431

                if not isinstance(output_block, SFC_Divergence) or move:

   432

                    output_block.RefreshOutputModel(move)

   433

   434

    # Refreshes the step model

   435

    def RefreshModel(self, move=True):

   436

        self.Parent.RefreshStepModel(self)

   437

        if self.Action:

   438

            action = self.GetActionConnector()

   439

            if action:

   440

                action_block = action.GetParentBlock()

   441

                action_block.RefreshModel(False)

   442

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

   443

        if move:

   444

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

   445

                self.RefreshInputModel()

   446

                self.RefreshOutputModel(self.Initial)

   447

            elif self.Output:

   448

                self.Output.RefreshWires()

   449

   450

    # Draws step

   451

    def Draw(self, dc):

   453

        dc.SetPen(wx.BLACK_PEN)

   454

        dc.SetBrush(wx.WHITE_BRUSH)

   455

        # Draw two rectangles for representing the step

   456

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

   457

        if self.Initial:

   458

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

   459

        # Draw step name

   460

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

   461

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

   462

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

   463

        # Draw input and output connectors

   464

        if self.Input:

   465

            self.Input.Draw(dc)

   466

        if self.Output:

   467

            self.Output.Draw(dc)

   468

        if self.Action:

   469

            self.Action.Draw(dc)

   470

   471

   472

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

   473

#                       Sequencial Function Chart Transition

   474

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

   475

   476

"""

   477

Class that implements the graphic representation of a transition

   478

"""

   479

   480

class SFC_Transition(Graphic_Element):

   481

   482

    # Create a new transition

   483

    def __init__(self, parent, type = "reference", condition = None, priority = 0, id = None):

   484

        Graphic_Element.__init__(self, parent)

   485

        self.Type = None

   486

        self.Id = id

   487

        self.Priority = 0

   488

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

   489

        # Create an input and output connector

   490

        self.Input = Connector(self, "", None, wx.Point(self.Size[0] / 2, 0), NORTH)

   491

        self.Output = Connector(self, "", None, wx.Point(self.Size[0] / 2, self.Size[1]), SOUTH)

   492

        self.SetType(type, condition)

   493

        self.SetPriority(priority)

   494

   495

    # Destructor

   496

    def __del__(self):

   497

        self.Input = None

   498

        self.Output = None

   499

        if self.Type == "connection":

   500

            self.Condition = None

   501

   502

    # Make a clone of this SFC_Transition

   503

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

   504

        transition = SFC_Transition(self.Parent, self.Type, self.Condition, self.Priority, id)

   505

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

   506

        if pos is not None:

   507

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

   508

        transition.Input = self.Input.Clone(transition)

   509

        transition.Output = self.Output.Clone(transition)

   510

        return transition

   511