Home > ctdcal > load_cond_db.m

load_cond_db

PURPOSE ^

load_cond_db - Load conductivity data from the given cruise database.

SYNOPSIS ^

function theResult = load_cond_db(varargin)

DESCRIPTION ^

 load_cond_db -  Load conductivity data from the given cruise database.
 
 CTD Calibration toolbox
 
 INPUT: 
   cruiseid: String representing the current cruise identifier     

 OUTPUT:
   theCondStruct: Structure containing *all* conductivity data.

 DESCRIPTION:    
    The ifunction loads the conductivity data contained in the cruise database
 file.  It contains the error checking and logic to make sure the cruise database
 was properly loaded.  Use this instead of the Matlab load command directly.

 load_bl, load_btl, load_cnv, load_autosal must have been run prior to calling 
 this function.

 
 AUTHOR: 
            Derrick Snowden
            Thu Sep 16 13:01:13 EDT 2004
            Carlos Fonseca

 CHANGELOG: 
   08-Jul-2004, Version 1.0
        * Initial version.

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SUBFUNCTIONS ^

SOURCE CODE ^

0001 function theResult  = load_cond_db(varargin)
0002 % load_cond_db -  Load conductivity data from the given cruise database.
0003 %
0004 % CTD Calibration toolbox
0005 %
0006 % INPUT:
0007 %   cruiseid: String representing the current cruise identifier
0008 %
0009 % OUTPUT:
0010 %   theCondStruct: Structure containing *all* conductivity data.
0011 %
0012 % DESCRIPTION:
0013 %    The ifunction loads the conductivity data contained in the cruise database
0014 % file.  It contains the error checking and logic to make sure the cruise database
0015 % was properly loaded.  Use this instead of the Matlab load command directly.
0016 %
0017 % load_bl, load_btl, load_cnv, load_autosal must have been run prior to calling
0018 % this function.
0019 %
0020 %
0021 % AUTHOR:
0022 %            Derrick Snowden
0023 %            Thu Sep 16 13:01:13 EDT 2004
0024 %            Carlos Fonseca
0025 %
0026 % CHANGELOG:
0027 %   08-Jul-2004, Version 1.0
0028 %        * Initial version.
0029 %
0030 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0031 
0032 % Check that the cruiseid can be located
0033 
0034 % Load the cruise data
0035 
0036 % Check each subset (btl, bl, cnv etc.)
0037 
0038 
0039 % Exit the function
0040 if nargout > 0
0041         theResult = result;
0042 else
0043         assignin('caller', 'ans', result)
0044 end
0045 return
0046 
0047 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0048 function []  = check_btl()
0049 % check_btl: Check that load_btl has been successfully run.
0050 %
0051 
0052 
0053 return
0054 
0055 
0056

Generated on Fri 08-Oct-2004 11:57:17 by m2html © 2003