Source code for ccpn.ui.gui.popups.SetupNmrResiduesPopup

"""
Module Documentation here
"""
#=========================================================================================
# Licence, Reference and Credits
#=========================================================================================
__copyright__ = "Copyright (C) CCPN project (http://www.ccpn.ac.uk) 2014 - 2021"
__credits__ = ("Ed Brooksbank, Joanna Fox, Victoria A Higman, Luca Mureddu, Eliza Płoskoń",
               "Timothy J Ragan, Brian O Smith, Gary S Thompson & Geerten W Vuister")
__licence__ = ("CCPN licence. See http://www.ccpn.ac.uk/v3-software/downloads/license")
__reference__ = ("Skinner, S.P., Fogh, R.H., Boucher, W., Ragan, T.J., Mureddu, L.G., & Vuister, G.W.",
                 "CcpNmr AnalysisAssign: a flexible platform for integrated NMR analysis",
                 "J.Biomol.Nmr (2016), 66, 111-124, http://doi.org/10.1007/s10858-016-0060-y")
#=========================================================================================
# Last code modification
#=========================================================================================
__modifiedBy__ = "$modifiedBy: Ed Brooksbank $"
__dateModified__ = "$dateModified: 2021-09-29 17:34:05 +0100 (Wed, September 29, 2021) $"
__version__ = "$Revision: 3.0.4 $"
#=========================================================================================
# Created
#=========================================================================================
__author__ = "$Author: rhfogh $"
__date__ = "$Date: 2017-04-07 10:28:41 +0000 (Fri, April 07, 2017) $"
#=========================================================================================
# Start of code
#=========================================================================================

from ccpn.ui.gui.widgets.CheckBox import CheckBox
from ccpn.ui.gui.widgets.Label import Label
from ccpn.ui.gui.widgets.PulldownList import PulldownList
from ccpn.ui.gui.popups.Dialog import CcpnDialogMainWidget
from ccpn.core.lib.ContextManagers import undoBlock
from ccpn.core.lib.AssignmentLib import _fetchNewPeakAssignments


class SetupNmrResiduesPopup(CcpnDialogMainWidget):
    """
    Dialog to handle creating new nmrAtoms for peaks that have not been assigned
    """
    _PEAKLIST = '_peakList'
    _NMRCHAIN = '_nmrChain'
    _ASSIGNMENT = '_assignment'

    def __init__(self, parent=None, mainWindow=None,
                 title='Set up nmrResidues', **kwds):
        """
        Initialise the dialog

        :param parent:
        :param mainWindow:
        :param title:
        :param kwds:
        """
        CcpnDialogMainWidget.__init__(self, parent, setLayout=True, windowTitle=title, **kwds)

        self._parent = parent
        self.mainWindow = mainWindow
        self.project = self.mainWindow.project

        self._setWidgets()

        self._acceptButtonText = 'Setup NMR Residues'
        self.BUTTON_CANCEL = 'Cancel'

        self.setOkButton(callback=self._setupNmrResidues, text=self._acceptButtonText, tipText='Setup Nmr Residues and close')
        self.setCancelButton(callback=self.reject, text=self.BUTTON_CANCEL, tipText='Cancel and close')
        self.setDefaultButton(CcpnDialogMainWidget.OKBUTTON)

        self.__postInit__()
        self._applyButton = self.getButton(self.OKBUTTON)
        self._applyButton.setEnabled(True)
        self._cancelButton = self.getButton(self.CANCELBUTTON)

        # use below if the popup does not need to close
        # self.assignmentCheckBox = CheckBox(self.mainWidget, text="Keep existing assignments", checked=True, grid=(1, 0), gridSpan=(1, 3))
        #
        # self._acceptButtonText = 'Apply'
        # self._buttonCancel = 'Close'
        #
        # self.setApplyButton(callback=self._setupNmrResidues, text=self._acceptButtonText, tipText='Setup Nmr Residues')
        # self.setCloseButton(callback=self.reject, text=self._buttonCancel, tipText='Close Dialog')
        # self.setDefaultButton(CcpnDialogMainWidget.CLOSEBUTTON)
        #
        # self.__postInit__()
        # self._applyButton = self.getButton(self.APPLYBUTTON)
        # self._applyButton.setEnabled(True)
        # self._cancelButton = self.getButton(self.CLOSEBUTTON)

    def _setWidgets(self):
        """Setup widgets for the dialog
        """
        label1a = Label(self.mainWidget, text="Source PeakList ", grid=(0, 0))
        self.peakListPulldown = PulldownList(self.mainWidget, grid=(0, 1))
        self.peakListPulldown.setData([peakList.pid for peakList in self.project.peakLists if len(peakList.peaks) > 0])
        label1a = Label(self.mainWidget, text="NmrChain ", grid=(0, 2))
        self.nmrChainPulldown = PulldownList(self.mainWidget, grid=(0, 3))
        self.nmrChainPulldown.setData([nmrChain.pid for nmrChain in self.project.nmrChains])
        self.assignmentCheckBox = CheckBox(self.mainWidget, text="Keep existing assignments", checked=True, grid=(1, 0), gridSpan=(1, 3))

    def _setupNmrResidues(self):
        with undoBlock():
            peakList = self.project.getByPid(self.peakListPulldown.currentText())
            nmrChain = self.project.getByPid(self.nmrChainPulldown.currentText())
            keepAssignments = self.assignmentCheckBox.isChecked()

            _fetchNewPeakAssignments(peakList, nmrChain, keepAssignments)

        # remove if popup does not need to close
        self.accept()

    def storeWidgetState(self):
        """Store the state of the checkBoxes between popups
        """
        SetupNmrResiduesPopup._storedState[self._PEAKLIST] = self.peakListPulldown.get()
        SetupNmrResiduesPopup._storedState[self._NMRCHAIN] = self.nmrChainPulldown.get()
        SetupNmrResiduesPopup._storedState[self._ASSIGNMENT] = self.assignmentCheckBox.isChecked()

    def restoreWidgetState(self):
        """Restore the state of the checkBoxes
        """
        self.peakListPulldown.set(SetupNmrResiduesPopup._storedState.get(self._PEAKLIST, False))
        self.nmrChainPulldown.set(SetupNmrResiduesPopup._storedState.get(self._NMRCHAIN, False))
        self.assignmentCheckBox.set(SetupNmrResiduesPopup._storedState.get(self._ASSIGNMENT, False))