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.SetName(name)

    50

        self.Initial = initial

    51

        self.Id = id

    52

        self.Error = None

    53

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

    54

        # Create an input and output connector

    55

        if not self.Initial:

    56

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

    57

        else:

    58

            self.Input = None

    59

        self.Output = None

    60

        self.Action = None

    61

    62

    def Flush(self):

    63

        if self.Input is not None:

    64

            self.Input.Flush()

    65

            self.Input = None

    66

        if self.Output is not None:

    67

            self.Output.Flush()

    68

            self.Output = None

    69

        if self.Output is not None:

    70

            self.Action.Flush()

    71

            self.Action = None

    72

    73

    # Make a clone of this SFC_Step

    74

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

    75

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

    76

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

    77

        if pos is not None:

    78

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

    79

        if self.Input:

    80

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

    81

        if self.Output:

    82

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

    83

        if self.Action:

    84

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

    85

        return step

    86

    87

    # Returns the RedrawRect

    88

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

    89

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

    90

        if self.Input:

    91

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

    92

        if self.Output:

    93

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

    94

        if self.Action:

    95

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

    96

        if movex != 0 or movey != 0:

    97

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

    98

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

    99

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

   100

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

   101

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

   102

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

   103

        return rect

   104

   105

    # Delete this step by calling the appropriate method

   106

    def Delete(self):

   107

        self.Parent.DeleteStep(self)

   108

   109

    # Unconnect input and output

   110

    def Clean(self):

   111

        if self.Input:

   112

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

   113

        if self.Output:

   114

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

   115

        if self.Action:

   116

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

   117

   118

    # Refresh the size of text for name

   119

    def RefreshNameSize(self):

   120

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

   121

   122

    # Add output connector to step

   123

    def AddInput(self):

   124

        if not self.Input:

   125

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

   126

            self.RefreshBoundingBox()

   127

   128

    # Remove output connector from step

   129

    def RemoveInput(self):

   130

        if self.Input:

   131

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

   132

            self.Input = None

   133

            self.RefreshBoundingBox()

   134

   135

    # Add output connector to step

   136

    def AddOutput(self):

   137

        if not self.Output:

   138

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

   139

            self.RefreshBoundingBox()

   140

   141

    # Remove output connector from step

   142

    def RemoveOutput(self):

   143

        if self.Output:

   144

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

   145

            self.Output = None

   146

            self.RefreshBoundingBox()

   147

   148

    # Add action connector to step

   149

    def AddAction(self):

   150

        if not self.Action:

   151

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

   152

            self.RefreshBoundingBox()

   153

   154

    # Remove action connector from step

   155

    def RemoveAction(self):

   156

        if self.Action:

   157

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

   158

            self.Action = None

   159

            self.RefreshBoundingBox()

   160

   161

    # Refresh the step bounding box

   162

    def RefreshBoundingBox(self):

   163

        # Calculate the bounding box size

   164

        if self.Action:

   165

            bbx_width = self.Size[0] + CONNECTOR_SIZE

   166

        else:

   167

            bbx_width = self.Size[0]

   168

        if self.Initial:

   169

            bbx_y = self.Pos.y

   170

            bbx_height = self.Size[1]

   171

            if self.Output:

   172

                bbx_height += CONNECTOR_SIZE

   173

        else:

   174

            bbx_y = self.Pos.y - CONNECTOR_SIZE

   175

            bbx_height = self.Size[1] + CONNECTOR_SIZE

   176

            if self.Output:

   177

                bbx_height += CONNECTOR_SIZE

   178

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

   179

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

   180

   181

    # Refresh the positions of the step connectors

   182

    def RefreshConnectors(self):

   183

        scaling = self.Parent.GetScaling()

   184

        horizontal_pos = self.Size[0] / 2

   185

        vertical_pos = self.Size[1] / 2

   186

        if scaling is not None:

   187

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

   188

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

   189

        # Update input position if it exists

   190

        if self.Input:

   191

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

   192

        # Update output position

   193

        if self.Output:

   194

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

   195

        # Update action position if it exists

   196

        if self.Action:

   197

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

   198

        self.RefreshConnected()

   199

   200

    # Refresh the position of wires connected to step

   201

    def RefreshConnected(self, exclude = []):

   202

        if self.Input:

   203

            self.Input.MoveConnected(exclude)

   204

        if self.Output:

   205

            self.Output.MoveConnected(exclude)

   206

        if self.Action:

   207

            self.Action.MoveConnected(exclude)

   208

   209

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

   210

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

   211

        # if a name is given

   212

        if name:

   213

            # Test input, output and action connector if they exists

   214

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

   215

                return self.Input

   216

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

   217

                return self.Output

   218

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

   219

                return self.Action

   220

        # Test input connector if it exists

   221

        if self.Input:

   222

            input_pos = self.Input.GetRelPosition()

   223

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

   224

                return self.Input

   225

        # Test output connector if it exists

   226

        if self.Output:

   227

            output_pos = self.Output.GetRelPosition()

   228

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

   229

                return self.Output

   230

        # Test action connector if it exists

   231

        if self.Action:

   232

            action_pos = self.Action.GetRelPosition()

   233

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

   234

                return self.Action

   235

        return None

   236

   237

    # Returns input and output step connectors 

   238

    def GetConnectors(self):

   239

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

   240

   241

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

   242

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

   243

        # Test input connector if it exists

   244

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

   245

            return self.Input

   246

        # Test output connector

   247

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

   248

            return self.Output

   249

        # Test action connector

   250

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

   251

            return self.Action

   252

        return None

   253

   254

    # Changes the step name

   255

    def SetName(self, name):

   256

        self.Name = name

   257

        self.RefreshNameSize()

   258

   259

    # Returns the step name

   260

    def GetName(self):

   261

        return self.Name

   262

   263

    # Returns the step initial property

   264

    def GetInitial(self):

   265

        return self.Initial

   266

   267

    # Returns the connector connected to input

   268

    def GetPreviousConnector(self):

   269

        if self.Input:

   270

            wires = self.Input.GetWires()

   271

            if len(wires) == 1:

   272

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

   273

        return None

   274

   275

    # Returns the connector connected to output

   276

    def GetNextConnector(self):

   277

        if self.Output:

   278

            wires = self.Output.GetWires()

   279

            if len(wires) == 1:

   280

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

   281

        return None

   282

   283

    # Returns the connector connected to action

   284

    def GetActionConnector(self):

   285

        if self.Action:

   286

            wires = self.Action.GetWires()

   287

            if len(wires) == 1:

   288

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

   289

        return None

   290

   291

    # Returns the number of action line

   292

    def GetActionExtraLineNumber(self):

   293

        if self.Action:

   294

            wires = self.Action.GetWires()

   295

            if len(wires) != 1:

   296

                return 0

   297

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

   298

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

   299

        return 0

   300

   301

    # Returns the step minimum size

   302

    def GetMinSize(self):

   303

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

   304

        if self.Initial:

   305

            return text_width + 14, text_height + 14

   306

        else:

   307

            return text_width + 10, text_height + 10

   308

   309

    # Updates the step size

   310

    def UpdateSize(self, width, height):

   311

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

   312

        diffy = height - self.Size.GetHeight()

   313

        self.Move(diffx, 0)

   314

        Graphic_Element.SetSize(self, width, height)

   315

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

   316

            self.RefreshConnected()

   317

        else:

   318

            self.RefreshOutputPosition((0, diffy))

   319

   320

    # Align input element with this step

   321

    def RefreshInputPosition(self):

   322

        if self.Input:

   323

            current_pos = self.Input.GetPosition(False)

   324

            input = self.GetPreviousConnector()

   325

            if input:

   326

                input_pos = input.GetPosition(False)

   327

                diffx = current_pos.x - input_pos.x

   328

                input_block = input.GetParentBlock()

   329

                if isinstance(input_block, SFC_Divergence):

   330

                    input_block.MoveConnector(input, diffx)

   331

                else:

   332

                    if isinstance(input_block, SFC_Step):

   333

                        input_block.MoveActionBlock((diffx, 0))

   334

                    input_block.Move(diffx, 0)

   335

                    input_block.RefreshInputPosition()

   336

   337

    # Align output element with this step

   338

    def RefreshOutputPosition(self, move = None):

   339

        if self.Output:

   340

            wires = self.Output.GetWires()

   341

            if len(wires) != 1:

   342

                return

   343

            current_pos = self.Output.GetPosition(False)

   344

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

   345

            output_pos = output.GetPosition(False)

   346

            diffx = current_pos.x - output_pos.x

   347

            output_block = output.GetParentBlock()

   348

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

   349

            diffy = wire_size - output_pos.y + current_pos.y

   350

            if diffy != 0:

   351

                if isinstance(output_block, SFC_Step):

   352

                    output_block.MoveActionBlock((diffx, diffy))

   353

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

   354

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

   355

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

   356

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

   357

                    output_block.RefreshOutputPosition((diffx, diffy))

   358

                else:

   359

                    output_block.RefreshPosition()

   360

            elif move:

   361

                if isinstance(output_block, SFC_Step):

   362

                    output_block.MoveActionBlock(move)

   363

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

   364

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

   365

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

   366

                    output_block.RefreshOutputPosition(move)

   367

                else:

   368

                    output_block.RefreshPosition()

   369

            elif isinstance(output_block, SFC_Divergence):

   370

                output_block.MoveConnector(output, diffx)

   371

            else:

   372

                if isinstance(output_block, SFC_Step):

   373

                    output_block.MoveActionBlock((diffx, 0))

   374

                output_block.Move(diffx, 0)

   375

                output_block.RefreshOutputPosition()

   376

   377

    # Refresh action element with this step

   378

    def MoveActionBlock(self, move):

   379

        if self.Action:

   380

            wires = self.Action.GetWires()

   381

            if len(wires) != 1:

   382

                return

   383

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

   384

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

   385

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

   386

   387

    # Resize the divergence from position and size given

   388

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

   389

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

   390

            self.UpdateSize(width, height)

   391

        else:

   392

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

   393

   394

    # Method called when a LeftDClick event have been generated

   395

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

   396

        # Edit the step properties

   397

        self.Parent.EditStepContent(self)

   398

   399

    # Method called when a RightUp event have been generated

   400

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

   401

        # Popup the menu with special items for a step

   402

        self.Parent.PopupDefaultMenu()

   403

   404

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

   405

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

   406

        handle_type, handle = self.Handle

   407

        if handle_type == HANDLE_MOVE:

   408

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

   409

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

   410

            if scaling is not None:

   411

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

   412

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

   413

            action_block = None

   414

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

   415

                self.Move(movex, movey)

   416

                self.RefreshConnected()

   417

                return movex, movey

   418

            elif self.Initial:

   419

                self.MoveActionBlock((movex, movey))

   420

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

   421

                self.RefreshOutputPosition((movex, movey))

   422

                return movex, movey

   423

            else:

   424

                self.MoveActionBlock((movex, 0))

   425

                self.Move(movex, 0)

   426

                self.RefreshInputPosition()

   427

                self.RefreshOutputPosition()

   428

                return movex, 0

   429

        else:

   430

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

   431

   432

    # Refresh input element model

   433

    def RefreshInputModel(self):

   434

        if self.Input:

   435

            input = self.GetPreviousConnector()

   436

            if input:                

   437

                input_block = input.GetParentBlock()

   438

                input_block.RefreshModel(False)

   439

                if not isinstance(input_block, SFC_Divergence):

   440

                    input_block.RefreshInputModel()

   441

   442

    # Refresh output element model

   443

    def RefreshOutputModel(self, move=False):

   444

        if self.Output:

   445

            output = self.GetNextConnector()

   446

            if output:

   447

                output_block = output.GetParentBlock()

   448

                output_block.RefreshModel(False)

   449

                if not isinstance(output_block, SFC_Divergence) or move:

   450

                    output_block.RefreshOutputModel(move)

   451

   452

    # Refreshes the step model

   453

    def RefreshModel(self, move=True):

   454

        self.Parent.RefreshStepModel(self)

   455

        if self.Action:

   456

            action = self.GetActionConnector()

   457

            if action:

   458

                action_block = action.GetParentBlock()

   459

                action_block.RefreshModel(False)

   460

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

   461

        if move:

   462

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

   463

                self.RefreshInputModel()

   464

                self.RefreshOutputModel(self.Initial)

   465

            elif self.Output:

   466

                self.Output.RefreshWires()

   467

   468

    def AddError(self, infos, start, end):

   469

        if infos[0] == "name" and start[0] == 0 and end[0] == 0:

   470

            self.Error = (start[1], end[1])

   471

   472

    # Draws step

   473

    def Draw(self, dc):

   474

        Graphic_Element.Draw(self, dc)

   475

        dc.SetPen(wx.BLACK_PEN)

   476

        dc.SetBrush(wx.WHITE_BRUSH)

   477

   478

        if getattr(dc, "printing", False):

   479

            name_size = dc.GetTextExtent(self.Name)

   480

        else:

   481

            name_size = self.NameSize

   482

   483

        # Draw two rectangles for representing the step

   484

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

   485

        if self.Initial:

   486

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

   487

        # Draw step name

   488

        name_pos = (self.Pos.x + (self.Size[0] - name_size[0]) / 2,

   489

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

   490

        dc.DrawText(self.Name, name_pos[0], name_pos[1])

   491

        # Draw input and output connectors

   492

        if self.Input:

   493

            self.Input.Draw(dc)

   494

        if self.Output:

   495

            self.Output.Draw(dc)

   496

        if self.Action:

   497

            self.Action.Draw(dc)

   498

        if self.Error is not None:

   499

            HighlightErrorZone(dc, name_pos[0], name_pos[1], name_size[0], name_size[1])

   500

   501

   502

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

   503

#                       Sequencial Function Chart Transition

   504

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

   505

   506

"""

   507

Class that implements the graphic representation of a transition

   508

"""

   509

   510

class SFC_Transition(Graphic_Element):

   511