hwrf.regrib.GRIBGrid Class Reference

This class represents a GRIB1 or GRIB2 grid specification. More...

Detailed Description

This class represents a GRIB1 or GRIB2 grid specification.

Definition at line 1151 of file regrib.py.

Inheritance diagram for hwrf.regrib.GRIBGrid:

Public Member Functions
def	__init__
	Creates a GRIBGrid with a given name, a copygb -g style GRIB1 grid specification and a GRIB2 grid specification that is currently unused. 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	getgridname (self)
	Returns the name of this grid, as provided to the constructor. More...
def	getgrib1grid (self)
	Returns the GRIB1 (wgrib) style grid information, as sent to the constructor's grib1grid argument. More...
def	getgrib2grid (self)
	This is a placeholder to return the GRIB2-style grid information. 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
	gridname
	The name of this grid, a read-only property. More...
	grib1grid
	The GRIB1 grid string, a read-only property. More...
	grib2grid
	The GRIB2 grid information, currently unused. More...

Constructor & Destructor Documentation

def hwrf.regrib.GRIBGrid.__init__	(		self,
			gridname,
			grib1grid = None,
			grib2grid = None
	)

Creates a GRIBGrid with a given name, a copygb -g style GRIB1 grid specification and a GRIB2 grid specification that is currently unused.

Parameters

gridname	The gridname is mandatory and will be used to generate temporary filenames.
grib1grid	The GRIB1 grid information, a string
grib2grid	The GRIB2 grid information (unsupported)

Definition at line 1153 of file regrib.py.

Member Function Documentation

def hwrf.regrib.GRIBGrid.getgrib1grid

(

self

)

Returns the GRIB1 (wgrib) style grid information, as sent to the constructor's grib1grid argument.

Definition at line 1182 of file regrib.py.

def hwrf.regrib.GRIBGrid.getgrib2grid

(

self

)

This is a placeholder to return the GRIB2-style grid information.

At present, it returns whatever was sent to the constructor's grib2grid argument

Definition at line 1186 of file regrib.py.

def hwrf.regrib.GRIBGrid.getgridname

(

self

)

Returns the name of this grid, as provided to the constructor.

Definition at line 1178 of file regrib.py.

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

Returns True.

The grid information is always available, regardless of the kwargs.

Parameters

kwargs

Ignored, but used by subclasses.

Definition at line 1169 of file regrib.py.

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

Returns True.

The grid information is always ready.

Parameters

args,kwargs

Ignored, but used by subclasses.

Definition at line 1165 of file regrib.py.

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

Returns self.

This grid is the output grid of this grid.

Parameters

args,kwargs

Ignored, but used by subclasses.

Definition at line 1174 of file regrib.py.

Property Documentation

hwrf.regrib.GRIBGrid.grib1grid

static

Initial value:

= property(getgrib1grid,None,None,
        )

The GRIB1 grid string, a read-only property.

Definition at line 1199 of file regrib.py.

Referenced by hwrf.regrib.GRIB1Product.deliver(), and hwrf.regrib.GRIB1Product.undeliver().

hwrf.regrib.GRIBGrid.grib2grid

static

Initial value:

= property(getgrib2grid,None,None,
       )

The GRIB2 grid information, currently unused.

Definition at line 1204 of file regrib.py.

Referenced by hwrf.regrib.GRIB2Product.deliver(), and hwrf.regrib.GRIB2Product.undeliver().

hwrf.regrib.GRIBGrid.gridname

static

Initial value:

= property(getgridname,None,None,
        )

The name of this grid, a read-only property.

Definition at line 1194 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