Package Pmv :: Module editCommands :: Class AssignAtomsRadiiCommand
[hide private]
[frames] | no frames]

Class AssignAtomsRadiiCommand

source code

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

This commands adds radii to all the atoms loaded so far in the application. Only default radii for now
    
Package:Pmv
    
Module :editCommands
    
Class:AssignAtomsRadiiCommand
    
Command:assignAtomsRadii
    
Synopsis:

    None <- mv.assignAtomsRadii(nodes, united=1, overwrite=1,**kw)

    
Required Arguments:

    nodes --- TreeNodeSet holding the current selection
    
Optional Arguments:

    
united   --- (default=1) flag to specify whether or not to consider
            hydrogen atoms. When hydrogen are there the atom radii
            is smaller. 

    overwrite ---(default=1) flag to specify whether or not to overwrite
            existing radii information.


    
    



Instance Methods [hide private]
  __init__(self, func=None)
  doit(self, nodes, united=True, overwrite=False)
virtual method.
  onAddObjectToViewer(self, obj)
  __call__(self, nodes, united=True, overwrite=False, **kw)
None <- mv.assignAtomsRadii(nodes, united=True, overwrite=False,**kw) Required Arguments: nodes --- TreeNodeSet holding the current selection Optional Arguments: united --- (default=True) Boolean flag to specify whether or not to consider hydrogen atoms.
  guiCallback(self)
Default callback function called by the gui

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, onAddCmdToViewer, onAddNewCmd, onCmdRun, setLastUsedValues, setupUndoAfter, setupUndoBefore, showForm, tkCb, updateGeom, warningMsg


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__

doit(self, nodes, united=True, overwrite=False)

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

onAddObjectToViewer(self, obj)

source code 
None

__call__(self, nodes, united=True, overwrite=False, **kw)
(Call operator)

source code 
None <- mv.assignAtomsRadii(nodes, united=True, overwrite=False,**kw)
        
Required Arguments:

         nodes --- TreeNodeSet holding the current selection 

         
Optional Arguments:

          united --- (default=True) Boolean flag to specify whether or not
                    to consider hydrogen atoms. When hydrogen are there the
                    atom radii is smaller.
 

          overwrite --- (default=True) Boolean flag to specify whether or not to overwrite
                    existing radii information.


        

Overrides: ViewerFramework.VFCommand.Command.__call__

guiCallback(self)

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