27

from graphics.GraphicCommons import INPUT, INOUT, OUTPUT

    28

from graphics.FBD_Objects import FBD_Variable

    29

from BlockPreviewDialog import BlockPreviewDialog

    35

# Dictionaries containing correspondence between variable block class and string

    36

# to be shown in Class combo box in both sense

    44

#                        Set Variable Parameters Dialog

    47

"""

    48

Class that implements a dialog for defining parameters of a FBD variable graphic

    49

element

    50

"""

    51

    52

class FBDVariableDialog(BlockPreviewDialog):

    53

    54

    def __init__(self, parent, controller, tagname):

    55

        """

    56

        Constructor

    57

        @param parent: Parent wx.Window of dialog for modal

    58

        @param controller: Reference to project controller

    59

        @param tagname: Tagname of project POU edited

    60

        """

    61

        BlockPreviewDialog.__init__(self, parent, controller, tagname,

    64

        # Create dialog main sizer

    69

        # Create a sizer for dividing FBD variable parameters in two columns

    74

        # Create a sizer for left column

    80

        # Create label for variable class

    84

        # Create a combo box for defining variable class

    89

        # Create label for variable execution order

    90

        execution_order_label = wx.StaticText(self, 

    91

              label=_('Execution Order:'))

    94

        # Create spin control for defining variable execution order

    96

        self.Bind(wx.EVT_SPINCTRL, self.OnExecutionOrderChanged, 

    97

                  self.ExecutionOrder)

   100

        # Create a sizer for right column

   107

        # Create label for variable expression

   111

        # Create text control for defining variable expression

   116

        # Create a list box to selected variable expression in the list of

   117

        # variables defined in POU

   123

        # Add preview panel and associated label to sizers

   124

        main_sizer.AddWindow(self.PreviewLabel, border=20,

   129

        # Add buttons sizer to sizers

   130

        main_sizer.AddSizer(self.ButtonSizer, border=20, 

   135

        # Set options that can be selected in class combo box

   139

   140

        # Get list of variables defined in POU

   141

        self.VarList = {

   142

            var["Name"]: (var["Class"], var["Type"])

   143

            for var in self.Controller.GetEditedElementInterfaceVars(

   144

                                                        self.TagName)

   145

            if var["Edit"]}

   146

   147

        # Add POU name to variable list if POU is a function 

   148

        returntype = self.Controller.GetEditedElementInterfaceReturnType(

   149

                                                            self.TagName)

   150

        if returntype is not None:

   151

            self.VarList[

   152

                self.Controller.GetEditedElementName(self.TagName)] = \

   153

                 ("Output", returntype)

   154

   155

        # Add POU name if POU is a transition

   156

        words = tagname.split("::")

   157

        if words[0] == "T":

   158

            self.VarList[words[2]] = ("Output", "BOOL")

   159

   160

        # Refresh values in name list box

   162

   163

        # Class combo box is default control having keyboard focus

   167

        """

   168

        Called to refresh names in name list box

   169

        """

   170

        # Get variable class to select POU variable applicable

   171

        var_class = VARIABLE_CLASSES_DICT_REVERSE[

   172

                            self.Class.GetStringSelection()]

   173

   174

        # Refresh names in name list box by selecting variables in POU variables

   175

        # list that can be applied to variable class

   177

        for name, (var_type, value_type) in self.VarList.iteritems():

   180

   181

        # Get variable expression and select corresponding value in name list

   182

        # box if it exists

   183

        selected = self.Expression.GetValue()

   184

        if (selected != "" and 

   185

            self.VariableName.FindString(selected) != wx.NOT_FOUND):

   189

   190

        # Disable name list box if no name present inside

   194

        """

   195

        Set default variable parameters

   196

        @param values: Variable parameters values

   197

        """

   198

   199

        # Get class parameter value

   200

        var_class = values.get("class", None)

   201

        if var_class is not None:

   202

            # Set class selected in class combo box

   203

            self.Class.SetStringSelection(VARIABLE_CLASSES_DICT[var_class])

   204

            # Refresh names in name list box according to var class

   206

   207

        # For each parameters defined, set corresponding control value

   208

        for name, value in values.items():

   209

   210

            # Parameter is variable expression

   211

            if name == "expression":

   212

                # Set expression text control value

   213

                self.Expression.ChangeValue(value)

   214

                # Select corresponding text in name list box if it exists

   215

                if self.VariableName.FindString(value) != wx.NOT_FOUND:

   216

                    self.VariableName.SetStringSelection(value)

   217

                else:

   218

                    self.VariableName.SetSelection(wx.NOT_FOUND)

   219

   220

            # Parameter is variable execution order

   221

            elif name == "executionOrder":

   222

                self.ExecutionOrder.SetValue(value)

   223

   224

        # Refresh preview panel

   228

        """

   229

        Return block parameters defined in dialog

   230

        @return: {parameter_name: parameter_value,...}

   231

        """

   232

        expression = self.Expression.GetValue()

   233

        values = {

   234

            "class": VARIABLE_CLASSES_DICT_REVERSE[

   235

                        self.Class.GetStringSelection()],

   236

            "expression": expression,

   237

            "var_type": self.VarList.get(expression, (None, None))[1],

   238

            "executionOrder": self.ExecutionOrder.GetValue()}

   239

        values["width"], values["height"] = self.Element.GetSize()

   243

        """

   244

        Called when dialog OK button is pressed

   245

        Test if parameters defined are valid

   246

        @param event: wx.Event from OK button

   247

        """

   249

   250

        # Test that an expression have been selected or typed by user

   254

   255

        # Show error message if an error is detected

   257

            self.ShowErrorMessage(message)

   258

   260

            # Call BlockPreviewDialog function

   261

            BlockPreviewDialog.OnOK(self, event)

   264

        """

   265

        Called when variable class value changed

   266

        @param event: wx.ComboBoxEvent

   267

        """

   268

        # Refresh name list box values

   270

   275

        """

   276

        Called when name selected in name list box changed

   277

        @param event: wx.ListBoxEvent

   278

        """

   279

        # Change expression test control value to the value selected in name

   280

        # list box if value selected is valid

   281

        if self.VariableName.GetSelection() != wx.NOT_FOUND:

   282

            self.Expression.ChangeValue(self.VariableName.GetStringSelection())

   283

   288

        """

   289

        Called when expression text control is changed by user

   290

        @param event: wx.ListBoxEvent

   291

        """

   292

        # Select the corresponding value in name list box if it exists

   294

            self.VariableName.FindString(self.Expression.GetValue()))

   295

   300

        """

   301

        Called when block execution control value changed

   302

        @param event: wx.SpinEvent

   303

        """

   308

        """

   309

        Refresh preview panel of graphic element

   310

        Override BlockPreviewDialog function

   311

        """

   312

        # Get expression value to put in FBD variable element

   314

   315

        # Set graphic element displayed, creating a FBD variable element

   316

        self.Element = FBD_Variable(self.Preview, 

   317

                    VARIABLE_CLASSES_DICT_REVERSE[

   318

                        self.Class.GetStringSelection()], 

   319

                    name, 

   320

                    self.VarList.get(name, ("", ""))[1], 

   321

                    executionOrder = self.ExecutionOrder.GetValue())

   322

   323

        # Call BlockPreviewDialog function

   324

        BlockPreviewDialog.RefreshPreview(self)

   325

   326