FileOpen TCL UTILITIES USER MANUAL FileOpen
SYNOPSIS
Open a UDF data file
PACKAGE
TCLUDF
NAME
FileOpen
USAGE
FileOpen  Key Ver bY bD bH bM bS eY eD eH eM eS {pChk} {vOnly}
INPUT DEFINITIONS
Key - The data key associated with the with UDF hierarchy of the file being opened. Key should have been obtained from a call to GetDataKey.
Ver - Version number associated with this data open.
bY - The beginning year of the data being requested.
bD - The beginning day of year of the data being requested.
bH - The beginning hour of the data being requested.
bM - The beginning minute of the data being requested.
bS - The beginning second of the data being requested.
eY - The ending year of the data being requested.
eD - The ending day of year of the data being requested.
eH - The ending hour of the data being requested.
eM - The ending minute of the data being requested.
eS - The ending second of the data being requested.
pChk - An optional input which allows the autopromote feature to be tuned off. The default value is 1 (AUTOPROMOTE ON). A value of 0 will turn off autopromote. Note that autopromote can be turned off globally through the UDFPROMOTE environment variable.
vOnly - An optional variable which allows for only the VIDF file of the heirarchy to be promoted if needed. The default value is 0 (PROMOTE ALL NEEDED FILES). A value of 1 will turn off the promote of the UDF header/data and PIDF files. For this option to have effect both pChk and UDFPORMOTE must be set to allow data promotion.
RETURN DEFINITION
NONE
DESCRIPTION
FileOpen opens the UDF header and data file as well as the VIDF file associated with the UDF hierarchy represented by Key and containing the requested beginning time. It also builds a list of all files that will need to be opened to cover the entire start to stop time period. If there is no file locally present containing the start time and the UDFPROMOTE environment variable is set to allow promotes then an attempt to promote the data from one of the known data archives for is made. Promoting of data can be disabled for any given call to the procedure by setting the pChk input variable to 0. The opening of the header and data files associates with the input time can be disabled by setting vOnly input variable to 1.
NOTE: to multiply open the same UDF files (same Key and time period) you need to give each a unique Version number.
ERRORS
None Generated
C BACKING
No
EXAMPLE(S) 
# OPEN an IMAGE orbit data file beginning at 2001 198 1 0 0

# INITIALIZE the UDF common variables

UDFInits

# GET the key for the UDF hierarchy IMAGE IMAGE1 OA ORBIT IMOORBIT

set KeY [GetDataKey IMAGE IMAGE1 OA ORBIT IMOORBIT]

# OPEN the data file containing the time 2001 198 1 0 0

FileOpen $KeY 0 2001 198 1 0 0 2001 198 6 0 0
Nov 15, 2006