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, "", "ANY", 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

    # Delete this step by calling the appropriate method

    68

    def Delete(self):

    69

        self.Parent.DeleteStep(self)

    70

    71

    # Unconnect input and output

    72

    def Clean(self):

    73

        if self.Input:

    74

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

    75

        if self.Output:

    76

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

    77

        if self.Action:

    78

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

    79

    80

    # Add output connector to step

    81

    def AddInput(self):

    82

        if not self.Input:

    83

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

    84

            self.RefreshBoundingBox()

    85

    86

    # Remove output connector from step

    87

    def RemoveInput(self):

    88

        if self.Input:

    89

            self.Input.UnConnect()

    90

            self.Input = None

    91

            self.RefreshBoundingBox()

    92

    93

    # Add output connector to step

    94

    def AddOutput(self):

    95

        if not self.Output:

    96

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

    97

            self.RefreshBoundingBox()

    98

    99

    # Remove output connector from step

   100

    def RemoveOutput(self):

   101

        if self.Output:

   102

            self.Output.UnConnect()

   103

            self.Output = None

   104

            self.RefreshBoundingBox()

   105

   106

    # Add action connector to step

   107

    def AddAction(self):

   108

        if not self.Action:

   109

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

   110

            self.RefreshBoundingBox()

   111

   112

    # Remove action connector from step

   113

    def RemoveAction(self):

   114

        if self.Action:

   115

            self.Action.UnConnect()

   116

            self.Action = None

   117

            self.RefreshBoundingBox()

   118

   119

    # Refresh the step bounding box

   120

    def RefreshBoundingBox(self):

   121

        dc = wx.ClientDC(self.Parent)

   122

        # Calculate the bounding box size

   123

        if self.Action:

   124

            bbx_width = self.Size[0] + CONNECTOR_SIZE

   125

        else:

   126

            bbx_width = self.Size[0]

   127

        if self.Initial:

   128

            bbx_y = self.Pos.y

   129

            bbx_height = self.Size[1]

   130

            if self.Output:

   131

                bbx_height += CONNECTOR_SIZE

   132

        else:

   133

            bbx_y = self.Pos.y - CONNECTOR_SIZE

   134

            bbx_height = self.Size[1] + CONNECTOR_SIZE

   135

            if self.Output:

   136

                bbx_height += CONNECTOR_SIZE

   137

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

   138

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

   139

   140

    # Refresh the positions of the step connectors

   141

    def RefreshConnectors(self):

   142

        # Update input position if it exists

   143

        if self.Input:

   144

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

   145

        # Update output position

   146

        if self.Output:

   147

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

   148

        # Update action position if it exists

   149

        if self.Action:

   150

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

   151

        self.RefreshConnected()

   152

   153

    # Refresh the position of wires connected to step

   154

    def RefreshConnected(self, exclude = []):

   155

        if self.Input:

   156

            self.Input.MoveConnected(exclude)

   157

        if self.Output:

   158

            self.Output.MoveConnected(exclude)

   159

        if self.Action:

   160

            self.Action.MoveConnected(exclude)

   161

   162

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

   163

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

   164

        # if a name is given

   165

        if name:

   166

            # Test input, output and action connector if they exists

   167

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

   168

                return self.Input

   169

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

   170

                return self.Output

   171

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

   172

                return self.Action

   173

        # Test input connector if it exists

   174

        if self.Input:

   175

            input_pos = self.Input.GetRelPosition()

   176

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

   177

                return self.Input

   178

        # Test output connector if it exists

   179

        if self.Output:

   180

            output_pos = self.Output.GetRelPosition()

   181

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

   182

                return self.Output

   183

        # Test action connector if it exists

   184

        if self.Action:

   185

            action_pos = self.Action.GetRelPosition()

   186

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

   187

                return self.Action

   188

        return None

   189

   190

    # Returns input and output step connectors 

   191

    def GetConnectors(self):

   192

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

   193

   194

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

   195

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

   196

        # Test input connector if it exists

   197

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

   198

            return self.Input

   199

        # Test output connector

   200

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

   201

            return self.Output

   202

        return None

   203

   204

    # Changes the step name

   205

    def SetName(self, name):

   206

        self.Name = name

   207

   208

    # Returns the step name

   209

    def GetName(self):

   210

        return self.Name

   211

   212

    # Returns the step initial property

   213

    def GetInitial(self):

   214

        return self.Initial

   215

   216

    # Returns the connector connected to input

   217

    def GetPreviousConnector(self):

   218

        if self.Input:

   219

            wires = self.Input.GetWires()

   220

            if len(wires) == 1:

   221

                return wires[0][0].EndConnected

   222

        return None

   223

   224

    # Returns the connector connected to output

   225

    def GetNextConnector(self):

   226

        if self.Output:

   227

            wires = self.Output.GetWires()

   228

            if len(wires) == 1:

   229

                return wires[0][0].StartConnected

   230

        return None

   231

   232

    # Returns the connector connected to action

   233

    def GetActionConnector(self):

   234

        if self.Action:

   235

            wires = self.Action.GetWires()

   236

            if len(wires) == 1:

   237

                return wires[0][0].StartConnected

   238

        return None

   239

   240

    # Returns the number of action line

   241

    def GetActionExtraLineNumber(self):

   242

        if self.Action:

   243

            wires = self.Action.GetWires()

   244

            if len(wires) != 1:

   245

                return 0

   246

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

   247

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

   248

        return 0

   249

   250

    # Returns the step minimum size

   251

    def GetMinSize(self):

   252

        dc = wx.ClientDC(self.Parent)

   253

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

   254

        if self.Initial:

   255

            return text_width + 14, text_height + 14

   256

        else:

   257

            return text_width + 10, text_height + 10

   258

   259

    # Updates the step size

   260

    def UpdateSize(self, width, height):

   261

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

   262

        diffy = height - self.Size.GetHeight()

   263

        self.Move(diffx, 0)

   264

        Graphic_Element.SetSize(self, width, height)

   265

        self.RefreshOutputPosition((0, diffy))

   266

   267

    # Align input element with this step

   268

    def RefreshInputPosition(self):

   269

        if self.Input:

   270

            current_pos = self.Input.GetPosition(False)

   271

            input = self.GetPreviousConnector()

   272

            if input:

   273

                input_pos = input.GetPosition(False)

   274

                diffx = current_pos.x - input_pos.x

   275

                input_block = input.GetParentBlock()

   276

                if isinstance(input_block, SFC_Divergence):

   277

                    input_block.MoveConnector(input, diffx)

   278

                else:

   279

                    if isinstance(input_block, SFC_Step):

   280

                        input_block.MoveActionBlock((diffx, 0))

   281

                    input_block.Move(diffx, 0)

   282

                    input_block.RefreshInputPosition()

   283

   284

    # Align output element with this step

   285

    def RefreshOutputPosition(self, move = None):

   286

        if self.Output:

   287

            wires = self.Output.GetWires()

   288

            if len(wires) != 1:

   289

                return

   290

            current_pos = self.Output.GetPosition(False)

   291

            output = wires[0][0].StartConnected

   292

            output_pos = output.GetPosition(False)

   293

            diffx = current_pos.x - output_pos.x

   294

            output_block = output.GetParentBlock()

   295

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

   296

            diffy = wire_size - output_pos.y + current_pos.y

   297

            if diffy != 0:

   298

                if isinstance(output_block, SFC_Step):

   299

                    output_block.MoveActionBlock((diffx, diffy))

   300

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

   301

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

   302

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

   303

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

   304

                    output_block.RefreshOutputPosition((diffx, diffy))

   305

                else:

   306

                    output_block.RefreshPosition()

   307

            elif move:

   308

                if isinstance(output_block, SFC_Step):

   309

                    output_block.MoveActionBlock(move)

   310

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

   311

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

   312

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

   313

                    output_block.RefreshOutputPosition(move)

   314

                else:

   315

                    output_block.RefreshPosition()

   316

            elif isinstance(output_block, SFC_Divergence):

   317

                output_block.MoveConnector(output, diffx)

   318

            else:

   319

                if isinstance(output_block, SFC_Step):

   320

                    output_block.MoveActionBlock((diffx, 0))

   321

                output_block.Move(diffx, 0)

   322

                output_block.RefreshOutputPosition()

   323

   324

    # Refresh action element with this step

   325

    def MoveActionBlock(self, move):

   326

        if self.Action:

   327

            wires = self.Action.GetWires()

   328

            if len(wires) != 1:

   329

                return

   330

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

   331

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

   332

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

   333

   334

    # Resize the divergence from position and size given

   335

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

   336

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

   337

            self.UpdateSize(width, height)

   338

        else:

   339

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

   340

   341

    # Method called when a LeftDClick event have been generated

   342

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

   343

        # Edit the step properties

   344

        self.Parent.EditStepContent(self)

   345

   346

    # Method called when a RightUp event have been generated

   347

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

   348

        # Popup the menu with special items for a step

   349

        self.Parent.PopupDefaultMenu()

   350

   351

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

   352

    def ProcessDragging(self, movex, movey):

   353

        handle_type, handle = self.Handle

   354

        if handle_type == HANDLE_MOVE:

   355

            action_block = None

   356

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

   357

                self.Move(movex, movey)

   358

                self.RefreshConnected()

   359

            elif self.Initial:

   360

                self.MoveActionBlock((movex, movey))

   361

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

   362

                self.RefreshOutputPosition((movex, movey))

   363

            else:

   364

                self.MoveActionBlock((movex, 0))

   365

                self.Move(movex, 0)

   366

                self.RefreshInputPosition()

   367

                self.RefreshOutputPosition()

   368

        else:

   369

            Graphic_Element.ProcessDragging(self, movex, movey)

   370

   371

    # Refresh input element model

   372

    def RefreshInputModel(self):

   373

        if self.Input:

   374

            input = self.GetPreviousConnector()

   375

            if input:                

   376

                input_block = input.GetParentBlock()

   377

                input_block.RefreshModel(False)

   378

                if not isinstance(input_block, SFC_Divergence):

   379

                    input_block.RefreshInputModel()

   380

   381

    # Refresh output element model

   382

    def RefreshOutputModel(self, move=False):

   383

        if self.Output:

   384

            output = self.GetNextConnector()

   385

            if output:

   386

                output_block = output.GetParentBlock()

   387

                output_block.RefreshModel(False)

   388

                if not isinstance(output_block, SFC_Divergence) or move:

   389

                    output_block.RefreshOutputModel(move)

   390

   391

    # Refreshes the step model

   392

    def RefreshModel(self, move=True):

   393

        self.Parent.RefreshStepModel(self)

   394

        if self.Action:

   395

            action = self.GetActionConnector()

   396

            if action:

   397

                action_block = action.GetParentBlock()

   398

                action_block.RefreshModel(False)

   399

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

   400

        if move:

   401

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

   402

                self.RefreshInputModel()

   403

                self.RefreshOutputModel(self.Initial)

   404

            elif self.Output:

   405

                self.Output.RefreshWires()

   406

   407

    # Draws step

   408

    def Draw(self, dc):

   409

        dc.SetPen(wx.BLACK_PEN)

   410

        dc.SetBrush(wx.WHITE_BRUSH)

   411

        # Draw two rectangles for representing the step

   412

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

   413

        if self.Initial:

   414

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

   415

        # Draw step name

   416

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

   417

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

   418

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

   419

        # Draw input and output connectors

   420

        if self.Input:

   421

            self.Input.Draw(dc)

   422

        if self.Output:

   423

            self.Output.Draw(dc)

   424

        if self.Action:

   425

            self.Action.Draw(dc)

   426

        Graphic_Element.Draw(self, dc)

   427

   428

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

   429

#                       Sequencial Function Chart Transition

   430

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

   431

   432

"""

   433

Class that implements the graphic representation of a transition

   434

"""

   435

   436

class SFC_Transition(Graphic_Element):

   437

   438

    # Create a new transition

   439

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

   440

        Graphic_Element.__init__(self, parent)

   441

        self.Type = None

   442

        self.Id = id

   443

        self.Priority = 0

   444

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

   445

        # Create an input and output connector

   446

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

   447

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

   448

        self.SetType(type, condition)

   449

        self.SetPriority(priority)

   450

   451

    # Destructor

   452

    def __del__(self):

   453

        self.Input = None

   454

        self.Output = None

   455

        if self.Type == "connection":

   456

            self.Condition = None

   457

   458

    # Forbids to change the transition size

   459

    def SetSize(self, width, height):

   460

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

   461

            Graphic_Element.SetSize(self, width, height)

   462

   463

    # Forbids to resize the transition

   464

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

   465

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

   466

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

   467

   468

    # Refresh the size of text for name

   469

    def RefreshConditionSize(self):

   470

        if self.Type != "connection":

   471

            dc = wx.ClientDC(self.Parent)

   472

            if self.Condition != "":

   473

                self.ConditionSize = dc.GetTextExtent(self.Condition)

   474

            else:

   475

                self.ConditionSize = dc.GetTextExtent("Transition")

   476

   477

    # Refresh the size of text for name

   478

    def RefreshPrioritySize(self):

   479

        if self.Priority != "":

   480

            dc = wx.ClientDC(self.Parent)

   481

            self.PrioritySize = dc.GetTextExtent(str(self.Priority))

   482

        else:

   483

            self.PrioritySize = None

   484

   485

    # Delete this transition by calling the appropriate method

   486

    def Delete(self):

   487

        self.Parent.DeleteTransition(self)

   488

   489

    # Unconnect input and output

   490

    def Clean(self):

   491

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

   492

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

   493

        if self.Type == "connection":

   494

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

   495

   496

    # Refresh the transition bounding box

   497

    def RefreshBoundingBox(self):

   498

        dc = wx.ClientDC(self.Parent)

   499

        bbx_x, bbx_y, bbx_width, bbx_height = self.Pos.x, self.Pos.y, self.Size[0], self.Size[1]

   500

        if self.Priority != 0:

   501

            bbx_y = self.Pos.y - self.PrioritySize[1] - 2

   502

            bbx_width = max(self.Size[0], self.PrioritySize[0])

   503

            bbx_height = self.Size[1] + self.PrioritySize[1] + 2

   504

        if self.Type == "connection":

   505

            bbx_x = self.Pos.x - CONNECTOR_SIZE

   506

            bbx_width = bbx_width + CONNECTOR_SIZE

   507

        else:

   508

            text_width, text_height = self.ConditionSize

   509

            # Calculate the bounding box size

   510

            bbx_width = max(bbx_width, self.Size[0] + 5 + text_width)

   511

            bbx_y = min(bbx_y, self.Pos.y - max(0, (text_height - self.Size[1]) / 2))

   512

            bbx_height = max(bbx_height, self.Pos.y - bbx_y + (self.Size[1] + text_height) / 2)

   513

        self.BoundingBox = wx.Rect(bbx_x, bbx_y, bbx_width + 1, bbx_height + 1)

   514

   515

    # Returns the connector connected to input

   516

    def GetPreviousConnector(self):

   517

        wires = self.Input.GetWires()