38

    """

    39

    Function returning table column header labels

    40

    @return: List of labels [col_label,...]

    41

    """

    45

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

    46

#                        Debug Variable Table Panel

    47

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

    48

    49

"""

    50

Class that implements a custom table storing value to display in Debug Variable

    51

Table Panel grid

    52

"""

    53

   103

   104

    def RefreshValues(self, grid):

   105

        for col in xrange(self.GetNumberCols()):

   106

            colname = self.GetColLabelValue(col, False)

   107

            if colname == "Value":

   108

                for row in xrange(self.GetNumberRows()):

   109

                    grid.SetCellValue(row, col, str(self.data[row].GetValue()))

   110

                    if self.IsForced(row):

   111

                        grid.SetCellTextColour(row, col, wx.BLUE)

   112

                    else:

   113

                        grid.SetCellTextColour(row, col, wx.BLACK)

   114

   115

    def AppendItem(self, item):

   116

        self.data.append(item)

   117

   118

    def InsertItem(self, idx, item):

   119

        self.data.insert(idx, item)

   120

   121

    def RemoveItem(self, item):

   122

        self.data.remove(item)

   130

   131

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

   132

#                  Debug Variable Table Panel Drop Target

   133

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

   134

   135

"""

   136

Class that implements a custom drop target class for Debug Variable Table Panel

   137

"""

   138

   142

        """

   143

        Constructor

   144

        @param window: Reference to the Debug Variable Panel

   145

        """

   150

        """

   151

        Destructor

   152

        """

   153

        # Remove reference to Debug Variable Panel

   157

        """

   158

        Function called when mouse is dragged over Drop Target

   159

        @param x: X coordinate of mouse pointer

   160

        @param y: Y coordinate of mouse pointer

   161

        @param data: Text associated to drag'n drop

   162

        """

   166

            if not isinstance(values, TupleType):

   167

                raise ValueError

   169

            message = _("Invalid value \"%s\" for debug variable") % data

   174

   175

        elif values[1] == "debug":

   177

   178

            # Get row where variable was dropped

   181

   182

            # If no row found add variable at table end

   185

   186

            # Add variable to table

   190

        """

   191

        Show error message in Error Dialog

   192

        @param message: Error message to display

   193

        """

   194

        dialog = wx.MessageDialog(self.ParentWindow, 

   195

                                  message, 

   196

                                  _("Error"), 

   197

                                  wx.OK|wx.ICON_ERROR)

   200

   201

   202

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

   203

#                       Debug Variable Table Panel

   204

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

   205

   206

"""

   207

Class that implements a panel displaying debug variable values in a table

   208

"""

   209

   213

        """

   214

        Constructor

   215

        @param parent: Reference to the parent wx.Window

   216

        @param producer: Object receiving debug value and dispatching them to

   217

        consumers

   218

        @param window: Reference to Beremiz frame

   219

        """

   222

        # Save Reference to Beremiz frame

   225

        # Variable storing flag indicating that variable displayed in table

   226

        # received new value and then table need to be refreshed

   231

        # Construction of window layout by creating controls and sizers

   232

   241

        # Creation of buttons for navigating in table

   242

   247

            button = wx.lib.buttons.GenBitmapButton(self, 

   248

                  bitmap=GetBitmap(bitmap), 

   254

        # Creation of grid and associated table

   255

   256

        self.VariablesGrid = CustomGrid(self, 

   257

                size=wx.Size(-1, 150), style=wx.VSCROLL)

   258

        # Define grid drop target

   266

        self.Table = DebugVariableTable(self, [], 

   267

                GetDebugVariablesTableColnames())

   272

   273

        # Definition of function associated to navigation buttons

   274

   282

            self.Table.RemoveItem(item)

   294

        # Initialization of grid layout

   295

   312

        """

   313

        Called to refresh Table according to values received by variables

   314

        Can receive any parameters (not used here)

   315

        """

   316

        # Refresh 'Value' column of table if new data have been received since

   317

        # last refresh

   324

        """

   325

        Function refreshing table layout and values

   326

        @param only_values: True if only 'Value' column need to be updated

   327

        """

   328

        # Block refresh until table layout and values are completely updated

   331

        # Update only 'value' column from table 

   333

            self.Table.RefreshValues(self.VariablesGrid)

   334

   335

        # Update complete table layout refreshing table navigation buttons

   336

        # state according to 

   339

            self.VariablesGrid.RefreshButtons()

   340

   341

        self.Thaw()

   342

   343

    def ResetView(self):

   344

        """

   345

        Function removing all variables denugged from table

   346

        @param only_values: True if only 'Value' column need to be updated

   347

        """

   348

        # Unsubscribe all variables debugged

   349

        self.UnsubscribeAllDataConsumers()

   350

   351

        # Clear table content

   352

        self.Table.Empty()

   353

   354

        # Update table layout

   355

        self.Freeze()

   356

        self.Table.ResetView(self.VariablesGrid)

   359

   360

    def SubscribeAllDataConsumers(self):

   361

        """

   362

        Function refreshing table layout and values

   363

        @param only_values: True if only 'Value' column need to be updated

   364

        """

   365

        DebugViewer.SubscribeAllDataConsumers(self)

   366

   367

        # Navigate through variable displayed in table, removing those that

   368

        # doesn't exist anymore in PLC

   369

        for item in self.Table.GetData()[:]:

   377

   378

        # Update table layout

   384

    def GetForceVariableMenuFunction(self, item):

   385

        """

   386

        Function returning callback function for contextual menu 'Force' item

   387

        @param item: Debug Variable item where contextual menu was opened 

   388

        @return: Callback function

   389

        """

   391

            # Get variable path and data type

   392

            iec_path = item.GetVariable()

   393

            iec_type = self.GetDataType(iec_path)

   394

   395

            # Return immediately if not data type found

   396

            if iec_type is None:

   397

                return

   398

   399

            # Open dialog for entering value to force variable

   400

            dialog = ForceVariableDialog(self, iec_type, str(item.GetValue()))

   401

   402

            # If valid value entered, force variable

   403

            if dialog.ShowModal() == wx.ID_OK:

   404

                self.ForceDataValue(iec_path.upper(), dialog.GetValue())

   405

   409

        """

   410

        Function returning callback function for contextual menu 'Release' item

   411

        @param iec_path: Debug Variable path where contextual menu was opened

   412

        @return: Callback function

   413

        """

   415

            # Release variable

   420

        """

   421

        Called when left mouse button is pressed on a table cell

   422

        @param event: wx.grid.GridEvent

   423

        """

   424

        # Initiate a drag and drop if the cell clicked was in 'Variable' column

   425

        if self.Table.GetColLabelValue(event.GetCol(), False) == "Variable":

   426

            item = self.Table.GetItem(event.GetRow())

   427

            data = wx.TextDataObject(str((item.GetVariable(), "debug")))

   431

   435

        """

   436

        Called when right mouse button is pressed on a table cell

   437

        @param event: wx.grid.GridEvent

   438

        """

   439

        # Open a contextual menu if the cell clicked was in 'Value' column

   440

        if self.Table.GetColLabelValue(event.GetCol(), False) == "Value":

   441

            row = event.GetRow()

   442

   443

            # Get variable path

   444

            item = self.Table.GetItem(row)

   445

            iec_path = item.GetVariable().upper()

   446

   447

            # Create contextual menu

   450

            # Add menu items

   451

            for text, enable, callback in [

   452

                (_("Force value"), True,

   453

                 self.GetForceVariableMenuFunction(item)),

   454

                # Release menu item is enabled only if variable is forced 

   455

                (_("Release value"), self.Table.IsForced(row),

   456

                 self.GetReleaseVariableMenuFunction(iec_path))]:

   457

   458

                new_id = wx.NewId()

   459

                menu.Append(help='', id=new_id, kind=wx.ITEM_NORMAL, text=text)

   460

                menu.Enable(new_id, enable)

   461

                self.Bind(wx.EVT_MENU, callback, id=new_id)

   462

   463

            # Popup contextual menu

   469

    def InsertValue(self, iec_path, index=None, force=False):

   470

        """

   471

        Insert a new variable to debug in table

   472

        @param iec_path: Variable path to debug

   473

        @param index: Row where insert the variable in table (default None,

   474

        insert at last position)

   475

        @param force: Force insertion of variable even if not defined in

   476

        producer side

   477

        """

   478

        # Return immediately if variable is already debugged

   482

   483

        # Insert at last position if index not defined

   484

        if index is None:

   485

            index = self.Table.GetNumberRows()

   486

   487

        # Subscribe variable to producer

   490

   491

        # Insert variable in table if subscription done or insertion forced

   493

            self.Table.InsertItem(index, item)