HWRF  trunk@4391
Public Member Functions | List of all members
hwrf.regrib.GRIB1Fetcher Class Reference

The GRIB1Fetcher is a GRIB1Op subclass that fetches a GRIB1 file from a RegribMany. More...

Detailed Description

The GRIB1Fetcher is a GRIB1Op subclass that fetches a GRIB1 file from a RegribMany.

Definition at line 1631 of file regrib.py.

Inheritance diagram for hwrf.regrib.GRIB1Fetcher:
hwrf.regrib.GRIB1Op hwrf.regrib.GRIBOp hwrf.regrib.GRIBBase

Public Member Functions

def __init__ (self, name)
 Creates a GRIB1Fetcher for the specified operation name. More...
 
def input_valid (self, kwargs)
 Calls kwargs['regribmany'].input_valid to determine if the specified keyword arguments make a valid input to the operation. More...
 
def is_ready (self, args, kwargs)
 Calls kwargs['regribmany'].has_data to see if there is cached output from the operation. More...
 
def make (self, args, kwargs)
 Calls kwargs['regribmany'].make to produce the operation's output. More...
 
- Public Member Functions inherited from hwrf.regrib.GRIB1Op
def __init__ (self, action, args)
 Creates a new GRIB1Op, passing all arguments to the superclass constructor. More...
 
def to_grib1 (self)
 Returns self. More...
 
def to_grib2 (self)
 Returns a GRIB2Op that will make a GRIB2 version of this operation's output. More...
 
def regridmerge (self, grid, other)
 Returns a GRIB1Op that will ask copygb to merge the other grid on top of this one. More...
 
def make_grbindex (self)
 Returns a GRIB1Op that will run grbindex and save the results, unless that has already been done. More...
 
def __div__ (self, subsetter)
 Returns a GRIB1Op that will subset this one using the specified subsetter. More...
 
def __mul__ (self, grid)
 If the grid is a GRIBGridBase, returns a GRIB1Op that will regrid this GRIB1Op's output to that grid. More...
 
def __add__ (self, other)
 If the argument is a GRIBOp, returns a GRIB1Op that will paste a GRIB1 version of that operations output onto this operation's output. More...
 
- Public Member Functions inherited from hwrf.regrib.GRIBOp
def __init__ (self, action, args)
 Creates a GRIBOp that has a number of child GRIBBase objects, with a specified action to perform in the GRIBOp.make method. More...
 
def getaction (self)
 Returns the action, a function or callable object. More...
 
def args (self)
 Iterates over all child GRIBBase objects. More...
 
def is_ready (self, args, kwargs)
 Returns the logical "and" of is_ready(*args,**kwargs) called on all subobjects. More...
 
def input_valid (self, kwargs)
 Returns the logical "and" of input_valid(**kwargs) called on all subobjects. More...
 
def make (self, regrib, kwargs)
 Runs the action specified in the constructor, providing as arguments regrib, and the result of running make on all of the other arguments sent to the constructor. More...
 
def __repr__ (self)
 A string representation of this GRIB operation. More...
 
- Public Member Functions inherited from hwrf.regrib.GRIBBase
def is_ready (self, args, kwargs)
 Returns True if this object and its subobjects are all ready for a call to make, and False otherwise. More...
 
def input_valid (self, kwargs)
 Returns True if the specified kwargs are valid and False otherwise. More...
 
def make (self, regrib, kwargs)
 Runs the action this object should perform and returns another GRIBBase object. More...
 

Additional Inherited Members

- Properties inherited from hwrf.regrib.GRIBOp
 action
 A read-only property: this objects action function. More...
 

Constructor & Destructor Documentation

def hwrf.regrib.GRIB1Fetcher.__init__ (   self,
  name 
)

Creates a GRIB1Fetcher for the specified operation name.

Parameters
namethe name of this operation for temporary filename generation

Definition at line 1634 of file regrib.py.

Member Function Documentation

def hwrf.regrib.GRIB1Fetcher.input_valid (   self,
  kwargs 
)

Calls kwargs['regribmany'].input_valid to determine if the specified keyword arguments make a valid input to the operation.

Parameters
kwargsContains a regribmany key mapping to a RegribMany object. Is also passed to source.input_valid

Definition at line 1639 of file regrib.py.

def hwrf.regrib.GRIB1Fetcher.is_ready (   self,
  args,
  kwargs 
)

Calls kwargs['regribmany'].has_data to see if there is cached output from the operation.

Parameters
kwargsContains a regribmany key mapping to a RegribMany object. Is also passed to source.has_data.
argsPositional arguments passed to source.has_data

Definition at line 1648 of file regrib.py.

def hwrf.regrib.GRIB1Fetcher.make (   self,
  args,
  kwargs 
)

Calls kwargs['regribmany'].make to produce the operation's output.

Parameters
kwargsContains a regribmany key mapping to a RegribMany object. Is also passed to source.make.
argsAdditional positional arguments are unused.

Definition at line 1657 of file regrib.py.


The documentation for this class was generated from the following file: