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

    27

from __future__ import absolute_import

    28

import wx

    29

    30

from graphics.GraphicCommons import LEFTRAIL, RIGHTRAIL

    31

from graphics.LD_Objects import LD_PowerRail

    32

from dialogs.BlockPreviewDialog import BlockPreviewDialog

    33

    34

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

    35

#                    Set Ladder Power Rail Parameters Dialog

    36

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

    37

    38

    39

class LDPowerRailDialog(BlockPreviewDialog):

    40

    """

    41

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

    42

    element

    43

    """

    44

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

    45

        """

    46

        Constructor

    47

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

    48

        @param controller: Reference to project controller

    49

        @param tagname: Tagname of project POU edited

    50

        """

    51

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

    52

                                    title=_('Power Rail Properties'))

    53

    54

        # Init common sizers

    55

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

    56

    57

        # Create label for connection type

    58

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

    59

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

    60

    61

        # Create radio buttons for selecting power rail type

    62

        self.TypeRadioButtons = {}

    63

        first = True

    64

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

    65

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

    66

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

    67

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

    68

            radio_button.SetValue(first)

    69

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

    70

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

    71

            self.TypeRadioButtons[type] = radio_button

    72

            first = False

    73

    74

        # Create label for power rail pin number

    75

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

    76

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

    77

    78

        # Create spin control for defining power rail pin number

    79

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

    80

                                     style=wx.SP_ARROW_KEYS)

    81

        self.PinNumber.SetValue(1)

    82

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

    83

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

    84

    85

        # Add preview panel and associated label to sizers

    86

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

    87

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

    88

    89

        # Add buttons sizer to sizers

    90

        self.MainSizer.AddSizer(

    91

            self.ButtonSizer, border=20,

    92

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

    93

        self.Fit()

    94

    95

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

    96

        self.TypeRadioButtons[LEFTRAIL].SetFocus()

    97

    98

    def GetMinElementSize(self):

    99

        """

   100

        Get minimal graphic element size

   101

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

   102

        element defined

   103

        """

   104

        return self.Element.GetMinSize(True)

   105

   106

    def GetPowerRailType(self):

   107

        """

   108

        Return type selected for power rail

   109

        @return: Type selected (LEFTRAIL or RIGHTRAIL)

   110

        """

   111

        return (LEFTRAIL

   112

                if self.TypeRadioButtons[LEFTRAIL].GetValue()

   113

                else RIGHTRAIL)

   114

   115

    def SetValues(self, values):

   116

        """

   117

        Set default power rail parameters

   118

        @param values: Power rail parameters values

   119

        """

   120

        # For each parameters defined, set corresponding control value

   121

        for name, value in values.items():

   122

   123

            # Parameter is power rail type

   124

            if name == "type":

   125

                self.TypeRadioButtons[value].SetValue(True)

   126

   127

            # Parameter is power rail pin number

   128

            elif name == "pin_number":

   129

                self.PinNumber.SetValue(value)

   130

   131

    def GetValues(self):

   132

        """

   133

        Return power rail parameters defined in dialog

   134

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

   135

        """

   136

        values = {

   137

            "type": self.GetPowerRailType(),

   138

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

   139

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

   140

        return values

   141

   142

    def OnTypeChanged(self, event):

   143

        """

   144

        Called when power rail type changed

   145

        @param event: wx.RadioButtonEvent

   146

        """

   147

        self.RefreshPreview()

   148

        event.Skip()

   149

   150

    def OnPinNumberChanged(self, event):

   151

        """

   152

        Called when power rail pin number value changed

   153

        @param event: wx.SpinEvent

   154

        """

   155

        self.RefreshPreview()

   156

        event.Skip()

   157

   158

    def RefreshPreview(self):

   159

        """

   160

        Refresh preview panel of graphic element

   161

        Override BlockPreviewDialog function

   162

        """

   163

   164

        # Set graphic element displayed, creating a power rail element

   165

        self.Element = LD_PowerRail(self.Preview,

   166

                                    self.GetPowerRailType(),

   167

                                    connectors=self.PinNumber.GetValue())

   168

   169

        # Call BlockPreviewDialog function

   170

        BlockPreviewDialog.RefreshPreview(self)