/* * 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. * */ #ident "@(#) reset_hdr.c 1.24 05/08/19 SwRI" #include "ret_codes.h" #include "libbase_idfs.h" /******************************************************************************* * * * IR_RESET_HEADER SUBROUTINE * * * * DESCRIPTION * * This routine is called whenever a header change has been detected. Some * * of the elements that are returned to the user come from the header record. * * In addition, the arrays for the sensor data, sample sequence values and * * azimuthal angles are allocated based on information returned in the header * * record (N_SAMPLE). All three arrays will end up being maxed out by the * * virtual instrument returning the most number of samples. * * * * INPUT VARIABLES * * void *idf_data_ptr ptr to the memory location for the structure * * that holds returned data values (read_drec) * * SDDAS_SHORT sen the sensor for which data is requested * * SDDAS_CHAR full_swp request 1 or all values in sensor set be * * returned (for scalar parameters only) * * * * USAGE * * x = ir_reset_header (idf_data_ptr, sen, full_swp) * * * * NECESSARY SUBPROGRAMS * * ir_check_critical_status() checks each sensor's critical status byte * * value and takes appropriate action * * ir_get_time_components () retrieves time elements that are used to * * calculate time associated with a sample * * ir_check_dependent_on_header() makes sure that memory dependent upon * * header information is of sufficient size * * ir_read_drec_times () fills in the time values returned by the * * caller of this module (read_drec) * * * * EXTERNAL VARIABLES * * struct general_info structure that holds information concerning * * ginfo the experiment that is being processed * * * * INTERNAL VARIABLES * * struct idf_data *EXP_DATA structure that holds all of the currently * * returned data values to be processed * * struct experiment_info a pointer to the structure that holds * * *ex specific experiment information * * struct ptr_rec *ptr a pointer to the structure which holds all * * pointers to the header and data for the * * experiment of interest * * SDDAS_SHORT ret_val holds value returned by called routine * * * * SUBSYSTEM * * Display Level * * * ******************************************************************************/ SDDAS_SHORT ir_reset_header (void *idf_data_ptr, SDDAS_SHORT sen, SDDAS_CHAR full_swp) { extern struct general_info ginfo; struct idf_data *EXP_DATA; struct experiment_info *ex; struct ptr_rec *ptr; SDDAS_SHORT ret_val; /***********************************************************************/ /* Set a pointer to the structure which holds all pointers for header */ /* and data information for the experiment currently being processed. */ /***********************************************************************/ ex = ginfo.expt; ptr = ex->info_ptr; EXP_DATA = (struct idf_data *) idf_data_ptr; ret_val = ir_check_dependent_on_header (idf_data_ptr); if (ret_val != ALL_OKAY) return (ret_val); /**********************************************************************/ /* Return a header change flag to the user for their use, along with */ /* the year and day. Since there is only one year/day value in the */ /* header, return same value for both start/end time values. */ /**********************************************************************/ EXP_DATA->hdr_change = 1; EXP_DATA->byear = *ptr->YEAR; EXP_DATA->bday = *ptr->DAYOFYEAR; EXP_DATA->eyear = *ptr->YEAR; EXP_DATA->eday = *ptr->DAYOFYEAR; EXP_DATA->mode_byear = *ptr->YEAR; EXP_DATA->mode_bday = *ptr->DAYOFYEAR; EXP_DATA->mode_eyear = *ptr->YEAR; EXP_DATA->mode_eday = *ptr->DAYOFYEAR; ir_get_time_components (); /***********************************************************************/ /* Set the beginning time and ending time for this time sample. */ /* Adjust the time components for day boundary crossings. The byear */ /* and eyear elements are the same value BEFORE time adjustment. */ /***********************************************************************/ ir_read_drec_times (idf_data_ptr, sen, full_swp); /**********************************************************************/ /* Reset header information flags. */ /**********************************************************************/ ptr->prev_hd = (*ptr->NSS > 0) ? *(ptr->HDR_OFF + ptr->cur_sen_set) : *ptr->HDR_OFF; ptr->reset_hdr = 0; /**********************************************************************/ /* Check the critical status byte for any change. */ /**********************************************************************/ ret_val = ir_check_critical_status (EXP_DATA->byear, EXP_DATA->bday, EXP_DATA->bsec, EXP_DATA->bnsec, EXP_DATA->eyear, EXP_DATA->eday, EXP_DATA->esec, EXP_DATA->ensec); if (ret_val != ALL_OKAY) return (ret_val); return (ALL_OKAY); }