/* * 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 "@(#) get_cur_tm.c 1.12 05/08/19 SwRI" #include "ret_codes.h" #include "libbase_idfs.h" #include "libVIDF.h" /* for header format comparison */ /******************************************************************************* * * * IR_GET_CURRENT_TIME SUBROUTINE * * * * DESCRIPTION * * This routine is called to return the time for the current sample for the * * data set being processed. * * * * INPUT VARIABLES * * SDDAS_ULONG data_key key which uniquely identifies the data set * * being processed * * SDDAS_CHAR *exten filename extension for the data to be used * * SDDAS_USHORT vnum version number to be associated with this * * combination (allows for multiple opens) * * void *data_ptr ptr to the memory location for the structure * * that holds returned data values (either * * idf_data_ptr or tensor_data_ptr) * * 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_get_current_time (data_key, exten, vnum, data_ptr, sen, * * full_swp) * * * * NECESSARY SUBPROGRAMS * * ir_locate_ex() determines if requested combination has * * already been pand points to the * * ir_set_time() determines the time associated with data * * being returned * * ir_sensor_set_time() calculates the time associated with the * * sensor set being processed * * ir_get_time_components () retrieves time elements that are used to * * calculate time associated with a sample * * adjust_time () corrects time elements if too many seconds * * (day crossing) or too many days(year crossing)* * * * 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 tensor_data *TENSOR_DATA structure that holds all the currently * * returned tensor 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 rval holds called routine status flags * * SDDAS_CHAR decrement_bday flag indicating if start day needs to be * * modified (if btime ends up negative) * * SDDAS_CHAR decrement_eday flag indicating if end day needs to be * * modified (if etime ends up negative) * * char reset_called flag indicating if LOCATE_EX was called * * * * SUBSYSTEM * * Display Level * * * ******************************************************************************/ SDDAS_SHORT ir_get_current_time (SDDAS_ULONG data_key, SDDAS_CHAR *exten, SDDAS_USHORT vnum, void *data_ptr, SDDAS_SHORT sen, SDDAS_CHAR full_swp) { extern struct general_info ginfo; struct idf_data *EXP_DATA; struct tensor_data *TENSOR_DATA; struct experiment_info *ex; struct ptr_rec *ptr; SDDAS_SHORT rval; SDDAS_CHAR decrement_bday, decrement_eday; char reset_called; /*************************************************************************/ /* Check to see if the combination being processed has been processed */ /* before. If not, an error condition - probably didn't call FILE_OPEN. */ /* Since ir_locate_ex() is called by more than one routine, return an */ /* error code that indicates which calling routine resulted in the error.*/ /* Since a 0 is passed for the last parameter, the only possible error is*/ /* that the requested combination was not found among processed combos. */ /*************************************************************************/ if (!ginfo.called_locate) { rval = ir_locate_ex (data_key, exten, vnum, 0); if (rval != ALL_OKAY) return (CUR_TIME_NOT_FOUND); ginfo.called_locate = 1; reset_called = 1; } else reset_called = 0; /*************************************************************************/ /* Set the beginning time and ending time for this time sample. */ /*************************************************************************/ ex = ginfo.expt; ptr = ex->info_ptr; if (ex->header_format == ORIGINAL_HEADER) { EXP_DATA = (struct idf_data *) data_ptr; EXP_DATA->byear = *ptr->YEAR; EXP_DATA->bday = *ptr->DAYOFYEAR; EXP_DATA->eyear = *ptr->YEAR; EXP_DATA->eday = *ptr->DAYOFYEAR; } else { TENSOR_DATA = (struct tensor_data *) data_ptr; TENSOR_DATA->byear = *ptr->YEAR; TENSOR_DATA->bday = *ptr->DAYOFYEAR; TENSOR_DATA->eyear = *ptr->YEAR; TENSOR_DATA->eday = *ptr->DAYOFYEAR; } ir_get_time_components (); ir_set_time (full_swp, sen, data_ptr, &decrement_bday, &decrement_eday); if (ex->header_format == ORIGINAL_HEADER) { EXP_DATA->bmilli = ex->btime_ms; EXP_DATA->bnano = ex->btime_ns; EXP_DATA->emilli = ex->etime_ms; EXP_DATA->enano = ex->etime_ns; adjust_time (&EXP_DATA->byear, &EXP_DATA->bday, &EXP_DATA->bmilli, 2); adjust_time (&EXP_DATA->eyear, &EXP_DATA->eday, &EXP_DATA->emilli, 2); EXP_DATA->bsec = (EXP_DATA->bmilli + (EXP_DATA->bnano / 1000000)) / 1000; EXP_DATA->bnsec = (EXP_DATA->bmilli % 1000) * 1000000 + EXP_DATA->bnano; EXP_DATA->esec = (EXP_DATA->emilli + (EXP_DATA->enano / 1000000)) / 1000; EXP_DATA->ensec = (EXP_DATA->emilli % 1000) * 1000000 + EXP_DATA->enano; 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_sensor_set_time (&EXP_DATA->mode_bmilli, &EXP_DATA->mode_bnano, &EXP_DATA->mode_emilli, &EXP_DATA->mode_enano); adjust_time (&EXP_DATA->mode_byear, &EXP_DATA->mode_bday, &EXP_DATA->mode_bmilli, 2); adjust_time (&EXP_DATA->mode_eyear, &EXP_DATA->mode_eday, &EXP_DATA->mode_emilli, 2); } else { TENSOR_DATA->bmilli = ex->btime_ms; TENSOR_DATA->bnano = ex->btime_ns; TENSOR_DATA->emilli = ex->etime_ms; TENSOR_DATA->enano = ex->etime_ns; adjust_time (&TENSOR_DATA->byear, &TENSOR_DATA->bday, &TENSOR_DATA->bmilli, 2); adjust_time (&TENSOR_DATA->eyear, &TENSOR_DATA->eday, &TENSOR_DATA->emilli, 2); TENSOR_DATA->bsec = (TENSOR_DATA->bmilli + (TENSOR_DATA->bnano / 1000000)) / 1000; TENSOR_DATA->bnsec = (TENSOR_DATA->bmilli % 1000) * 1000000 + TENSOR_DATA->bnano; TENSOR_DATA->esec = (TENSOR_DATA->emilli + (TENSOR_DATA->enano / 1000000)) / 1000; TENSOR_DATA->ensec = (TENSOR_DATA->emilli % 1000) * 1000000 + TENSOR_DATA->enano; TENSOR_DATA->mode_byear = *ptr->YEAR; TENSOR_DATA->mode_bday = *ptr->DAYOFYEAR; TENSOR_DATA->mode_eyear = *ptr->YEAR; TENSOR_DATA->mode_eday = *ptr->DAYOFYEAR; ir_sensor_set_time (&TENSOR_DATA->mode_bmilli, &TENSOR_DATA->mode_bnano, &TENSOR_DATA->mode_emilli, &TENSOR_DATA->mode_enano); adjust_time (&TENSOR_DATA->mode_byear, &TENSOR_DATA->mode_bday, &TENSOR_DATA->mode_bmilli, 2); adjust_time (&TENSOR_DATA->mode_eyear, &TENSOR_DATA->mode_eday, &TENSOR_DATA->mode_emilli, 2); } if (reset_called) ginfo.called_locate = 0; return (ALL_OKAY); }