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

# Copyright (C) 2017: Andrey Skvortsov <andrej.skvortzov@gmail.com>

     9

#

    10

# See COPYING file for copyrights details.

    11

#

    12

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

    13

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

    14

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

    15

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

    16

#

    17

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

    18

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

    19

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    20

# GNU General Public License for more details.

    21

#

    22

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

    23

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

    24

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

    25

    26

import wx

    27

    28

from graphics.GraphicCommons import LEFTRAIL, RIGHTRAIL, LD_LINE_SIZE

    29

from graphics.LD_Objects import LD_PowerRail

    30

from BlockPreviewDialog import BlockPreviewDialog

    31

    32

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

    33

#                    Set Ladder Power Rail Parameters Dialog

    34

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

    35

    36

"""

    37

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

    38

element

    39

"""

    40

    41

class LDPowerRailDialog(BlockPreviewDialog):

    42

    43

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

    44

        """

    45

        Constructor

    46

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

    47

        @param controller: Reference to project controller

    48

        @param tagname: Tagname of project POU edited

    49

        """

    50

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

    51

              title=_('Power Rail Properties'))

    52

    53

        # Init common sizers

    54

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

    55

    56

        # Create label for connection type

    57

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

    58

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

    59

    60

        # Create radio buttons for selecting power rail type

    61

        self.TypeRadioButtons = {}

    62

        first = True

    63

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

    64

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

    65

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

    66

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

    67

            radio_button.SetValue(first)

    68

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

    69

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

    70

            self.TypeRadioButtons[type] = radio_button

    71

            first = False

    72

    73

        # Create label for power rail pin number

    74

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

    75

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

    76

    77

        # Create spin control for defining power rail pin number

    78

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

    79

              style=wx.SP_ARROW_KEYS)

    80

        self.PinNumber.SetValue(1)

    81

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

    82

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

    83

    84

        # Add preview panel and associated label to sizers

    85

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

    86

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

    87

    88

        # Add buttons sizer to sizers

    89

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

    90

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

    91

        self.Fit()

    92

    93

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

    94

        self.TypeRadioButtons[LEFTRAIL].SetFocus()

    95

    96

    def GetMinElementSize(self):

    97

        """

    98

        Get minimal graphic element size

    99

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

   100

        element defined

   101

        """

   102

        return self.Element.GetMinSize(True)

   103

   104

    def GetPowerRailType(self):

   105

        """

   106

        Return type selected for power rail

   107

        @return: Type selected (LEFTRAIL or RIGHTRAIL)

   108

        """

   109

        return (LEFTRAIL

   110

                if self.TypeRadioButtons[LEFTRAIL].GetValue()

   111

                else RIGHTRAIL)

   112

   113

    def SetValues(self, values):

   114

        """

   115

        Set default power rail parameters

   116

        @param values: Power rail parameters values

   117

        """

   118

        # For each parameters defined, set corresponding control value

   119

        for name, value in values.items():

   120

   121

            # Parameter is power rail type

   122

            if name == "type":

   123

                self.TypeRadioButtons[value].SetValue(True)

   124

   125

            # Parameter is power rail pin number

   126

            elif name == "pin_number":

   127

                self.PinNumber.SetValue(value)

   128

   129

    def GetValues(self):

   130

        """

   131

        Return power rail parameters defined in dialog

   132

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

   133

        """

   134

        values = {

   135

            "type": self.GetPowerRailType(),

   136

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

   137

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

   138

        return values

   139

   140

    def OnTypeChanged(self, event):

   141

        """

   142

        Called when power rail type changed

   143

        @param event: wx.RadioButtonEvent

   144

        """

   145

        self.RefreshPreview()

   146

        event.Skip()

   147

   148

    def OnPinNumberChanged(self, event):

   149

        """

   150

        Called when power rail pin number value changed

   151

        @param event: wx.SpinEvent

   152

        """

   153

        self.RefreshPreview()

   154

        event.Skip()

   155

   156

    def RefreshPreview(self):

   157

        """

   158

        Refresh preview panel of graphic element

   159

        Override BlockPreviewDialog function

   160

        """

   161

   162

        # Set graphic element displayed, creating a power rail element

   163

        self.Element = LD_PowerRail(self.Preview, 

   164

                self.GetPowerRailType(), 

   165

                connectors = self.PinNumber.GetValue())

   166

   167

        # Call BlockPreviewDialog function

   168

        BlockPreviewDialog.RefreshPreview(self)