/*
 * Copyright (C) 1998 by Southwest Research Institute (SwRI)
 * 
 * All rights reserved under U.S. Copyright Law and International Conventions.
 * 
 * The development of this Software was supported by contracts NAG5-3148,
 * NAG5-6855, NAS8-36840, NAG5-2323, and NAG5-7043 issued on behalf of
 * the United States Government by its National Aeronautics and Space
 * Administration.  Southwest Research Institute grants to the Government,
 * and others acting on its behalf, a paid-up nonexclusive, irrevocable,
 * worldwide license to reproduce, prepare derivative works, and perform
 * publicly and display publicly, by or on behalf of the Government.
 * Other than those rights granted to the United States Government, no part
 * of this Software may be reproduced in any form or by any means, electronic
 * or mechanical, including photocopying, without permission in writing from
 * Southwest Research Institute.  All inquiries should be addressed to:
 * 
 * Director of Contracts
 * Southwest Research Institute
 * P. O. Drawer 28510
 * San Antonio, Texas 78228-0510
 * 
 * 
 * Use of this Software is governed by the terms of the end user license
 * agreement, if any, which accompanies or is included with the Software
 * (the "License Agreement").  An end user will be unable to install any
 * Software that is accompanied by or includes a License Agreement, unless
 * the end user first agrees to the terms of the License Agreement.  Except
 * as set forth in the applicable License Agreement, any further copying,
 * reproduction or distribution of this Software is expressly prohibited.
 * Installation assistance, product support and maintenance, if any, of the
 * Software is available from SwRI and/or the Third Party Providers, as the
 * case may be.
 * 
 * Disclaimer of Warranty
 * 
 * SOFTWARE IS WARRANTED, IF AT ALL, IN ACCORDANCE WITH THESE TERMS OF THE
 * LICENSE AGREEMENT.  UNLESS OTHERWISE EXPLICITLY STATED, THIS SOFTWARE IS
 * PROVIDED "AS IS", IS EXPERIMENTAL, AND IS FOR NON-COMMERCIAL USE ONLY,
 * AND ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES,
 * INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
 * PURPOSE, OR NON-INFRINGEMENT, ARE DISCLAIMED, EXCEPT TO THE EXTENT THAT
 * SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID.
 * 
 * Limitation of Liability
 * 
 * SwRI SHALL NOT BE LIABLE FOR ANY DAMAGES SUFFERED AS A RESULT OF USING,
 * MODIFYING, CONTRIBUTING, COPYING, DISTRIBUTING, OR DOWNLOADING THIS
 * SOFTWARE.  IN NO EVENT SHALL SwRI BE LIABLE FOR ANY INDIRECT, PUNITIVE,
 * SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGE (INCLUDING LOSS OF BUSINESS,
 * REVENUE, PROFITS, USE, DATA OR OTHER ECONOMIC ADVANTAGE) HOWEVER IT ARISES,
 * WHETHER FOR BREACH OF IN TORT, EVEN IF SwRI HAS BEEN PREVIOUSLY ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGE.  YOU HAVE SOLE RESPONSIBILITY FOR ADEQUATE
 * PROTECTION AND BACKUP OF DATA AND/OR EQUIPMENT USED IN CONNECTION WITH THE
 * SOFTWARE AND WILL NOT MAKE A CLAIM AGAINST SwRI FOR LOST DATA, RE-RUN TIME,
 * INACCURATE OUTPUT, WORK DELAYS OR LOST PROFITS RESULTING FROM THE USE OF
 * THIS SOFTWARE.  YOU AGREE TO HOLD SwRI HARMLESS FROM, AND YOU COVENANT NOT
 * TO SUE SwRI FOR, ANY CLAIMS BASED ON USING THE SOFTWARE.
 * 
 * Local Laws: Export Control
 * 
 * You acknowledge and agree this Software is subject to the U.S. Export 
 * Administration Laws and Regulations.  Diversion of such Software contrary
 * to U.S. law is prohibited.  You agree that none of the Software, nor any
 * direct product therefrom, is being or will be acquired for, shipped,
 * transferred, or reexported, directly or indirectly, to proscribed or
 * embargoed countries or their nationals, nor be used for nuclear activities,
 * chemical biological weapons, or missile projects unless authorized by U.S.
 * Government.  Proscribed countries are set forth in the U.S. Export
 * Administration Regulations.  Countries subject to U.S embargo are:  Cuba,
 * Iran, Iraq, Libya, North Korea, Syria, and the Sudan.  This list is subject
 * to change without further notice from SwRI, and you must comply with the
 * list as it exists in fact.  You certify that you are not on the U.S.
 * Department of Commerce's Denied Persons List or affiliated lists or on the
 * U.S. Department of Treasury's Specially Designated Nationals List.  You agree
 * to comply strictly with all U.S. export laws and assume sole responsibilities
 * for obtaining licenses to export or reexport as may be required.
 * 
 * General
 * 
 * These Terms represent the entire understanding relating to the use of the 
 * Software and prevail over any prior or contemporaneous, conflicting or
 * additional, communications.  SwRI can revise these Terms at any time
 * without notice by updating this posting.
 * 
 * Trademarks
 * 
 * The SwRI logo is a trademark of SwRI in the United States and other countries.
 * 
 */
#ifndef __BKGD_STR_H__
#define __BKGD_STR_H__

#include "SDDAS_types.h"

struct background_info
{
   struct time_span cur_time;     /* structure that holds time for current sample */
   SDDAS_FLOAT *data_values;      /* data values for whole sweep                  */
   SDDAS_FLOAT *time_frac;        /* normalization for sweep                      */
   SDDAS_FLOAT *last_data_value;  /* last background value read                   */
   SDDAS_FLOAT last_comp_frac;    /* last frac val from ir_background_time_frac() */
   SDDAS_ULONG data_key;          /* key for the data source for the background   */
   SDDAS_LONG stop_sec;           /* end time used for parent in FILE_OPEN call   */
   SDDAS_LONG stop_nano;          /* end time used for parent in FILE_OPEN call   */
   SDDAS_SHORT stop_year;         /* end time used for parent in FILE_OPEN call   */
   SDDAS_SHORT stop_day;          /* end time used for parent in FILE_OPEN call   */
   SDDAS_SHORT *sensor;           /* sensor number                                */
   SDDAS_SHORT file_status;       /* status from call to FILE_SETUP for bkgd IDFS */
   SDDAS_SHORT background_format; /* format for algorithm                         */
   SDDAS_LONG *tbl_offset;        /* offset into the tbl_oper and tbl_apply tables*/
   SDDAS_LONG *tbl_oper;          /* the table operators to apply                 */
   SDDAS_USHORT version;          /* version number for the requested data        */
   SDDAS_CHAR *tbl_apply;         /* the tables to apply                          */
   SDDAS_CHAR *num_tbls;          /* the number of tables to convert to units     */
                                  /* for each sensor                              */
   SDDAS_CHAR *next_data;         /* flag indicating if data needs to be read     */
   SDDAS_CHAR *all_done;          /* processing flag for current sample           */
   SDDAS_CHAR exten[3];           /* filename extension of the data files         */
   SDDAS_CHAR get_background_data;/* flag indicating if background data is to be  */
                                  /* retrieved                                    */
   SDDAS_BOOL copy_next_data;     /* flag indicating if next_data[] needs to be   */
                                  /* copied from 1st component                    */
   SDDAS_BOOL copy_all_done;      /* flag indicating if all_done[] needs to be    */
                                  /* copied from 1st component                    */
   void **idf_data_ptr;           /* array of ptrs to data structures             */
   void *base_tbls;               /* ptr to memory for table information          */
   void *base_sensors;            /* ptr to memory for all other allocated data   */
};

#endif