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.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, parent, id = None, name = "Step", pos = None):

    69

        step = SFC_Step(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

    # Refresh the size of text for name

   113

    def RefreshNameSize(self):

   114

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

   115

   116

    # Add output connector to step

   117

    def AddInput(self):

   118

        if not self.Input:

   119

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

   120

            self.RefreshBoundingBox()

   121

   122

    # Remove output connector from step

   123

    def RemoveInput(self):

   124

        if self.Input:

   125

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

   126

            self.Input = None

   127

            self.RefreshBoundingBox()

   128

   129

    # Add output connector to step

   130

    def AddOutput(self):

   131

        if not self.Output:

   132

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

   133

            self.RefreshBoundingBox()

   134

   135

    # Remove output connector from step

   136

    def RemoveOutput(self):

   137

        if self.Output:

   138

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

   139

            self.Output = None

   140

            self.RefreshBoundingBox()

   141

   142

    # Add action connector to step

   143

    def AddAction(self):

   144

        if not self.Action:

   145

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

   146

            self.RefreshBoundingBox()

   147

   148

    # Remove action connector from step

   149

    def RemoveAction(self):

   150

        if self.Action:

   151

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

   152

            self.Action = None

   153

            self.RefreshBoundingBox()

   154

   155

    # Refresh the step bounding box

   156

    def RefreshBoundingBox(self):

   157

        # Calculate the bounding box size

   158

        if self.Action:

   159

            bbx_width = self.Size[0] + CONNECTOR_SIZE

   160

        else:

   161

            bbx_width = self.Size[0]

   162

        if self.Initial:

   163

            bbx_y = self.Pos.y

   164

            bbx_height = self.Size[1]

   165

            if self.Output:

   166

                bbx_height += CONNECTOR_SIZE

   167

        else:

   168

            bbx_y = self.Pos.y - CONNECTOR_SIZE

   169

            bbx_height = self.Size[1] + CONNECTOR_SIZE

   170

            if self.Output:

   171

                bbx_height += CONNECTOR_SIZE

   172

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

   173

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

   174

   175

    # Refresh the positions of the step connectors

   176

    def RefreshConnectors(self):

   177

        scaling = self.Parent.GetScaling()

   178

        horizontal_pos = self.Size[0] / 2

   179

        vertical_pos = self.Size[1] / 2

   180

        if scaling is not None:

   181

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

   182

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

   183

        # Update input position if it exists

   184

        if self.Input:

   185

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

   186

        # Update output position

   187

        if self.Output:

   188

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

   189

        # Update action position if it exists

   190

        if self.Action:

   191

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

   192

        self.RefreshConnected()

   193

   194

    # Refresh the position of wires connected to step

   195

    def RefreshConnected(self, exclude = []):

   196

        if self.Input:

   197

            self.Input.MoveConnected(exclude)

   198

        if self.Output:

   199

            self.Output.MoveConnected(exclude)

   200

        if self.Action:

   201

            self.Action.MoveConnected(exclude)

   202

   203

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

   204

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

   205

        # if a name is given

   206

        if name:

   207

            # Test input, output and action connector if they exists

   208

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

   209

                return self.Input

   210

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

   211

                return self.Output

   212

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

   213

                return self.Action

   214

        # Test input connector if it exists

   215

        if self.Input:

   216

            input_pos = self.Input.GetRelPosition()

   217

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

   218

                return self.Input

   219

        # Test output connector if it exists

   220

        if self.Output:

   221

            output_pos = self.Output.GetRelPosition()

   222

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

   223

                return self.Output

   224

        # Test action connector if it exists

   225

        if self.Action:

   226

            action_pos = self.Action.GetRelPosition()

   227

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

   228

                return self.Action

   229

        return None

   230

   231

    # Returns input and output step connectors 

   232

    def GetConnectors(self):

   233

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

   234

   235

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

   236

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

   237

        # Test input connector if it exists

   238

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

   239

            return self.Input

   240

        # Test output connector

   241

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

   242

            return self.Output

   243

        # Test action connector

   244

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

   245

            return self.Action

   246

        return None

   247

   248

    # Changes the step name

   249

    def SetName(self, name):

   250

        self.Name = name

   251

        self.RefreshNameSize()

   252

   253

    # Returns the step name

   254

    def GetName(self):

   255

        return self.Name

   256

   257

    # Returns the step initial property

   258

    def GetInitial(self):

   259

        return self.Initial

   260

   261

    # Returns the connector connected to input

   262

    def GetPreviousConnector(self):

   263

        if self.Input:

   264

            wires = self.Input.GetWires()

   265

            if len(wires) == 1:

   266

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

   267

        return None

   268

   269

    # Returns the connector connected to output

   270

    def GetNextConnector(self):

   271

        if self.Output:

   272

            wires = self.Output.GetWires()

   273

            if len(wires) == 1:

   274

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

   275

        return None

   276

   277

    # Returns the connector connected to action

   278

    def GetActionConnector(self):

   279

        if self.Action:

   280

            wires = self.Action.GetWires()

   281

            if len(wires) == 1:

   282

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

   283

        return None

   284

   285

    # Returns the number of action line

   286

    def GetActionExtraLineNumber(self):

   287

        if self.Action:

   288

            wires = self.Action.GetWires()

   289

            if len(wires) != 1:

   290

                return 0

   291

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

   292

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

   293

        return 0

   294

   295

    # Returns the step minimum size

   296

    def GetMinSize(self):

   297

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

   298

        if self.Initial:

   299

            return text_width + 14, text_height + 14

   300

        else:

   301

            return text_width + 10, text_height + 10

   302

   303

    # Updates the step size

   304

    def UpdateSize(self, width, height):

   305

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

   306

        diffy = height - self.Size.GetHeight()

   307

        self.Move(diffx, 0)

   308

        Graphic_Element.SetSize(self, width, height)

   309

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

   310

            self.RefreshConnected()

   311

        else:

   312

            self.RefreshOutputPosition((0, diffy))

   313

   314

    # Align input element with this step

   315

    def RefreshInputPosition(self):

   316

        if self.Input:

   317

            current_pos = self.Input.GetPosition(False)

   318

            input = self.GetPreviousConnector()

   319

            if input:

   320

                input_pos = input.GetPosition(False)

   321

                diffx = current_pos.x - input_pos.x

   322

                input_block = input.GetParentBlock()

   323

                if isinstance(input_block, SFC_Divergence):

   324

                    input_block.MoveConnector(input, diffx)

   325

                else:

   326

                    if isinstance(input_block, SFC_Step):

   327

                        input_block.MoveActionBlock((diffx, 0))

   328

                    input_block.Move(diffx, 0)

   329

                    input_block.RefreshInputPosition()

   330

   331

    # Align output element with this step

   332

    def RefreshOutputPosition(self, move = None):

   333

        if self.Output:

   334

            wires = self.Output.GetWires()

   335

            if len(wires) != 1:

   336

                return

   337

            current_pos = self.Output.GetPosition(False)

   338

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

   339

            output_pos = output.GetPosition(False)

   340

            diffx = current_pos.x - output_pos.x

   341

            output_block = output.GetParentBlock()

   342

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

   343

            diffy = wire_size - output_pos.y + current_pos.y

   344

            if diffy != 0:

   345

                if isinstance(output_block, SFC_Step):

   346

                    output_block.MoveActionBlock((diffx, diffy))

   347

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

   348

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

   349

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

   350

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

   351

                    output_block.RefreshOutputPosition((diffx, diffy))

   352

                else:

   353

                    output_block.RefreshPosition()

   354

            elif move:

   355

                if isinstance(output_block, SFC_Step):

   356

                    output_block.MoveActionBlock(move)

   357

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

   358

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

   359

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

   360

                    output_block.RefreshOutputPosition(move)

   361

                else:

   362

                    output_block.RefreshPosition()

   363

            elif isinstance(output_block, SFC_Divergence):

   364

                output_block.MoveConnector(output, diffx)

   365

            else:

   366

                if isinstance(output_block, SFC_Step):

   367

                    output_block.MoveActionBlock((diffx, 0))

   368

                output_block.Move(diffx, 0)

   369

                output_block.RefreshOutputPosition()

   370

   371

    # Refresh action element with this step

   372

    def MoveActionBlock(self, move):

   373

        if self.Action:

   374

            wires = self.Action.GetWires()

   375

            if len(wires) != 1:

   376

                return

   377

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

   378

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

   379

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

   380

   381

    # Resize the divergence from position and size given

   382

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

   383

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

   384

            self.UpdateSize(width, height)

   385

        else:

   386

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

   387

   388

    # Method called when a LeftDClick event have been generated

   389

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

   390

        # Edit the step properties

   391

        self.Parent.EditStepContent(self)

   392

   393

    # Method called when a RightUp event have been generated

   394

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

   395

        # Popup the menu with special items for a step

   396

        self.Parent.PopupDefaultMenu()

   397

   398

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

   399

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

   400

        handle_type, handle = self.Handle

   401

        if handle_type == HANDLE_MOVE:

   402

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

   403

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

   404

            if scaling is not None:

   405

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

   406

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

   407

            action_block = None

   408

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

   409

                self.Move(movex, movey)

   410

                self.RefreshConnected()

   411

                return movex, movey

   412

            elif self.Initial:

   413

                self.MoveActionBlock((movex, movey))

   414

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

   415

                self.RefreshOutputPosition((movex, movey))

   416

                return movex, movey

   417

            else:

   418

                self.MoveActionBlock((movex, 0))

   419

                self.Move(movex, 0)

   420

                self.RefreshInputPosition()

   421

                self.RefreshOutputPosition()

   422

                return movex, 0

   423

        else:

   424

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

   425

   426

    # Refresh input element model

   427

    def RefreshInputModel(self):

   428

        if self.Input:

   429

            input = self.GetPreviousConnector()

   430

            if input:                

   431

                input_block = input.GetParentBlock()

   432

                input_block.RefreshModel(False)

   433

                if not isinstance(input_block, SFC_Divergence):

   434

                    input_block.RefreshInputModel()

   435

   436

    # Refresh output element model

   437

    def RefreshOutputModel(self, move=False):

   438

        if self.Output:

   439

            output = self.GetNextConnector()

   440

            if output:

   441

                output_block = output.GetParentBlock()

   442

                output_block.RefreshModel(False)

   443

                if not isinstance(output_block, SFC_Divergence) or move:

   444

                    output_block.RefreshOutputModel(move)

   445

   446

    # Refreshes the step model

   447

    def RefreshModel(self, move=True):

   448

        self.Parent.RefreshStepModel(self)

   449

        if self.Action:

   450

            action = self.GetActionConnector()

   451

            if action:

   452

                action_block = action.GetParentBlock()

   453

                action_block.RefreshModel(False)

   454

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

   455

        if move:

   456

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

   457

                self.RefreshInputModel()

   458

                self.RefreshOutputModel(self.Initial)

   459

            elif self.Output:

   460

                self.Output.RefreshWires()

   461

   462

    # Draws step

   463

    def Draw(self, dc):

   464

        Graphic_Element.Draw(self, dc)

   465

        dc.SetPen(wx.BLACK_PEN)

   466

        dc.SetBrush(wx.WHITE_BRUSH)

   467

   468

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

   469

            name_size = dc.GetTextExtent(self.Name)

   470

        else:

   471

            name_size = self.NameSize

   472

   473

        # Draw two rectangles for representing the step

   474

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

   475

        if self.Initial:

   476

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

   477

        # Draw step name

   478

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

   479

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

   480

        # Draw input and output connectors

   481

        if self.Input:

   482

            self.Input.Draw(dc)

   483

        if self.Output:

   484

            self.Output.Draw(dc)

   485

        if self.Action:

   486

            self.Action.Draw(dc)

   487

   488

   489

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

   490

#                       Sequencial Function Chart Transition

   491

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

   492

   493

"""

   494

Class that implements the graphic representation of a transition

   495

"""

   496

   497

class SFC_Transition(Graphic_Element):

   498

   499

    # Create a new transition

   500

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

   501

        Graphic_Element.__init__(self, parent)

   502

        self.Type = None

   503

        self.Id = id

   504

        self.Priority = 0

   505

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

   506

        # Create an input and output connector

   507

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

   508

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

   509

        self.SetType(type, condition)

   510

        self.SetPriority(priority)

   511

   512

    # Destructor