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

This subclass of GRIBOp produces GRIB2 files, and can be converted to GRIB1 via obj*GRIB1 or obj.to_grib1(). More...

Detailed Description

This subclass of GRIBOp produces GRIB2 files, and can be converted to GRIB1 via obj*GRIB1 or obj.to_grib1().

Calls to obj.to_grib2() or obj*GRIB2 simply return self.

Definition at line 1527 of file regrib.py.

Inheritance diagram for hwrf.regrib.GRIB2Op:
hwrf.regrib.GRIBOp hwrf.regrib.GRIBBase hwrf.regrib.GRIB2File hwrf.regrib.GRIB2Product

Public Member Functions

def __init__ (self, action, args)
 GRIB2Op constructor. More...
 
def to_grib1 (self)
 Returns a GRIB2Op that converts this operation's output to GRIB1.
 
def to_grib2 (self)
 Returns self (converting GRIB2 to GRIB2 is a no-op)
 
def __mul__ (self, grid)
 If grid is the special constant GRIB1, this is the same as to_grib1(), if GRIB2, then returns self. 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.GRIB2Op.__init__ (   self,
  action,
  args 
)

GRIB2Op constructor.

Parameters
action,argsPassed to GRIBOp.__init__

Definition at line 1531 of file regrib.py.

Member Function Documentation

def hwrf.regrib.GRIB2Op.__mul__ (   self,
  grid 
)

If grid is the special constant GRIB1, this is the same as to_grib1(), if GRIB2, then returns self.

Otherwise, returns NotImplemented to indicate that GRIB2 regridding is not implemented yet.

Parameters
gridThe constant GRIB1, GRIB2, or a GRIBGrid

Definition at line 1541 of file regrib.py.


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