1

#!/usr/bin/env python

     2

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

     3

     4

# This file is part of Beremiz, a Integrated Development Environment for

     5

# programming IEC 61131-3 automates supporting plcopen standard and CanFestival.

     6

#

     7

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

     8

#

     9

# See COPYING file for copyrights details.

    10

#

    11

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

    12

# modify it under the terms of the GNU General Public License

    13

# as published by the Free Software Foundation; either version 2

    14

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

    15

#

    16

# This program 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

    19

# GNU General Public License for more details.

    20

#

    21

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

    22

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

    23

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

    24

    25

import wx

    26

    27

from graphics.GraphicCommons import LEFTRAIL, RIGHTRAIL, LD_LINE_SIZE

    28

from graphics.LD_Objects import LD_PowerRail

    29

from BlockPreviewDialog import BlockPreviewDialog

    30

    31

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

    32

#                    Set Ladder Power Rail Parameters Dialog

    33

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

    34

    35

"""

    36

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

    37

element

    38

"""

    39

    40

class LDPowerRailDialog(BlockPreviewDialog):

    41

    42

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

    43

        """

    44

        Constructor

    45

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

    46

        @param controller: Reference to project controller

    47

        @param tagname: Tagname of project POU edited

    48

        """

    49

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

    50

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

    51

    52

        # Init common sizers

    53

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

    54

    55

        # Create label for connection type

    56

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

    57

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

    58

    59

        # Create radio buttons for selecting power rail type

    60

        self.TypeRadioButtons = {}

    61

        first = True

    62

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

    63

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

    64

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

    65

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

    66

            radio_button.SetValue(first)

    67

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

    68

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

    69

            self.TypeRadioButtons[type] = radio_button

    70

            first = False

    71

    72

        # Create label for power rail pin number

    73

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

    74

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

    75

    76

        # Create spin control for defining power rail pin number

    77

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

    78

              style=wx.SP_ARROW_KEYS)

    79

        self.PinNumber.SetValue(1)

    80

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

    81

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

    82

    83

        # Add preview panel and associated label to sizers

    84

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

    85

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

    86

    87

        # Add buttons sizer to sizers

    88

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

    89

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

    90

    91

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

    92

        self.TypeRadioButtons[LEFTRAIL].SetFocus()

    93

    94

    def GetMinElementSize(self):

    95

        """

    96

        Get minimal graphic element size

    97

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

    98

        element defined

    99

        """

   100

        return self.Element.GetMinSize(True)

   101

   102

    def GetPowerRailType(self):

   103

        """

   104

        Return type selected for power rail

   105

        @return: Type selected (LEFTRAIL or RIGHTRAIL)

   106

        """

   107

        return (LEFTRAIL

   108

                if self.TypeRadioButtons[LEFTRAIL].GetValue()

   109

                else RIGHTRAIL)

   110

   111

    def SetValues(self, values):

   112

        """

   113

        Set default power rail parameters

   114

        @param values: Power rail parameters values

   115

        """

   116

        # For each parameters defined, set corresponding control value

   117

        for name, value in values.items():

   118

   119

            # Parameter is power rail type

   120

            if name == "type":

   121

                self.TypeRadioButtons[value].SetValue(True)

   122

   123

            # Parameter is power rail pin number

   124

            elif name == "pin_number":

   125

                self.PinNumber.SetValue(value)

   126

   127

    def GetValues(self):

   128

        """

   129

        Return power rail parameters defined in dialog

   130

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

   131

        """

   132

        values = {

   133

            "type": self.GetPowerRailType(),

   134

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

   135

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

   136

        return values

   137

   138

    def OnTypeChanged(self, event):

   139

        """

   140

        Called when power rail type changed

   141

        @param event: wx.RadioButtonEvent

   142

        """

   143

        self.RefreshPreview()

   144

        event.Skip()

   145

   146

    def OnPinNumberChanged(self, event):

   147

        """

   148

        Called when power rail pin number value changed

   149

        @param event: wx.SpinEvent

   150

        """

   151

        self.RefreshPreview()

   152

        event.Skip()

   153

   154

    def RefreshPreview(self):

   155

        """

   156

        Refresh preview panel of graphic element

   157

        Override BlockPreviewDialog function

   158

        """

   159

   160

        # Set graphic element displayed, creating a power rail element

   161

        self.Element = LD_PowerRail(self.Preview, 

   162

                self.GetPowerRailType(), 

   163

                connectors = self.PinNumber.GetValue())

   164

   165

        # Call BlockPreviewDialog function

   166

        BlockPreviewDialog.RefreshPreview(self)