/* * 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 "@(#) samp_time.c 1.22 05/08/19 SwRI" #include #include "libbase_idfs.h" #include "libVIDF.h" /* for header format comparison */ /******************************************************************************* * * * IR_SAMPLE_TIME SUBROUTINE * * * * DESCRIPTION * * This routine is called to determine the time associated with the sample * * being processed and returned to the calling program. The time is returned * * in two parts, the time in milliseconds and for finer resolution, the * * number of nanoseconds left over after the time in milliseconds has been * * determined. The algorithm used to determine the time is taken directly * * from the VIDF definition document. * * * * INPUT VARIABLES * * SDDAS_USHORT max_ele the number of data values to be returned * * SDDAS_SHORT sensor the sensor for which data is requested * * SDDAS_USHORT time_row the matrix row being processed * * SDDAS_SHORT time_col the matrix column being processed * * SDDAS_LONG *btime_ms start time (msec) of the sample * * SDDAS_LONG *btime_ns start time (nanoseconds) of the sample * * SDDAS_LONG *etime_ms end time (msec) of the sample * * SDDAS_LONG *etime_ns end time (nanoseconds) of the sample * * 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) * * * * USAGE * * ir_sample_time (max_ele, sensor, time_row, time_col, &btime_ms, * * &btime_ns, &etime_ms, &etime_ns, &decrement_bday, * * &decrement_eday) * * * * NECESSARY SUBPROGRAMS * * abs() returns the absolute value of a number * * * * EXTERNAL VARIABLES * * struct general_info structure that holds information concerning * * ginfo the experiment that is being processed * * * * INTERNAL VARIABLES * * 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_ULONG num_sample the number of samples returned for each sensor* * SDDAS_ULONG last_row value used to compute the end time of the * * last element in the sweep * * SDDAS_LONG add_ms the number of milliseconds to add to the * * millisecond time element * * SDDAS_LONG time_off offset time (in millisecond) for each sensor * * SDDAS_LONG dr_time_ns nanosecond time adjustment to dr_time in * * the data record * * SDDAS_SHORT swp_off the last step returned for the sweep * * SDDAS_SHORT base_swp_off the first step returned for the sweep * * * * SUBSYSTEM * * Display Level * * * ******************************************************************************/ void ir_sample_time (SDDAS_USHORT max_ele, SDDAS_SHORT sensor, SDDAS_USHORT time_row, SDDAS_SHORT time_col, SDDAS_LONG *btime_ms, SDDAS_LONG *btime_ns, SDDAS_LONG *etime_ms, SDDAS_LONG *etime_ns, SDDAS_CHAR *decrement_bday, SDDAS_CHAR *decrement_eday) { extern struct general_info ginfo; struct experiment_info *ex; struct ptr_rec *ptr; SDDAS_ULONG num_sample, last_row; SDDAS_LONG add_ms, time_off, dr_time_ns; SDDAS_SHORT swp_off, base_swp_off; /****************************************************************************/ /* Set a pointer to the structure which holds all pointers for header and */ /* data information for the experiment currently being processed and point */ /* to the sensor structure for the sensor of interest. */ /****************************************************************************/ ex = ginfo.expt; ptr = ex->info_ptr; /****************************************************************************/ /* CARRIE - Not sure if this is correct. Re-examine when figuring out the */ /* timing definitions for tensor data.(no longer force parallel) */ /****************************************************************************/ if (ex->header_format == ORIGINAL_HEADER) num_sample = *ptr->hdr_fmt1_ptr->N_SAMPLE; else num_sample = ptr->hdr_fmt2_ptr->TENSOR_ELEMENTS; /***************************************************************************/ /* Determine the beginning time for the sample being processed using all */ /* timing elements. PTR->TIME and TIME_OFF are not added to the */ /* nanoseconds element since they are returned in milliseconds only. */ /***************************************************************************/ *decrement_bday = 0; *decrement_eday = 0; dr_time_ns = (ex->nano_defined) ? *ptr->NANO_RES : 0; time_off = *(ex->time_off + sensor); *btime_ms = *ptr->TIME + time_off + ex->accum_ss_ms + time_row * ex->time_col_ms + time_col * ex->time_row_ms; *btime_ns = dr_time_ns + ex->accum_ss_ns + time_row * ex->time_col_ns + time_col * ex->time_row_ns; /***************************************************************************/ /* If the time ends up negative due to negative time_off value, modify */ /* before computing end time and send back flag since day value is not */ /* sent in. */ /***************************************************************************/ if (*btime_ms < 0) { *decrement_bday = 1; *btime_ms += 86400000; } /***************************************************************************/ /* If the nanosecond time element can be converted into milliseconds, do */ /* so and add this to the millisecond time element and keep the leftover */ /* nanoseconds. 1000000 nanoseconds = 1 millisecond. */ /***************************************************************************/ add_ms = *btime_ns / 1000000; *btime_ms += add_ms; *btime_ns = *btime_ns % 1000000; /***************************************************************************/ /* Determine the ending time for the sample being processed. */ /***************************************************************************/ if (!ex->TCP) { *etime_ms = *btime_ms + ex->time_sm_ms; *etime_ns = *btime_ns + ex->time_sm_ns; } else if (ex->smp_id == 2) { last_row = (max_ele == 1) ? time_row + 1 : num_sample; *etime_ms = *ptr->TIME + time_off + ex->accum_ss_ms + last_row * ex->time_col_ms + time_col * ex->time_row_ms; *etime_ns = dr_time_ns + ex->accum_ss_ns + last_row * ex->time_col_ns + time_col * ex->time_row_ns; } else { if (ex->da_method == 3) { /***********************************************************/ /* Instrument could be in a mode where a single step is */ /* being returned. */ /***********************************************************/ if (num_sample == 1) last_row = 1; /*************************************************************/ /* Determine how many steps are missing and then multiply */ /* by the number of samples returned to get the length of */ /* the sweep. The assumption is that the number of missing */ /* steps is the same from one scan_index value to the next, */ /* so just use 0 and 1. */ /*************************************************************/ else { base_swp_off = *ptr->hdr_fmt1_ptr->SAMP_INDEX; swp_off = *(ptr->hdr_fmt1_ptr->SAMP_INDEX + 1); last_row = abs (swp_off - base_swp_off) * num_sample; } *etime_ms = *ptr->TIME + time_off + ex->accum_ss_ms + last_row * ex->time_col_ms + time_col * ex->time_row_ms; *etime_ns = dr_time_ns + ex->accum_ss_ns + last_row * ex->time_col_ns + time_col * ex->time_row_ns; } else { base_swp_off = *ptr->hdr_fmt1_ptr->SAMP_INDEX; swp_off = *(ptr->hdr_fmt1_ptr->SAMP_INDEX + (num_sample - 1)); last_row = (ex->da_method == 0) ? num_sample : (ex->da_method == 1) ? ex->swp_len : abs (swp_off - base_swp_off); *etime_ms = *ptr->TIME + time_off + ex->accum_ss_ms + last_row * ex->time_col_ms + time_col * ex->time_row_ms; *etime_ns = dr_time_ns + ex->accum_ss_ns + last_row * ex->time_col_ns + time_col * ex->time_row_ns; } } /***************************************************************************/ /* If the time ends up negative due to negative time_off value, modify */ /* before computing end time and send back flag since day value is not */ /* sent in. */ /***************************************************************************/ if (*etime_ms < 0) { *decrement_eday = 1; *etime_ms += 86400000; } /***************************************************************************/ /* If the nanosecond time element can be converted into milliseconds, do */ /* so and add this to the millisecond time element and keep the leftover */ /* nanoseconds. 1000000 nanoseconds = 1 millisecond. */ /***************************************************************************/ add_ms = *etime_ns / 1000000; *etime_ms += add_ms; *etime_ns = *etime_ns % 1000000; }