configRTFileOptionsSeaglider

CONFIGRTFILEOPTIONSSEAGLIDER  Configure loading options for Seaglider files in real time.

  Syntax:
    SEAGLIDER_OPTIONS = CONFIGRTFILEOPTIONSSEAGLIDER()

  Description:
    SEAGLIDER_OPTIONS = CONFIGRTFILEOPTIONSSEAGLIDER() should return a struct 
    with the parameters that control which are the deployment files,
    whether they need to be converted, and which files and data should be used
    in real time mode. The returned struct should have the following fields:
      LOG_NAME_PATTERN: string with the name pattern of Seaglider log files 
        to be loaded by LOADSEAGLIDERDATA for processing.
      ENG_NAME_PATTERN: string with the name pattern of Seaglider eng files.
        to be loaded by LOADSEAGLIDERDATA for processing.
      LOG_PARAMS: string cell array with the name of the parameters from
        log files to be loaded by LOADSEAGLIDERDATA. Restricting the list of
        parameters to load may reduce the memory footprint.
      ENG_COLUMNS: string cell array with the name of the data columns from
        eng files to be loaded by LOADSEAGLIDERDATA. Restricting the list of
        columns to load may reduce the memory footprint.

  Examples:
    seaglider_options = configDTFileOptionsSeaglider()

  See also:
    MAIN_GLIDER_DATA_PROCESSING_RT
    LOADSEAGLIDERDATA

  Authors:
    Joan Pau Beltran  <joanpau.beltran@socib.cat>

0001 function seaglider_options = configRTFileOptionsSeaglider()
0002 %CONFIGRTFILEOPTIONSSEAGLIDER  Configure loading options for Seaglider files in real time.
0003 %
0004 %  Syntax:
0005 %    SEAGLIDER_OPTIONS = CONFIGRTFILEOPTIONSSEAGLIDER()
0006 %
0007 %  Description:
0008 %    SEAGLIDER_OPTIONS = CONFIGRTFILEOPTIONSSEAGLIDER() should return a struct
0009 %    with the parameters that control which are the deployment files,
0010 %    whether they need to be converted, and which files and data should be used
0011 %    in real time mode. The returned struct should have the following fields:
0012 %      LOG_NAME_PATTERN: string with the name pattern of Seaglider log files
0013 %        to be loaded by LOADSEAGLIDERDATA for processing.
0014 %      ENG_NAME_PATTERN: string with the name pattern of Seaglider eng files.
0015 %        to be loaded by LOADSEAGLIDERDATA for processing.
0016 %      LOG_PARAMS: string cell array with the name of the parameters from
0017 %        log files to be loaded by LOADSEAGLIDERDATA. Restricting the list of
0018 %        parameters to load may reduce the memory footprint.
0019 %      ENG_COLUMNS: string cell array with the name of the data columns from
0020 %        eng files to be loaded by LOADSEAGLIDERDATA. Restricting the list of
0021 %        columns to load may reduce the memory footprint.
0022 %
0023 %  Examples:
0024 %    seaglider_options = configDTFileOptionsSeaglider()
0025 %
0026 %  See also:
0027 %    MAIN_GLIDER_DATA_PROCESSING_RT
0028 %    LOADSEAGLIDERDATA
0029 %
0030 %  Authors:
0031 %    Joan Pau Beltran  <joanpau.beltran@socib.cat>
0032 
0033 %  Copyright (C) 2013-2016
0034 %  ICTS SOCIB - Servei d'observacio i prediccio costaner de les Illes Balears
0035 %  <http://www.socib.es>
0036 %
0037 %  This program is free software: you can redistribute it and/or modify
0038 %  it under the terms of the GNU General Public License as published by
0039 %  the Free Software Foundation, either version 3 of the License, or
0040 %  (at your option) any later version.
0041 %
0042 %  This program is distributed in the hope that it will be useful,
0043 %  but WITHOUT ANY WARRANTY; without even the implied warranty of
0044 %  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
0045 %  GNU General Public License for more details.
0046 %
0047 %  You should have received a copy of the GNU General Public License
0048 %  along with this program.  If not, see <http://www.gnu.org/licenses/>.
0049 
0050   error(nargchk(0, 0, nargin, 'struct'));
0051   
0052   % Select dive log files to use. All log files:
0053   seaglider_options.log_name_pattern = '^p\d{3}\d{4}\.log$';
0054     
0055   % Select dive eng files to use. All eng files:
0056   seaglider_options.eng_name_pattern = '^p\d{3}\d{4}\.eng$';
0057   
0058   % Log parameters to load.
0059   seaglider_options.log_params = 'all';
0060   
0061   % Eng parameters to load.
0062   seaglider_options.eng_columns = 'all';
0063   
0064 end