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

Class AddHBondCommand

source code

ViewerFramework.VFCommand.Command --+    
                                    |    
                  mvCommand.MVCommand --+
                                        |
                                       AddHBondCommand

AddHBondCommand allows user to add hydrogen bonds between pairs of atoms.
    
Package : Pmv
   
Module  : hbondCommands
   
Class   : AddHBondCommand
   
Command : addHBond
   
Synopsis:

        None<---addHBond(atom1, atom2)
   
Required Arguments:
       
        atom1 --- first atom

        atom2 --- second atom
    



Instance Methods [hide private]
  setupUndoBefore(self, atom1, atom2)
This method builds the self.undoCmds string.
  undo(self, atom1, atom2, **kw)
  __call__(self, atom1, atom2, **kw)
None<-addHBond(atom1, atom2)
  doit(self, at1, at2)
virtual method.

Inherited from mvCommand.MVCommand: __init__, guiCallback, 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, onAddCmdToViewer, onAddNewCmd, onCmdRun, setLastUsedValues, setupUndoAfter, showForm, tkCb, updateGeom, warningMsg


Class Variables [hide private]

Inherited from ViewerFramework.VFCommand.Command: negateKw, objArgOnly


Method Details [hide private]

setupUndoBefore(self, atom1, atom2)

source code 
This method builds the self.undoCmds string. This method should have the same signature than the __call__. When this string is executed it should undo the actions of this command. This string will be appended to the undoCmdStack list if the command is successfuly carried out. This method handles only commands with the negateKw. Other commands have to overwrite it.
Overrides: ViewerFramework.VFCommand.Command.setupUndoBefore
(inherited documentation)

undo(self, atom1, atom2, **kw)

source code 
None

__call__(self, atom1, atom2, **kw)
(Call operator)

source code 

None<-addHBond(atom1, atom2)

atom1 --- first atom

atom2 --- second atom
Overrides: ViewerFramework.VFCommand.Command.__call__

doit(self, at1, at2)

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