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

        self.Value = None

    62

        self.PreviousValue = None

    63

        self.PreviousSpreading = False

    64

    65

    def Flush(self):

    66

        if self.Input is not None:

    67

            self.Input.Flush()

    68

            self.Input = None

    69

        if self.Output is not None:

    70

            self.Output.Flush()

    71

            self.Output = None

    72

        if self.Output is not None:

    73

            self.Action.Flush()

    74

            self.Action = None

    75

    76

    def SetValue(self, value):

    77

        self.PreviousValue = self.Value

    78

        self.Value = value

    79

        if self.Value != self.PreviousValue:

    80

            self.Refresh()

    81

            self.SpreadCurrent()

    82

    83

    def SpreadCurrent(self):

    84

        if self.Parent.Debug:

    85

            spreading = self.Value

    86

            if spreading and not self.PreviousSpreading:

    87

                if self.Output is not None:

    88

                    self.Output.SpreadCurrent(True)

    89

                if self.Action is not None:

    90

                    self.Action.SpreadCurrent(True)

    91

            elif not spreading and self.PreviousSpreading:

    92

                if self.Output is not None:

    93

                    self.Output.SpreadCurrent(False)

    94

                if self.Action is not None:

    95

                    self.Action.SpreadCurrent(False)

    96

            self.PreviousSpreading = spreading

    97

    98

    # Make a clone of this SFC_Step

    99

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

   100

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

   101

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

   102

        if pos is not None:

   103

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

   104

        else:

   105

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

   106

        if self.Input:

   107

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

   108

        if self.Output:

   109

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

   110

        if self.Action:

   111

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

   112

        return step

   113

   114

    def GetConnectorTranslation(self, element):

   115

        connectors = {}

   116

        if self.Input is not None:

   117

            connectors[self.Input] = element.Input

   118

        if self.Output is not None:

   119

            connectors[self.Output] = element.Output

   120

        if self.Action is not None:

   121

            connectors[self.Action] = element.Action

   122

        return connectors

   123

   124

    # Returns the RedrawRect

   125

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

   126

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

   127

        if self.Input:

   128

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

   129

        if self.Output:

   130

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

   131

        if self.Action:

   132

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

   133

        if movex != 0 or movey != 0:

   134

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

   135

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

   136

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

   137

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

   138

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

   139

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

   140

        return rect

   141

   142

    # Delete this step by calling the appropriate method

   143

    def Delete(self):

   144

        self.Parent.DeleteStep(self)

   145

   146

    # Unconnect input and output

   147

    def Clean(self):

   148

        if self.Input:

   149

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

   150

        if self.Output:

   151

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

   152

        if self.Action:

   153

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

   154

   155

    # Refresh the size of text for name

   156

    def RefreshNameSize(self):

   157

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

   158

   159

    # Add output connector to step

   160

    def AddInput(self):

   161

        if not self.Input:

   162

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

   163

            self.RefreshBoundingBox()

   164

   165

    # Remove output connector from step

   166

    def RemoveInput(self):

   167

        if self.Input:

   168

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

   169

            self.Input = None

   170

            self.RefreshBoundingBox()

   171

   172

    # Add output connector to step

   173

    def AddOutput(self):

   174

        if not self.Output:

   175

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

   176

            self.RefreshBoundingBox()

   177

   178

    # Remove output connector from step

   179

    def RemoveOutput(self):

   180

        if self.Output:

   181

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

   182

            self.Output = None

   183

            self.RefreshBoundingBox()

   184

   185

    # Add action connector to step

   186

    def AddAction(self):

   187

        if not self.Action:

   188

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

   189

            self.RefreshBoundingBox()

   190

   191

    # Remove action connector from step

   192

    def RemoveAction(self):

   193

        if self.Action:

   194

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

   195

            self.Action = None

   196

            self.RefreshBoundingBox()

   197

   198

    # Refresh the step bounding box

   199

    def RefreshBoundingBox(self):

   200

        # Calculate the bounding box size

   201

        if self.Action:

   202

            bbx_width = self.Size[0] + CONNECTOR_SIZE

   203

        else:

   204

            bbx_width = self.Size[0]

   205

        if self.Initial:

   206

            bbx_y = self.Pos.y

   207

            bbx_height = self.Size[1]

   208

            if self.Output:

   209

                bbx_height += CONNECTOR_SIZE

   210

        else:

   211

            bbx_y = self.Pos.y - CONNECTOR_SIZE

   212

            bbx_height = self.Size[1] + CONNECTOR_SIZE

   213

            if self.Output:

   214

                bbx_height += CONNECTOR_SIZE

   215

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

   216

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

   217

   218

    # Refresh the positions of the step connectors

   219

    def RefreshConnectors(self):

   220

        scaling = self.Parent.GetScaling()

   221

        horizontal_pos = self.Size[0] / 2

   222

        vertical_pos = self.Size[1] / 2

   223

        if scaling is not None:

   224

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

   225

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

   226

        # Update input position if it exists

   227

        if self.Input:

   228

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

   229

        # Update output position

   230

        if self.Output:

   231

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

   232

        # Update action position if it exists

   233

        if self.Action:

   234

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

   235

        self.RefreshConnected()

   236

   237

    # Refresh the position of wires connected to step

   238

    def RefreshConnected(self, exclude = []):

   239

        if self.Input:

   240

            self.Input.MoveConnected(exclude)

   241

        if self.Output:

   242

            self.Output.MoveConnected(exclude)

   243

        if self.Action:

   244

            self.Action.MoveConnected(exclude)

   245

   246

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

   247

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

   248

        # if a name is given

   249

        if name:

   250

            # Test input, output and action connector if they exists

   251

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

   252

                return self.Input

   253

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

   254

                return self.Output

   255

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

   256

                return self.Action

   257

        # Test input connector if it exists

   258

        if self.Input:

   259

            input_pos = self.Input.GetRelPosition()

   260

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

   261

                return self.Input

   262

        # Test output connector if it exists

   263

        if self.Output:

   264

            output_pos = self.Output.GetRelPosition()

   265

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

   266

                return self.Output

   267

        # Test action connector if it exists

   268

        if self.Action:

   269

            action_pos = self.Action.GetRelPosition()

   270

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

   271

                return self.Action

   272

        return None

   273

   274

    # Returns input and output step connectors 

   275

    def GetConnectors(self):

   276

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

   277

   278

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

   279

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

   280

        # Test input connector if it exists

   281

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

   282

            return self.Input

   283

        # Test output connector

   284

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

   285

            return self.Output

   286

        # Test action connector

   287

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

   288

            return self.Action

   289

        return None

   290

   291

    # Changes the step name

   292

    def SetName(self, name):

   293

        self.Name = name

   294

        self.RefreshNameSize()

   295

   296

    # Returns the step name

   297

    def GetName(self):

   298

        return self.Name

   299

   300

    # Returns the step initial property

   301

    def GetInitial(self):

   302

        return self.Initial

   303

   304

    # Returns the connector connected to input

   305

    def GetPreviousConnector(self):

   306

        if self.Input:

   307

            wires = self.Input.GetWires()

   308

            if len(wires) == 1:

   309

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

   310

        return None

   311

   312

    # Returns the connector connected to output

   313

    def GetNextConnector(self):

   314

        if self.Output:

   315

            wires = self.Output.GetWires()

   316

            if len(wires) == 1:

   317

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

   318

        return None

   319

   320

    # Returns the connector connected to action

   321

    def GetActionConnector(self):

   322

        if self.Action:

   323

            wires = self.Action.GetWires()

   324

            if len(wires) == 1:

   325

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

   326

        return None

   327

   328

    # Returns the number of action line

   329

    def GetActionExtraLineNumber(self):

   330

        if self.Action:

   331

            wires = self.Action.GetWires()

   332

            if len(wires) != 1:

   333

                return 0

   334

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

   335

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

   336

        return 0

   337

   338

    # Returns the step minimum size

   339

    def GetMinSize(self):

   340

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

   341

        if self.Initial:

   342

            return text_width + 14, text_height + 14

   343

        else:

   344

            return text_width + 10, text_height + 10

   345

   346

    # Updates the step size

   347

    def UpdateSize(self, width, height):

   348

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

   349

        diffy = height - self.Size.GetHeight()

   350

        self.Move(diffx, 0)

   351

        Graphic_Element.SetSize(self, width, height)

   352

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

   353

            self.RefreshConnected()

   354

        else:

   355

            self.RefreshOutputPosition((0, diffy))

   356

   357

    # Align input element with this step

   358

    def RefreshInputPosition(self):

   359

        if self.Input:

   360

            current_pos = self.Input.GetPosition(False)

   361

            input = self.GetPreviousConnector()

   362

            if input:

   363

                input_pos = input.GetPosition(False)

   364

                diffx = current_pos.x - input_pos.x

   365

                input_block = input.GetParentBlock()

   366

                if isinstance(input_block, SFC_Divergence):

   367

                    input_block.MoveConnector(input, diffx)

   368

                else:

   369

                    if isinstance(input_block, SFC_Step):

   370

                        input_block.MoveActionBlock((diffx, 0))

   371

                    input_block.Move(diffx, 0)

   372

                    input_block.RefreshInputPosition()

   373

   374

    # Align output element with this step

   375

    def RefreshOutputPosition(self, move = None):

   376

        if self.Output:

   377

            wires = self.Output.GetWires()

   378

            if len(wires) != 1:

   379

                return

   380

            current_pos = self.Output.GetPosition(False)

   381

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

   382

            output_pos = output.GetPosition(False)

   383

            diffx = current_pos.x - output_pos.x

   384

            output_block = output.GetParentBlock()

   385

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

   386

            diffy = wire_size - output_pos.y + current_pos.y

   387

            if diffy != 0:

   388

                if isinstance(output_block, SFC_Step):

   389

                    output_block.MoveActionBlock((diffx, diffy))

   390

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

   391

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

   392

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

   393

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

   394

                    output_block.RefreshOutputPosition((diffx, diffy))

   395

                else:

   396

                    output_block.RefreshPosition()

   397

            elif move:

   398

                if isinstance(output_block, SFC_Step):

   399

                    output_block.MoveActionBlock(move)

   400

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

   401

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

   402

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

   403

                    output_block.RefreshOutputPosition(move)

   404

                else:

   405

                    output_block.RefreshPosition()

   406

            elif isinstance(output_block, SFC_Divergence):

   407

                output_block.MoveConnector(output, diffx)

   408

            else:

   409

                if isinstance(output_block, SFC_Step):

   410

                    output_block.MoveActionBlock((diffx, 0))

   411

                output_block.Move(diffx, 0)

   412

                output_block.RefreshOutputPosition()

   413

   414

    # Refresh action element with this step

   415

    def MoveActionBlock(self, move):

   416

        if self.Action:

   417

            wires = self.Action.GetWires()

   418

            if len(wires) != 1:

   419

                return

   420

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

   421

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

   422

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

   423

   424

    # Resize the divergence from position and size given

   425

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

   426

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

   427

            self.UpdateSize(width, height)

   428

        else:

   429

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

   430

   431

    # Method called when a LeftDClick event have been generated

   432

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

   433

        # Edit the step properties

   434

        self.Parent.EditStepContent(self)

   435

   436

    # Method called when a RightUp event have been generated

   437

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

   438

        # Popup the menu with special items for a step

   439

        self.Parent.PopupDefaultMenu()

   440

   441

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

   442

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

   443

        handle_type, handle = self.Handle

   444

        if handle_type == HANDLE_MOVE:

   445

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

   446

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

   447

            if scaling is not None:

   448

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

   449

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

   450

            action_block = None

   451

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

   452

                self.Move(movex, movey)

   453

                self.RefreshConnected()

   454

                return movex, movey

   455

            elif self.Initial:

   456

                self.MoveActionBlock((movex, movey))

   457

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

   458

                self.RefreshOutputPosition((movex, movey))

   459

                return movex, movey

   460

            else:

   461

                self.MoveActionBlock((movex, 0))

   462

                self.Move(movex, 0)

   463

                self.RefreshInputPosition()

   464

                self.RefreshOutputPosition()

   465

                return movex, 0

   466

        else:

   467

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

   468

   469

    # Refresh input element model

   470

    def RefreshInputModel(self):

   471

        if self.Input:

   472

            input = self.GetPreviousConnector()

   473

            if input:                

   474

                input_block = input.GetParentBlock()

   475

                input_block.RefreshModel(False)

   476

                if not isinstance(input_block, SFC_Divergence):

   477

                    input_block.RefreshInputModel()

   478

   479

    # Refresh output element model

   480

    def RefreshOutputModel(self, move=False):

   481

        if self.Output:

   482

            output = self.GetNextConnector()

   483

            if output:

   484

                output_block = output.GetParentBlock()

   485

                output_block.RefreshModel(False)

   486

                if not isinstance(output_block, SFC_Divergence) or move:

   487

                    output_block.RefreshOutputModel(move)

   488

   489

    # Refreshes the step model

   490

    def RefreshModel(self, move=True):

   491

        self.Parent.RefreshStepModel(self)

   492

        if self.Action:

   493

            action = self.GetActionConnector()

   494

            if action:

   495

                action_block = action.GetParentBlock()

   496

                action_block.RefreshModel(False)

   497

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

   498

        if move:

   499

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

   500

                self.RefreshInputModel()

   501

                self.RefreshOutputModel(self.Initial)

   502

            elif self.Output:

   503

                self.Output.RefreshWires()

   504

   505

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

   506

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

   507

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

   508

   509

    # Draws step