getanc

Public Member Functions
def	__init__ (self, filename=None, start=None, stop=None, ancdir=None, ancdb='ancillary_data.db', anc_file=None, curdir=False, atteph=False, sensor=None, opt_flag=None, verbose=0, printlist=True, download=True, timeout=10, refreshDB=False, use_filename=False)
def	chk (self)
def	get_start_end_info_from_xml (self, raw_xml)
def	setup (self)
def	set_opt_flag (self, key, off=False)
def	finddb (self)
def	findweb (self)
def	yearday (self, ancfile)
def	locate (self, forcedl=False)
def	write_anc_par (self)
def	cleanup (self)

Static Public Member Functions
def	get_start_end_info (info)
def	get_goci_time (goci_time_str)
def	get_time_coverage_xml (elem)

Public Attributes
	filename
	start
	stop
	ancdir
	ancdb
	anc_file
	curdir
	opt_flag
	atteph
	dl
	refreshDB
	sensor
	dirs
	files
	printlist
	verbose
	timeout
	server_status
	db_status
	proctype
	use_filename
	query_site
	data_site
	base
	server_file

Detailed Description

utilities for ancillary file search

Definition at line 40 of file anc_utils.py.

Constructor & Destructor Documentation

__init__()

def __init__	(		self,
			filename = None,
			start = None,
			stop = None,
			ancdir = None,
			ancdb = 'ancillary_data.db',
			anc_file = None,
			curdir = False,
			atteph = False,
			sensor = None,
			opt_flag = None,
			verbose = 0,
			printlist = True,
			download = True,
			timeout = 10,
			refreshDB = False,
			use_filename = False
	)

Definition at line 45 of file anc_utils.py.

Member Function Documentation

chk()

def chk

(

self

)

Check validity of inputs to

Definition at line 88 of file anc_utils.py.

cleanup()

def cleanup

(

self

)

remove the temporary 'server' file and adjust return status - if necessary

Definition at line 981 of file anc_utils.py.

finddb()

def finddb

(

self

)

Checks local db for anc files.

Definition at line 399 of file anc_utils.py.

findweb()

def findweb

(

self

)

Execute the display_ancillary_files search and populate the locate cache database

Definition at line 465 of file anc_utils.py.

get_goci_time()

def get_goci_time (   goci_time_str )

static

Definition at line 143 of file anc_utils.py.

get_start_end_info()

def get_start_end_info (   info )

static

Extracts and returns the start time, start date, end time, and end date
from info. Returns a None value for any item not found.

Definition at line 122 of file anc_utils.py.

get_start_end_info_from_xml()

def get_start_end_info_from_xml	(		self,
			raw_xml
	)

Extracts and returns the start time, start date, end time, and end date
from the XML tree in raw_xml. Returns a None value for any item not
found.

Definition at line 160 of file anc_utils.py.

get_time_coverage_xml()

def get_time_coverage_xml (   elem )

static

Definition at line 155 of file anc_utils.py.

locate()

def locate	(		self,
			forcedl = False
	)

Find the files on the local system or download from OBPG

Definition at line 768 of file anc_utils.py.

set_opt_flag()

def set_opt_flag	(		self,
			key,
			off = False
	)

set up the opt_flag for display_ancillary_data (type=anc)
opt_flag values:
   0 - just the basics, MET/OZONE
   1 - include OISST
   2 - include NO2
   4 - include ICE

Definition at line 383 of file anc_utils.py.

setup()

def setup

(

self

)

Set up the basics

Definition at line 194 of file anc_utils.py.

write_anc_par()

def write_anc_par

(

self

)

create the .anc parameter file

Definition at line 862 of file anc_utils.py.

yearday()

def yearday	(		self,
			ancfile
	)

Definition at line 669 of file anc_utils.py.

Member Data Documentation

anc_file

anc_file

Definition at line 51 of file anc_utils.py.

ancdb

ancdb

Definition at line 50 of file anc_utils.py.

ancdir

ancdir

Definition at line 49 of file anc_utils.py.

atteph

atteph

Definition at line 54 of file anc_utils.py.

base

base

Definition at line 209 of file anc_utils.py.

curdir

curdir

Definition at line 52 of file anc_utils.py.

data_site

data_site

Definition at line 71 of file anc_utils.py.

db_status

db_status

Definition at line 64 of file anc_utils.py.

dirs

dirs

Definition at line 58 of file anc_utils.py.

dl

dl

Definition at line 55 of file anc_utils.py.

filename

filename

Definition at line 46 of file anc_utils.py.

files

files

Definition at line 59 of file anc_utils.py.

opt_flag

opt_flag

Definition at line 53 of file anc_utils.py.

printlist

printlist

Definition at line 60 of file anc_utils.py.

proctype

proctype

Definition at line 65 of file anc_utils.py.

query_site

query_site

Definition at line 70 of file anc_utils.py.

refreshDB

refreshDB

Definition at line 56 of file anc_utils.py.

sensor

sensor

Definition at line 57 of file anc_utils.py.

server_file

server_file

Definition at line 212 of file anc_utils.py.

server_status

server_status

Definition at line 63 of file anc_utils.py.

start

start

Definition at line 47 of file anc_utils.py.

stop

stop

Definition at line 48 of file anc_utils.py.

timeout

timeout

Definition at line 62 of file anc_utils.py.

use_filename

use_filename

Definition at line 66 of file anc_utils.py.

verbose

verbose

Definition at line 61 of file anc_utils.py.

---

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

• /gfs-oceanweb/web/ocssw/ocssw_src/src/scripts/seadasutils/anc_utils.py