Package Pmv :: Module grid3DCommands :: Class readAnyGrid
[hide private]
[frames] | no frames]

Class readAnyGrid

source code

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

The readAnyGrid reads any of the grids supported by Volume.IO and
saves Grid3D object in self.vf.grids3D[gridFile] where gridFile can be provided
by Grid3D-->Read GUI
   
Package : Pmv
   
Module  : grid3DCommands
   
Class   : readAnyGrid
   
Command : readAnyGrid
   
Synopsis:

        grid3D<-readAnyGrid(gridFile)

    
Required Arguments:
    
        gridFile  : location of the grid file

    



Instance Methods [hide private]
  __init__(self, func=None)
  onAddCmdToViewer(self)
method called when an instance of this command is added to the viewer.
  __call__(self, gridFile, **kw)
Grid3D object<-readAnyGrid(gridFile)...
  doit(self, gridFile, name=None, show=True, normalize=True)
Reads gridFile and adds it to Control Panel...
  askMapType(self)
Opens Select Map Type widget
  guiCallback(self, parent=None)
called each time the 'Grid3D -> Import...' sequence is pressed

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, 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__

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, gridFile, **kw)
(Call operator)

source code 
Grid3D object<-readAnyGrid(gridFile)

           
Required Arguments:
    
                gridFile  : location of the grid file

        

Overrides: ViewerFramework.VFCommand.Command.__call__

doit(self, gridFile, name=None, show=True, normalize=True)

source code 
Reads gridFile and adds it to Control Panel
Optoinal Arguments:
  name    : name of the grid file used as a key in self.vf.grid3d
            if None os.path.basename(gridFile) is used
  show    : if True show Control panel
normalize : if true calls Normalize the Viewer

Overrides: ViewerFramework.VFCommand.Command.doit

askMapType(self)

source code 
Opens Select Map Type widget

guiCallback(self, parent=None)

source code 
called each time the 'Grid3D -> Import...' sequence is pressed
Overrides: mvCommand.MVCommand.guiCallback