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

    68

    def Clone(self, id = None, name = "Step", pos = None):

    69

        step = SFC_Step(self.Parent, name, self.Initial, id)

    70

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

    71

        if pos is not None:

    72

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

    73

        if self.Input:

    74

            step.Input = self.Input.Clone(step)

    75

        if self.Output:

    76

            step.Output = self.Output.Clone(step)

    77

        if self.Action:

    78

            step.Action = self.Action.Clone(step)

    79

        return step

    80

    81

    # Returns the RedrawRect

    82

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

    83

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

    84

        if self.Input:

    85

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

    86

        if self.Output:

    87

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

    88

        if self.Action:

    89

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

    90

        if movex != 0 or movey != 0:

    91

            if self.Input and self.Input.IsConnected():

    92

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

    93

            if self.Output and self.Output.IsConnected():

    94

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

    95

            if self.Action and self.Action.IsConnected():

    96

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

    97

        return rect

    98

    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, onlyone = True)

   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, onlyone = True)

   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

        scaling = self.Parent.GetScaling()

   175

        horizontal_pos = self.Size[0] / 2

   176

        vertical_pos = self.Size[1] / 2

   177

        if scaling is not None:

   178

            horizontal_pos = round(float(self.Pos.x + horizontal_pos) / float(scaling[0])) * scaling[0] - self.Pos.x

   179

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

   180

        # Update input position if it exists

   181

        if self.Input:

   182

            self.Input.SetPosition(wx.Point(horizontal_pos, 0))

   183

        # Update output position

   184

        if self.Output:

   185

            self.Output.SetPosition(wx.Point(horizontal_pos, self.Size[1]))

   186

        # Update action position if it exists

   187

        if self.Action:

   188

            self.Action.SetPosition(wx.Point(self.Size[0], vertical_pos))

   189

        self.RefreshConnected()

   190

   191

    # Refresh the position of wires connected to step

   192

    def RefreshConnected(self, exclude = []):

   193

        if self.Input:

   194

            self.Input.MoveConnected(exclude)

   195

        if self.Output:

   196

            self.Output.MoveConnected(exclude)

   197

        if self.Action:

   198

            self.Action.MoveConnected(exclude)

   199

   200

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

   201

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

   202

        # if a name is given

   203

        if name:

   204

            # Test input, output and action connector if they exists

   205

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

   206

                return self.Input

   207

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

   208

                return self.Output

   209

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

   210

                return self.Action

   211

        # Test input connector if it exists

   212

        if self.Input:

   213

            input_pos = self.Input.GetRelPosition()

   214

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

   215

                return self.Input

   216

        # Test output connector if it exists

   217

        if self.Output:

   218

            output_pos = self.Output.GetRelPosition()

   219

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

   220

                return self.Output

   221

        # Test action connector if it exists

   222

        if self.Action:

   223

            action_pos = self.Action.GetRelPosition()

   224

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

   225

                return self.Action

   226

        return None

   227

   228

    # Returns input and output step connectors 

   229

    def GetConnectors(self):

   230

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

   231

   232

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

   233

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

   234

        # Test input connector if it exists

   235

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

   236

            return self.Input

   237

        # Test output connector

   238

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

   239

            return self.Output

   240

        # Test action connector

   241

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

   242

            return self.Action

   243

        return None

   244

   245

    # Changes the step name

   246

    def SetName(self, name):

   247

        self.Name = name

   248

   249

    # Returns the step name

   250

    def GetName(self):

   251

        return self.Name

   252

   253

    # Returns the step initial property

   254

    def GetInitial(self):

   255

        return self.Initial

   256

   257

    # Returns the connector connected to input

   258

    def GetPreviousConnector(self):

   259

        if self.Input:

   260

            wires = self.Input.GetWires()

   261

            if len(wires) == 1:

   262

                return wires[0][0].GetOtherConnected(self.Input)

   263

        return None

   264

   265

    # Returns the connector connected to output

   266

    def GetNextConnector(self):

   267

        if self.Output:

   268

            wires = self.Output.GetWires()

   269

            if len(wires) == 1:

   270

                return wires[0][0].GetOtherConnected(self.Output)

   271

        return None

   272

   273

    # Returns the connector connected to action

   274

    def GetActionConnector(self):

   275

        if self.Action:

   276

            wires = self.Action.GetWires()

   277

            if len(wires) == 1:

   278

                return wires[0][0].GetOtherConnected(self.Action)

   279

        return None

   280

   281

    # Returns the number of action line

   282

    def GetActionExtraLineNumber(self):

   283

        if self.Action:

   284

            wires = self.Action.GetWires()

   285

            if len(wires) != 1:

   286

                return 0

   287

            action_block = wires[0][0].GetOtherConnected(self.Action).GetParentBlock()

   288

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

   289

        return 0

   290

   291

    # Returns the step minimum size

   292

    def GetMinSize(self):

   293

        dc = wx.ClientDC(self.Parent)

   294

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

   295

        if self.Initial:

   296

            return text_width + 14, text_height + 14

   297

        else:

   298

            return text_width + 10, text_height + 10

   299

   300

    # Updates the step size

   301

    def UpdateSize(self, width, height):

   302

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

   303

        diffy = height - self.Size.GetHeight()

   304

        self.Move(diffx, 0)

   305

        Graphic_Element.SetSize(self, width, height)

   306

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

   307

            self.RefreshConnected()

   308

        else:

   309

            self.RefreshOutputPosition((0, diffy))

   310

   311

    # Align input element with this step

   312

    def RefreshInputPosition(self):

   313

        if self.Input:

   314

            current_pos = self.Input.GetPosition(False)

   315

            input = self.GetPreviousConnector()

   316

            if input:

   317

                input_pos = input.GetPosition(False)

   318

                diffx = current_pos.x - input_pos.x

   319

                input_block = input.GetParentBlock()

   320

                if isinstance(input_block, SFC_Divergence):

   321

                    input_block.MoveConnector(input, diffx)

   322

                else:

   323

                    if isinstance(input_block, SFC_Step):

   324

                        input_block.MoveActionBlock((diffx, 0))

   325

                    input_block.Move(diffx, 0)

   326

                    input_block.RefreshInputPosition()

   327

   328

    # Align output element with this step

   329

    def RefreshOutputPosition(self, move = None):

   330

        if self.Output:

   331

            wires = self.Output.GetWires()

   332

            if len(wires) != 1:

   333

                return

   334

            current_pos = self.Output.GetPosition(False)

   335

            output = wires[0][0].GetOtherConnected(self.Output)

   336

            output_pos = output.GetPosition(False)

   337

            diffx = current_pos.x - output_pos.x

   338

            output_block = output.GetParentBlock()

   339

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

   340

            diffy = wire_size - output_pos.y + current_pos.y

   341

            if diffy != 0:

   342

                if isinstance(output_block, SFC_Step):

   343

                    output_block.MoveActionBlock((diffx, diffy))

   344

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

   345

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

   346

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

   347

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

   348

                    output_block.RefreshOutputPosition((diffx, diffy))

   349

                else:

   350

                    output_block.RefreshPosition()

   351

            elif move:

   352

                if isinstance(output_block, SFC_Step):

   353

                    output_block.MoveActionBlock(move)

   354

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

   355

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

   356

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

   357

                    output_block.RefreshOutputPosition(move)

   358

                else:

   359

                    output_block.RefreshPosition()

   360

            elif isinstance(output_block, SFC_Divergence):

   361

                output_block.MoveConnector(output, diffx)

   362

            else:

   363

                if isinstance(output_block, SFC_Step):

   364

                    output_block.MoveActionBlock((diffx, 0))

   365

                output_block.Move(diffx, 0)

   366

                output_block.RefreshOutputPosition()

   367

   368

    # Refresh action element with this step

   369

    def MoveActionBlock(self, move):

   370

        if self.Action:

   371

            wires = self.Action.GetWires()

   372

            if len(wires) != 1:

   373

                return

   374

            action_block = wires[0][0].GetOtherConnected(self.Action).GetParentBlock()

   375

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

   376

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

   377

   378

    # Resize the divergence from position and size given

   379

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

   380

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

   381

            self.UpdateSize(width, height)

   382

        else:

   383

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

   384

   385

    # Method called when a LeftDClick event have been generated

   386

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

   387

        # Edit the step properties

   388

        self.Parent.EditStepContent(self)

   389

   390

    # Method called when a RightUp event have been generated

   391

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

   392

        # Popup the menu with special items for a step

   393

        self.Parent.PopupDefaultMenu()

   394

   395

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

   396

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

   397

        handle_type, handle = self.Handle

   398

        if handle_type == HANDLE_MOVE:

   399

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

   400

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

   401

            if scaling is not None:

   402

                movex = round(float(self.Pos.x + movex) / float(scaling[0])) * scaling[0] - self.Pos.x

   403

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

   404

            action_block = None

   405

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

   406

                self.Move(movex, movey)

   407

                self.RefreshConnected()

   408

                return movex, movey

   409

            elif self.Initial:

   410

                self.MoveActionBlock((movex, movey))

   411

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

   412

                self.RefreshOutputPosition((movex, movey))

   413

                return movex, movey

   414

            else:

   415

                self.MoveActionBlock((movex, 0))

   416

                self.Move(movex, 0)

   417

                self.RefreshInputPosition()

   418

                self.RefreshOutputPosition()

   419

                return movex, 0

   420

        else:

   421

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

   422

   423

    # Refresh input element model

   424

    def RefreshInputModel(self):

   425

        if self.Input:

   426

            input = self.GetPreviousConnector()

   427

            if input:                

   428

                input_block = input.GetParentBlock()

   429

                input_block.RefreshModel(False)

   430

                if not isinstance(input_block, SFC_Divergence):

   431

                    input_block.RefreshInputModel()

   432

   433

    # Refresh output element model

   434

    def RefreshOutputModel(self, move=False):

   435

        if self.Output:

   436

            output = self.GetNextConnector()

   437

            if output:

   438

                output_block = output.GetParentBlock()

   439

                output_block.RefreshModel(False)

   440

                if not isinstance(output_block, SFC_Divergence) or move:

   441

                    output_block.RefreshOutputModel(move)

   442

   443

    # Refreshes the step model

   444

    def RefreshModel(self, move=True):

   445

        self.Parent.RefreshStepModel(self)

   446

        if self.Action:

   447

            action = self.GetActionConnector()

   448

            if action:

   449

                action_block = action.GetParentBlock()

   450

                action_block.RefreshModel(False)

   451

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

   452

        if move:

   453

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

   454

                self.RefreshInputModel()

   455

                self.RefreshOutputModel(self.Initial)

   456

            elif self.Output:

   457

                self.Output.RefreshWires()

   458

   459

    # Draws step

   460

    def Draw(self, dc):

   461

        Graphic_Element.Draw(self, dc)

   462

        dc.SetPen(wx.BLACK_PEN)

   463

        dc.SetBrush(wx.WHITE_BRUSH)

   464

        # Draw two rectangles for representing the step

   465

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

   466

        if self.Initial:

   467

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

   468

        # Draw step name

   469

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

   470

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

   471

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

   472

        # Draw input and output connectors

   473

        if self.Input:

   474

            self.Input.Draw(dc)

   475

        if self.Output:

   476

            self.Output.Draw(dc)

   477

        if self.Action:

   478

            self.Action.Draw(dc)

   479

   480

   481

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

   482

#                       Sequencial Function Chart Transition

   483

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

   484

   485

"""

   486

Class that implements the graphic representation of a transition

   487

"""

   488

   489

class SFC_Transition(Graphic_Element):

   490

   491

    # Create a new transition

   492

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

   493

        Graphic_Element.__init__(self, parent)

   494

        self.Type = None

   495

        self.Id = id

   496

        self.Priority = 0

   497

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

   498

        # Create an input and output connector

   499

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

   500

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

   501

        self.SetType(type, condition)

   502

        self.SetPriority(priority)

   503

   504

    # Destructor

   505

    def __del__(self):

   506

        self.Input = None

   507

        self.Output = None

   508

        if self.Type == "connection":

   509

            self.Condition = None

   510

   511

    # Make a clone of this SFC_Transition

   512

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

   513

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