hwrf.coupling.CouplingStatus Class Reference

Detailed Description

Maintains the ocean and wave status files in the COM directory.

Definition at line 400 of file coupling.py.

Inheritance diagram for hwrf.coupling.CouplingStatus:

Public Member Functions
def	__init__
def	logger (self)
def	conf (self)
def	section (self)
def	unset
def	fileiter (self)
def	set
def	read
def	get

Member Function Documentation

def hwrf.coupling.CouplingStatus.conf

(

self

)

The configuration object, a subclass of hwrf.config.HWRFConfig

Definition at line 415 of file coupling.py.

Referenced by scripts.exhwrf_output.Deliverer.deliver_file().

def hwrf.coupling.CouplingStatus.get	(		self,
			logger = None
	)

Checks the coupling status file.  If the file does not exist or
cannot be opened or read, then False is returned.  Otherwise, the
file is scanned for RUN_COUPLED=YES or RUN_COUPLED=NO (case
insensitive).  The last of those RUN_COUPLED lines is used:
NO=return False, YES=return True.  If the logger is not specified,
the section name is used as the logging domain

Definition at line 460 of file coupling.py.

Referenced by hwrf.wrfbase.WRFDomains.__contains__(), hwrf.wrfbase.WRFDomains.__getitem__(), hwrf.wrfbase.WRFDomains.add(), hwrf.wrf.WRFSimulation.analysis_name(), produtil.datastore.UpstreamFile.check(), hwrf.regrib.GRIB1Product.getgrib1grbindex(), hwrf.regrib.GRIB1Product.getgrib1grid(), hwrf.regrib.GRIB1Product.getgrib1index(), hwrf.regrib.GRIB2Product.getgrib2grid(), and hwrf.regrib.GRIB2Product.getgrib2index().

def hwrf.coupling.CouplingStatus.logger

(

self

)

The logging.Logger to use for logging messages.

Definition at line 411 of file coupling.py.

Referenced by hwrf.namelist.Conf2Namelist.copy(), hwrf.coupling.CouplingStatus.get(), hwrf_scrub.Deleter.go(), hwrf.coupling.CouplingStatus.read(), and hwrf.coupling.CouplingStatus.unset().

def hwrf.coupling.CouplingStatus.read	(		self,
			logger = None
	)

Reads the first coupling status file (identified by {section}=)
and returns the contents as an array of lines.

Definition at line 449 of file coupling.py.

def hwrf.coupling.CouplingStatus.section

(

self

)

The section in self.conf to use for configuration information.

Definition at line 419 of file coupling.py.

Referenced by hwrf.coupling.CouplingStatus.get(), hwrf.coupling.CouplingStatus.read(), and hwrf.coupling.CouplingStatus.unset().

def hwrf.coupling.CouplingStatus.set	(		self,
			coupling_flag,
			logger = None,
			morelines = None
	)

Set RUN_COUPLED=YES (true) or =NO (false) depending on the
value of coupled_flag.  If the logger is not specified, the
section name is used as the logging domain.

Definition at line 433 of file coupling.py.

def hwrf.coupling.CouplingStatus.unset	(		self,
			logger = None
	)

Delete the coupling status files.  If the logger is
not specified, the section name is used for the logging domain

Definition at line 422 of file coupling.py.

---

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

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