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

This class grabs a GRIBSubsetter from a RegribMany object. More...

Detailed Description

This class grabs a GRIBSubsetter from a RegribMany object.

Definition at line 1429 of file regrib.py.

Inheritance diagram for hwrf.regrib.GRIBSubsetterFetcher:
hwrf.regrib.GRIBSubsetter hwrf.regrib.GRIBBase

Public Member Functions

def __init__ (self, name)
 GRIBSubsetterFetcher constructor. More...
 
def input_valid (self, kwargs)
 Calls kwargs['regribmany'].input_valid to see if the kwargs make a valid input. More...
 
def is_ready (self, args, kwargs)
 Calls kwargs['regribmany'].has_data to see if the operation has produced its subsetter yet. More...
 
def make (self, args, kwargs)
 Calls kwargs['regribmany'].make to produce the subsetter. More...
 
- Public Member Functions inherited from hwrf.regrib.GRIBSubsetter
def __init__
 GRIBSubsetter constructor. More...
 
def is_ready (self, args, kwargs)
 Returns True. More...
 
def input_valid (self, kwargs)
 Returns True. More...
 
def make (self, args, kwargs)
 Returns self. More...
 
def getsubsetname (self)
 Returns a name of this subset for use in filenames. More...
 
def getgrib1sub (self)
 Returns an iterator that takes as its only argument an array of lines of wgrib -s output. More...
 
def getgrib2sub (self)
 This is a placeholder for future GRIB2 subsetting support. 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.GRIBSubsetter
 subsetname
 Read-only property: the name of the subset. More...
 
 grib1sub
 Read-only property: a callable object that chooses the fields to keep and their order. More...
 
 grib2sub
 Unused: the grib2 subsetter. More...
 

Constructor & Destructor Documentation

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

GRIBSubsetterFetcher constructor.

Parameters
namethe name of the subset

Definition at line 1431 of file regrib.py.

Member Function Documentation

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

Calls kwargs['regribmany'].input_valid to see if the kwargs make a valid input.

Parameters
kwargsContains a regribmany key mapping to a RegribMany object

Definition at line 1435 of file regrib.py.

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

Calls kwargs['regribmany'].has_data to see if the operation has produced its subsetter yet.

Parameters
kwargsContains a regribmany key mapping to a RegribMany object. Is also passed to has_data
argsAdditional positional arguments passed to has_data

Definition at line 1442 of file regrib.py.

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

Calls kwargs['regribmany'].make to produce the subsetter.

Parameters
args,kwargsPassed to source.make. The meaning is implementation-specific, but generally the kwargs are used for string replacement in an hwrf.config.HWRFConfig

Definition at line 1451 of file regrib.py.


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