Package Pmv :: Module hbondCommands :: Class AddHBondCommandGUICommand
[hide private]
[frames] | no frames]

Class AddHBondCommandGUICommand

source code

 ViewerFramework.VFCommand.Command --+    
                                     |    
                   mvCommand.MVCommand --+
                                         |
ViewerFramework.VFCommand.ICOM --+       |
                                 |       |
                  mvCommand.MVICOM --+   |
                                     |   |
                  mvCommand.MVAtomICOM --+
                                         |
                                        AddHBondCommandGUICommand

GUI command wrapper for AddHBondCommand which allows user to add hbonds between selected atoms. Hydrogen bonds are built assuming user picked hydrogen atom (or donor atom if there is no hydrogen atom) first followed by the acceptor atom.
   
Package : Pmv
   
Module  : hbondCommands
   
Class   : AddHBondCommandGUICommand
   
Command : addHBondGC
   
Synopsis:
 
        None<---addHBondGC(atoms)
   
Required Arguments:
     
        atoms ---  atom(s)
    



Instance Methods [hide private]
  __init__(self, func=None)
  onRemoveObjectFromViewer(self, obj)
  onAddCmdToViewer(self)
method called when an instance of this command is added to the viewer.
  __call__(self, atoms, **kw)
None<-addHBondGC(atoms)
  doit(self, ats)
virtual method.
  setupUndoAfter(self, ats, **kw)
A chance to modify self.undoCmds after the command was carried out
  update(self, event=None)
  guiCallback(self, event=None)
Default callback function called by the gui
  startICOM(self)
gets called every time this command is about to be run becuase of a picking event.

Inherited from mvCommand.MVCommand: strArg

Inherited from mvCommand.MVCommand (private): _strArg

Inherited from ViewerFramework.VFCommand.Command: __repr__, addCallbackAfter, addCallbackBefore, addUndoCall, afterDoit, beforeDoit, buildFormDescr, buildLogArgList, checkDependencies, cleanup, customizeGUI, doitWrapper, getArguments, getHelp, getLastUsedValues, getLogArgs, getValNamedArgs, log, logString, onAddNewCmd, onCmdRun, setLastUsedValues, setupUndoBefore, showForm, tkCb, updateGeom, warningMsg

Inherited from mvCommand.MVAtomICOM: getObjects

Inherited from ViewerFramework.VFCommand.ICOM: initICOM, stopICOM


Class Variables [hide private]

Inherited from ViewerFramework.VFCommand.Command: negateKw, objArgOnly


Method Details [hide private]

__init__(self, func=None)
(Constructor)

source code 
None
Overrides: mvCommand.MVCommand.__init__

onRemoveObjectFromViewer(self, obj)

source code 
None

onAddCmdToViewer(self)

source code 
method called when an instance of this command is added to the viewer. This enable viewer-addition time initializations
Overrides: ViewerFramework.VFCommand.Command.onAddCmdToViewer
(inherited documentation)

__call__(self, atoms, **kw)
(Call operator)

source code 

None<-addHBondGC(atoms)

atoms : atom(s)
Overrides: ViewerFramework.VFCommand.Command.__call__

doit(self, ats)

source code 
virtual method. Has to be implemented by the sub classes
Overrides: ViewerFramework.VFCommand.Command.doit
(inherited documentation)

setupUndoAfter(self, ats, **kw)

source code 
A chance to modify self.undoCmds after the command was carried out
Overrides: ViewerFramework.VFCommand.Command.setupUndoAfter
(inherited documentation)

update(self, event=None)

source code 
None

guiCallback(self, event=None)

source code 
Default callback function called by the gui
Overrides: mvCommand.MVCommand.guiCallback

startICOM(self)

source code 
gets called every time this command is about to be run becuase of a picking event. It is called just before the Pick is converted into objects.
Overrides: ViewerFramework.VFCommand.ICOM.startICOM
(inherited documentation)