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): 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

#Lesser 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

from wxPython.wx import *

    26

import wx

    27

    28

from GraphicCommons import *

    29

from plcopen.structures import *

    30

    31

def GetWireSize(block):

    32

    if isinstance(block, SFC_Step):

    33

        return SFC_WIRE_MIN_SIZE + block.GetActionExtraLineNumber() * SFC_ACTION_MIN_SIZE[1]

    34

    else:

    35

        return SFC_WIRE_MIN_SIZE

    36

    37

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

    38

#                         Sequencial Function Chart Step

    39

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

    40

    41

"""

    42

Class that implements the graphic representation of a step

    43

"""

    44

    45

class SFC_Step(Graphic_Element):

    46

    47

    # Create a new step

    48

    def __init__(self, parent, name, initial = False, id = None):

    49

        Graphic_Element.__init__(self, parent)

    50

        self.Name = name

    51

        self.Initial = initial

    52

        self.Id = id

    53

        self.Size = wxSize(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, "", "ANY", wxPoint(self.Size[0] / 2, 0), NORTH)

    57

        else:

    58

            self.Input = None

    59

        self.Output = None

    60

        self.Action = None

    61

    62

    # Destructor

    63

    def __del__(self):

    64

        self.Input = None

    65

        self.Output = None

    66

        self.Action = None

    67

    68

    # Delete this step by calling the appropriate method

    69

    def Delete(self):

    70

        self.Parent.DeleteStep(self)

    71

    72

    # Unconnect input and output

    73

    def Clean(self):

    74

        if self.Input:

    75

            self.Input.UnConnect()

    76

        if self.Output:

    77

            self.Output.UnConnect()

    78

        if self.Action:

    79

            self.Action.UnConnect()

    80

    81

    # Add output connector to step

    82

    def AddOutput(self):

    83

        if not self.Output:

    84

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

    85

            self.RefreshBoundingBox()

    86

    87

    # Remove output connector from step

    88

    def RemoveOutput(self):

    89

        if self.Output:

    90

            self.Output.UnConnect()

    91

            self.Output = None

    92

            self.RefreshBoundingBox()

    93

    94

    # Add action connector to step

    95

    def AddAction(self):

    96

        if not self.Action:

    97

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

    98

            self.RefreshBoundingBox()

    99

   100

    # Remove action connector from step

   101

    def RemoveAction(self):

   102

        if self.Action:

   103

            self.Action.UnConnect()

   104

            self.Action = None

   105

            self.RefreshBoundingBox()

   106

   107

    # Refresh the step bounding box

   108

    def RefreshBoundingBox(self):

   109

        dc = wxClientDC(self.Parent)

   110

        # Calculate the bounding box size

   111

        if self.Action:

   112

            bbx_width = self.Size[0] + CONNECTOR_SIZE

   113

        else:

   114

            bbx_width = self.Size[0]

   115

        if self.Initial:

   116

            bbx_y = self.Pos.y

   117

            bbx_height = self.Size[1]

   118

            if self.Output:

   119

                bbx_height += CONNECTOR_SIZE

   120

        else:

   121

            bbx_y = self.Pos.y - CONNECTOR_SIZE

   122

            bbx_height = self.Size[1] + CONNECTOR_SIZE

   123

            if self.Output:

   124

                bbx_height += CONNECTOR_SIZE

   125

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

   126

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

   127

   128

    # Refresh the positions of the step connectors

   129

    def RefreshConnectors(self):

   130

        # Update input position if it exists

   131

        if self.Input:

   132

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

   133

        # Update output position

   134

        if self.Output:

   135

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

   136

        # Update action position if it exists

   137

        if self.Action:

   138

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

   139

        self.RefreshConnected()

   140

   141

    # Refresh the position of wires connected to step

   142

    def RefreshConnected(self, exclude = []):

   143

        if self.Input:

   144

            self.Input.MoveConnected(exclude)

   145

        if self.Output:

   146

            self.Output.MoveConnected(exclude)

   147

        if self.Action:

   148

            self.Action.MoveConnected(exclude)

   149

   150

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

   151

    def GetConnector(self, position):

   152

        # Test input connector if it exists

   153

        if self.Input:

   154

            input_pos = self.Input.GetRelPosition()

   155

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

   156

                return self.Input

   157

        # Test output connector if it exists

   158

        if self.Output:

   159

            output_pos = self.Output.GetRelPosition()

   160

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

   161

                return self.Output

   162

        # Test action connector if it exists

   163

        if self.Action:

   164

            action_pos = self.Action.GetRelPosition()

   165

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

   166

                return self.Action

   167

        return None

   168

   169

    # Returns input and output step connectors 

   170

    def GetConnectors(self):

   171

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

   172

   173

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

   174

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

   175

        # Test input connector if it exists

   176

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

   177

            return self.Input

   178

        # Test output connector

   179

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

   180

            return self.Output

   181

        return None

   182

   183

    # Changes the step name

   184

    def SetName(self, name):

   185

        self.Name = name

   186

   187

    # Returns the step name

   188

    def GetName(self):

   189

        return self.Name

   190

   191

    # Returns the step initial property

   192

    def GetInitial(self):

   193

        return self.Initial

   194

   195

    # Returns the connector connected to input

   196

    def GetPreviousConnector(self):

   197

        if self.Input:

   198

            wires = self.Input.GetWires()

   199

            if len(wires) == 1:

   200

                return wires[0][0].EndConnected

   201

        return None

   202

   203

    # Returns the connector connected to output

   204

    def GetNextConnector(self):

   205

        if self.Output:

   206

            wires = self.Output.GetWires()

   207

            if len(wires) == 1:

   208

                return wires[0][0].StartConnected

   209

        return None

   210

   211

    # Returns the connector connected to action

   212

    def GetActionConnector(self):

   213

        if self.Action:

   214

            wires = self.Action.GetWires()

   215

            if len(wires) == 1:

   216

                return wires[0][0].StartConnected

   217

        return None

   218

   219

    # Returns the number of action line

   220

    def GetActionExtraLineNumber(self):

   221

        if self.Action:

   222

            wires = self.Action.GetWires()

   223

            if len(wires) != 1:

   224

                return 0

   225

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

   226

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

   227

        return 0

   228

   229

    # Returns the step minimum size

   230

    def GetMinSize(self):

   231

        dc = wxClientDC(self.Parent)

   232

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

   233

        if self.Initial:

   234

            return text_width + 14, text_height + 14

   235

        else:

   236

            return text_width + 10, text_height + 10

   237

   238

    # Updates the step size

   239

    def UpdateSize(self, width, height):

   240

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

   241

        diffy = height - self.Size.GetHeight()

   242

        self.Move(diffx, 0)

   243

        Graphic_Element.SetSize(self, width, height)

   244

        self.RefreshOutputPosition((0, diffy))

   245

   246

    # Align input element with this step

   247

    def RefreshInputPosition(self):

   248

        if self.Input:

   249

            current_pos = self.Input.GetPosition(False)

   250

            input = self.GetPreviousConnector()

   251

            if input:

   252

                input_pos = input.GetPosition(False)

   253

                diffx = current_pos.x - input_pos.x

   254

                input_block = input.GetParentBlock()

   255

                if isinstance(input_block, SFC_Divergence):

   256

                    input_block.MoveConnector(input, diffx)

   257

                else:

   258

                    if isinstance(input_block, SFC_Step):

   259

                        input_block.MoveActionBlock((diffx, 0))

   260

                    input_block.Move(diffx, 0)

   261

                    input_block.RefreshInputPosition()

   262

   263

    # Align output element with this step

   264

    def RefreshOutputPosition(self, move = None):

   265

        if self.Output:

   266

            wires = self.Output.GetWires()

   267

            if len(wires) != 1:

   268

                return

   269

            current_pos = self.Output.GetPosition(False)

   270

            output = wires[0][0].StartConnected

   271

            output_pos = output.GetPosition(False)

   272

            diffx = current_pos.x - output_pos.x

   273

            output_block = output.GetParentBlock()

   274

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

   275

            diffy = wire_size - output_pos.y + current_pos.y

   276

            if diffy != 0:

   277

                if isinstance(output_block, SFC_Step):

   278

                    output_block.MoveActionBlock((diffx, diffy))

   279

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

   280

                    wxPoint(current_pos.x, current_pos.y)])

   281

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

   282

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

   283

                    output_block.RefreshOutputPosition((diffx, diffy))

   284

                else:

   285

                    output_block.RefreshPosition()

   286

            elif move:

   287

                if isinstance(output_block, SFC_Step):

   288

                    output_block.MoveActionBlock(move)

   289

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

   290

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

   291

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

   292

                    output_block.RefreshOutputPosition(move)

   293

                else:

   294

                    output_block.RefreshPosition()

   295

            elif isinstance(output_block, SFC_Divergence):

   296

                output_block.MoveConnector(output, diffx)

   297

            else:

   298

                if isinstance(output_block, SFC_Step):

   299

                    output_block.MoveActionBlock((diffx, 0))

   300

                output_block.Move(diffx, 0)

   301

                output_block.RefreshOutputPosition()

   302

   303

    # Refresh action element with this step

   304

    def MoveActionBlock(self, move):

   305

        if self.Action:

   306

            wires = self.Action.GetWires()

   307

            if len(wires) != 1:

   308

                return

   309

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

   310

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

   311

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

   312

   313

    # Resize the divergence from position and size given

   314

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

   315

        self.UpdateSize(width, height)

   316

   317

    # Method called when a LeftDClick event have been generated

   318

    def OnLeftDClick(self, event, scaling):

   319

        # Edit the step properties

   320

        self.Parent.EditStepContent(self)

   321

   322

    # Method called when a RightUp event have been generated

   323

    def OnRightUp(self, event, scaling):

   324

        # Popup the menu with special items for a step

   325

        self.Parent.PopupDefaultMenu()

   326

   327

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

   328

    def ProcessDragging(self, movex, movey):

   329

        handle_type, handle = self.Handle

   330

        if handle_type == HANDLE_MOVE:

   331

            action_block = None

   332

            if self.Initial:

   333

                self.MoveActionBlock((movex, movey))

   334

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

   335

                self.RefreshOutputPosition((movex, movey))

   336

            else:

   337

                self.MoveActionBlock((movex, 0))

   338

                self.Move(movex, 0)

   339

                self.RefreshInputPosition()

   340

                self.RefreshOutputPosition()

   341

        else:

   342

            Graphic_Element.ProcessDragging(self, movex, movey)

   343

   344

    # Refresh input element model

   345

    def RefreshInputModel(self):

   346

        if self.Input:

   347

            input = self.GetPreviousConnector()

   348

            if input:                

   349

                input_block = input.GetParentBlock()

   350

                input_block.RefreshModel(False)

   351

                if not isinstance(input_block, SFC_Divergence):

   352

                    input_block.RefreshInputModel()

   353

   354

    # Refresh output element model

   355

    def RefreshOutputModel(self, move=False):

   356

        if self.Output:

   357

            output = self.GetNextConnector()

   358

            if output:

   359

                output_block = output.GetParentBlock()

   360

                output_block.RefreshModel(False)

   361

                if not isinstance(output_block, SFC_Divergence) or move:

   362

                    output_block.RefreshOutputModel(move)

   363

   364

    # Refreshes the step model

   365

    def RefreshModel(self, move=True):

   366

        self.Parent.RefreshStepModel(self)

   367

        if self.Action:

   368

            action = self.GetActionConnector()

   369

            if action:

   370

                action_block = action.GetParentBlock()

   371

                action_block.RefreshModel(False)

   372

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

   373

        if move:

   374

            self.RefreshInputModel()

   375

            self.RefreshOutputModel(self.Initial)

   376

   377

    # Draws step

   378

    def Draw(self, dc):

   379

        dc.SetPen(wxBLACK_PEN)

   380

        dc.SetBrush(wxWHITE_BRUSH)

   381

        # Draw two rectangles for representing the step

   382

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

   383

        if self.Initial:

   384

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

   385

        # Draw step name

   386

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

   387

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

   388

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

   389

        # Draw input and output connectors

   390

        if self.Input:

   391

            self.Input.Draw(dc)

   392

        if self.Output:

   393

            self.Output.Draw(dc)

   394

        if self.Action:

   395

            self.Action.Draw(dc)

   396

        Graphic_Element.Draw(self, dc)

   397

   398

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

   399

#                       Sequencial Function Chart Transition

   400

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

   401

   402

"""

   403

Class that implements the graphic representation of a transition

   404

"""

   405

   406

class SFC_Transition(Graphic_Element):

   407

   408

    # Create a new transition

   409

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

   410

        Graphic_Element.__init__(self, parent)

   411

        self.Type = type

   412

        self.Condition = condition

   413

        self.Id = id

   414

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

   415

        # Create an input and output connector

   416

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

   417

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

   418

   419

    # Destructor

   420

    def __del__(self):

   421

        self.Input = None

   422

        self.Output = None

   423

   424

    # Forbids to change the transition size

   425

    def SetSize(self, width, height):

   426

        pass

   427

   428

    # Forbids to resize the transition

   429

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

   430

        pass

   431

   432

    # Delete this transition by calling the appropriate method

   433

    def Delete(self):

   434

        self.Parent.DeleteTransition(self)

   435

   436

    # Unconnect input and output

   437

    def Clean(self):

   438

        self.Input.UnConnect()

   439

        self.Output.UnConnect()

   440

   441

    # Refresh the transition bounding box

   442

    def RefreshBoundingBox(self):

   443

        dc = wxClientDC(self.Parent)

   444

        if self.Condition != "":

   445

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

   446

        else:

   447

            text_width, text_height = dc.GetTextExtent("Transition")

   448

        # Calculate the bounding box size

   449

        bbx_width = self.Size[0] + 5 + text_width

   450

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

   451

        bbx_height = max(self.Size[1], text_height)

   452

        self.BoundingBox = wxRect(self.Pos.x, bbx_y, bbx_width + 1, bbx_height - 4)

   453

   454

    # Returns the connector connected to input

   455

    def GetPreviousConnector(self):

   456

        wires = self.Input.GetWires()

   457

        if len(wires) == 1:

   458

            return wires[0][0].EndConnected

   459

        return None

   460

   461

    # Returns the connector connected to output

   462

    def GetNextConnector(self):

   463

        wires = self.Output.GetWires()

   464

        if len(wires) == 1:

   465

            return wires[0][0].StartConnected

   466

        return None

   467

   468

    # Refresh the positions of the transition connectors

   469

    def RefreshConnectors(self):

   470

        # Update input position

   471

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

   472

        # Update output position

   473

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

   474

        self.RefreshConnected()

   475

   476

    # Refresh the position of the wires connected to transition

   477

    def RefreshConnected(self, exclude = []):

   478

        self.Input.MoveConnected(exclude)

   479

        self.Output.MoveConnected(exclude)

   480

   481

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

   482

    def GetConnector(self, position):

   483

        # Test input connector

   484

        input_pos = self.Input.GetRelPosition()

   485

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

   486

            return self.Input

   487

        # Test output connector

   488

        output_pos = self.Output.GetRelPosition()

   489

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

   490

            return self.Output

   491

        return None

   492

   493

    # Returns input and output transition connectors

   494

    def GetConnectors(self):

   495

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

   496

   497

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

   498

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

   499

        # Test input connector

   500

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

   501

            return self.Input

   502

        # Test output connector

   503

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

   504

            return self.Output

   505

        return None

   506

   507

    # Changes the transition type

   508

    def SetType(self, type):

   509

        self.Type = type

   510

   511

    # Returns the transition type

   512

    def GetType(self):

   513

        return self.Type

   514

   515

    # Changes the transition condition

   516

    def SetCondition(self, condition):

   517

        self.Condition = condition

   518

        self.RefreshBoundingBox()

   519

   520

    # Returns the transition condition

   521

    def GetCondition(self):

   522

        return self.Condition

   523

   524

    # Returns the transition minimum size

   525

    def GetMinSize(self):

   526

        return SFC_TRANSITION_SIZE

   527

   528

    # Align input element with this step

   529