1

# -*- coding: utf-8 -*-

     2

     3

#This file is part of PLCOpenEditor, a library implementing an IEC 61131-3 editor

     4

#based on the plcopen standard. 

     5

#

     6

#Copyright (C) 2007: Edouard TISSERANT and Laurent BESSARD

     7

#

     8

#See COPYING file for copyrights details.

     9

#

    10

#This library is free software; you can redistribute it and/or

    11

#modify it under the terms of the GNU General Public

    12

#License as published by the Free Software Foundation; either

    13

#version 2.1 of the License, or (at your option) any later version.

    14

#

    15

#This library is distributed in the hope that it will be useful,

    16

#but WITHOUT ANY WARRANTY; without even the implied warranty of

    17

#MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

    18

#General Public License for more details.

    19

#

    20

#You should have received a copy of the GNU General Public

    21

#License along with this library; if not, write to the Free Software

    22

#Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

    23

    24

import wx

    25

    26

from graphics.GraphicCommons import LEFTRAIL, RIGHTRAIL, LD_LINE_SIZE

    27

from graphics.LD_Objects import LD_PowerRail

    28

from BlockPreviewDialog import BlockPreviewDialog

    29

    30

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

    31

#                    Set Ladder Power Rail Parameters Dialog

    32

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

    33

    34

"""

    35

Class that implements a dialog for defining parameters of a power rail graphic

    36

element

    37

"""

    38

    39

class LDPowerRailDialog(BlockPreviewDialog):

    40

    41

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

    42

        """

    43

        Constructor

    44

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

    45

        @param controller: Reference to project controller

    46

        @param tagname: Tagname of project POU edited

    47

        """

    48

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

    49

              size=wx.Size(350, 260), title=_('Power Rail Properties'))

    50

    51

        # Init common sizers

    52

        self._init_sizers(2, 0, 5, None, 2, 1)

    53

    54

        # Create label for connection type

    55

        type_label = wx.StaticText(self, label=_('Type:'))

    56

        self.LeftGridSizer.AddWindow(type_label, flag=wx.GROW)

    57

    58

        # Create radio buttons for selecting power rail type

    59

        self.TypeRadioButtons = {}

    60

        first = True

    61

        for type, label in [(LEFTRAIL, _('Left PowerRail')),

    62

                            (RIGHTRAIL, _('Right PowerRail'))]:

    63

            radio_button = wx.RadioButton(self, label=label, 

    64

                  style=(wx.RB_GROUP if first else 0))

    65

            radio_button.SetValue(first)

    66

            self.Bind(wx.EVT_RADIOBUTTON, self.OnTypeChanged, radio_button)

    67

            self.LeftGridSizer.AddWindow(radio_button, flag=wx.GROW)

    68

            self.TypeRadioButtons[type] = radio_button

    69

            first = False

    70

    71

        # Create label for power rail pin number

    72

        pin_number_label = wx.StaticText(self, label=_('Pin number:'))

    73

        self.LeftGridSizer.AddWindow(pin_number_label, flag=wx.GROW)

    74

    75

        # Create spin control for defining power rail pin number

    76

        self.PinNumber = wx.SpinCtrl(self, min=1, max=50,

    77

              style=wx.SP_ARROW_KEYS)

    79

        self.Bind(wx.EVT_SPINCTRL, self.OnPinNumberChanged, self.PinNumber)

    80

        self.LeftGridSizer.AddWindow(self.PinNumber, flag=wx.GROW)

    81

    82

        # Add preview panel and associated label to sizers

    83

        self.RightGridSizer.AddWindow(self.PreviewLabel, flag=wx.GROW)

    84

        self.RightGridSizer.AddWindow(self.Preview, flag=wx.GROW)

    85

    86

        # Add buttons sizer to sizers

    87

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

    88

              flag=wx.ALIGN_RIGHT|wx.BOTTOM|wx.LEFT|wx.RIGHT)

    89

    90

        # Left Power Rail radio button is default control having keyboard focus

    91

        self.TypeRadioButtons[LEFTRAIL].SetFocus()

    92

    93

    def GetMinElementSize(self):

    94

        """

    95

        Get minimal graphic element size

    96

        @return: Tuple containing minimal size (width, height) or None if no

    97

        element defined

    98

        """

    99

        return self.Element.GetMinSize(True)

   100

   101

    def GetPowerRailType(self):

   102

        """

   103

        Return type selected for power rail

   104

        @return: Type selected (LEFTRAIL or RIGHTRAIL)

   105

        """

   106

        return (LEFTRAIL

   107

                if self.TypeRadioButtons[LEFTRAIL].GetValue()

   108

                else RIGHTRAIL)

   109

   110

    def SetValues(self, values):

   111

        """

   112

        Set default power rail parameters

   113

        @param values: Power rail parameters values

   114

        """

   115

        # For each parameters defined, set corresponding control value

   116

        for name, value in values.items():

   117

   118

            # Parameter is power rail type

   119

            if name == "type":

   120

                self.TypeRadioButtons[value].SetValue(True)

   121

   122

            # Parameter is power rail pin number

   123

            elif name == "pin_number":

   124

                self.PinNumber.SetValue(value)

   125

   126

    def GetValues(self):

   127

        """

   128

        Return power rail parameters defined in dialog

   129

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

   130

        """

   131

        values = {

   132

            "type": self.GetPowerRailType(),

   133

            "pin_number": self.PinNumber.GetValue()}

   134

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

   135

        return values

   136

   137

    def OnTypeChanged(self, event):

   138

        """

   139

        Called when power rail type changed

   140

        @param event: wx.RadioButtonEvent

   141

        """

   142

        self.RefreshPreview()

   143

        event.Skip()

   144

   145

    def OnPinNumberChanged(self, event):

   146

        """

   147

        Called when power rail pin number value changed

   148

        @param event: wx.SpinEvent

   149

        """

   150

        self.RefreshPreview()

   151

        event.Skip()

   152

   153

    def RefreshPreview(self):

   154

        """

   155

        Refresh preview panel of graphic element

   156

        Override BlockPreviewDialog function

   157

        """

   158

   159

        # Set graphic element displayed, creating a power rail element

   160

        self.Element = LD_PowerRail(self.Preview, 

   161

                self.GetPowerRailType(), 

   162

                connectors = self.PinNumber.GetValue())

   163

   164

        # Call BlockPreviewDialog function

   165

        BlockPreviewDialog.RefreshPreview(self)