hwrf.regrib.UpstreamGRIB1 Class Reference

This subclass of GRIB1Op and UpstreamFile represents a GRIB1 file that is produced by an upstream workflow. More...

Detailed Description

This subclass of GRIB1Op and UpstreamFile represents a GRIB1 file that is produced by an upstream workflow.

The is_ready subroutine calls self.check to check the modification time and file size. The make subroutine copies the file to a local location.

Definition at line 1848 of file regrib.py.

Inheritance diagram for hwrf.regrib.UpstreamGRIB1:

Public Member Functions
def	__init__ (self, dstore, args, kwargs)
	UpstreamGRIB1 constructor. More...
def	is_ready (self, args, kwargs)
	Runs the check function on the upstream product, and returns its results. More...
def	input_valid (self, kwargs)
	Returns True. More...
def	make (self, regrib, args, kwargs)
	Calls deliver_file to copy the file to a temporary location decided by regrib.gribtemp. More...
Public Member Functions inherited from produtil.datastore.UpstreamFile
def	check
	Checks the specified file to see if it is available. More...
def	undeliver (self)
	Undelivering an UpstreamFile merely sets the internal "available" flag to False. More...
def	deliver
	Raises InvalidOperation. More...
Public Member Functions inherited from produtil.datastore.Product
def	add_callback
	Adds a delivery callback function. More...
def	has_callbacks (self)
	Returns True if this Product has any callback functions and False otherwise.
def	call_callbacks
	Calls all delivery callback functions. More...
def	check (self, kwargs)
	Asks the product to check its own availability and update the database. More...
def	deliver (self, kwargs)
	Asks the Product to deliver itself. More...
def	undeliver (self, kwargs)
	"Undelivers" a product. More...
def	setavailable (self, val)
	Sets the availability to the specified value. More...
def	is_available (self)
	Is the product available? More...
def	validate (self)
	Validates this object's Datastore, prodname and category. More...
Public Member Functions inherited from produtil.datastore.Datum
def	__init__ (self, dstore, prodname, category, meta=None, cache=30, location=None, kwargs)
	Datum constructor. More...
def	__enter__ (self)
	Acquires this object's thread lock. More...
def	__exit__ (self, etype, evalue, traceback)
	Releases this object's thread lock. More...
def	validate (self)
	Validates this object's Datastore, prodname and category. More...
def	getid (self)
	Returns the database ID of this datum. More...
def	getdatastore (self)
	Returns the datastore of this datum. More...
def	transaction (self)
	Creates, but does not lock, a Transaction for this datum's datastore. More...
def	getprodtype (self)
	Returns the product type of this Datum. More...
def	getprodname (self)
	Returns the product name part of the database ID. More...
def	getcategory (self)
	Returns the product category part of the database ID. More...
def	getlocation (self)
	Returns the "location" field of this Datum's database entry. More...
def	setlocation (self, v)
	Sets the "location" field of this Datum's database entry. More...
def	__hash__ (self)
	Integer hash function. More...
def	__str__ (self)
	Human-readable description of this Datum. More...
def	__repr__ (self)
	Python code-like description of this Datum. More...
def	__cmp__ (self, other)
	Compares two Datums' prodnames and categories. More...
def	set_loc_avail (self, loc, avail)
	Sets the location and availability of this Datum in a single transaction. More...
def	update (self)
	Discards all cached metadata and refreshes it from the Datastore. More...
def	__getitem__ (self, k)
	Returns the value of the specified metadata key or raises KeyError. More...
def	meta
	Return the value of a metadata key. More...
def	get
	Alias for self.meta() Returns the value of the specified metadata key or returns default if it is unset. More...
def	__setitem__ (self, k, v)
	Sets the value of the specified metadata key. More...
def	__delitem__ (self, k)
	Deletes the specified metadata key, which must not be "available" or "location". More...
def	__contains__ (self, k)
	Determines if a metadata key is set. More...
def	iteritems (self)
	Iterates over all metadata (key,value) pairs for this Datum, including "available" and "location". 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...

Properties
	resultfile
	The path to the result file, in this case self.location. More...
Properties inherited from produtil.datastore.Product
	available
	Read-write property: is the product available? More...
Properties inherited from produtil.datastore.Datum
	prodname = property(getprodname,None,None,)
	Read-only property, an alias for getprodname(): the product name part of the database ID. More...
	category = property(getcategory,None,None,)
	Read-only property, an alias for getcategory(), the category name part of the database ID. More...
	prodtype
	Read-only property, an alias for getprodtype(), the product type. More...
	did
	Read-only property, an alias for getid(). More...
	dstore
	Read-only property, an alias for getdatastore(), the Datastore in which this Datum resides. More...
	location
	Read-write property, an alias for getlocation() and setlocation(). More...
Properties inherited from hwrf.regrib.GRIBOp
	action
	A read-only property: this objects action function. More...

Additional Inherited Members
Public Attributes inherited from produtil.datastore.UpstreamFile
	available

Constructor & Destructor Documentation

def hwrf.regrib.UpstreamGRIB1.__init__	(		self,
			dstore,
			args,
			kwargs
	)

UpstreamGRIB1 constructor.

Parameters

dstore	the produtil.datastore.Datastore for database info
args,kwargs	All other arguments passed to produtil.datastore.UpstreamFile.__init__

Definition at line 1854 of file regrib.py.

Member Function Documentation

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

Returns True.

Parameters

kwargs

Keyword arguments are ignored.

Definition at line 1870 of file regrib.py.

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

Runs the check function on the upstream product, and returns its results.

If the frominfo argument is in kwargs, it is passed as the first positional parameter to check.

Parameters

kwargs	The frominfo argument to UpstreamFile.check()
args	Additional positional arguments are ignored.

Definition at line 1860 of file regrib.py.

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

Calls deliver_file to copy the file to a temporary location decided by regrib.gribtemp.

Returns a GRIB1File for that file.

Parameters

regrib	a Regrib for data storage
args,kwargs	All other arguments are ignored.

Definition at line 1874 of file regrib.py.

Property Documentation

hwrf.regrib.UpstreamGRIB1.resultfile

static

Initial value:

= property(UpstreamFile.getlocation,None,None,
        'The path to the result file, in this case self.location.')

The path to the result file, in this case self.location.

Definition at line 1886 of file regrib.py.

---

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

• /mnt/pan2/projects/hwrfv3/Samuel.Trahan/trunk/ush/hwrf/regrib.py