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

This class represents a GRIBGrid that is stored in a RegribMany object. More...

Detailed Description

This class represents a GRIBGrid that is stored in a RegribMany object.

It is able to check for readiness via RegribMany.is_ready and produce a result via RegribMany.make.

Definition at line 1212 of file regrib.py.

Inheritance diagram for hwrf.regrib.GRIBGridFetcher:
hwrf.regrib.GRIBGridBase hwrf.regrib.GRIBBase

Public Member Functions

def __init__ (self, name)
 GRIBGridFetcher constructor. More...
 
def is_ready (self, args, kwargs)
 Calls kwargs['regribmany'].has_data to see if the specified operation has produced its grid. More...
 
def input_valid (self, kwargs)
 Calls kwargs['regribmany'].input_valid to see if the specified kwargs make a valid input to the operation. More...
 
def make (self, args, kwargs)
 Calls kwargs['regribmany'].make to produce the grid. 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...
 

Constructor & Destructor Documentation

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

GRIBGridFetcher constructor.

Parameters
nameThe name of the grid that is fetched. This is used to generate temporary filenames and is used in RegribMany for the generator name.

Definition at line 1216 of file regrib.py.

Member Function Documentation

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

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

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

Definition at line 1231 of file regrib.py.

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

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

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

Definition at line 1222 of file regrib.py.

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

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

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 1240 of file regrib.py.


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