/* * 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 "@(#) spin_dsrc.c 1.1 05/08/19 SwRI" #include "libdb.h" #include "libVIDF.h" #include "libbase_idfs.h" /******************************************************************************* * * * IR_START_SPIN_DATA_SRC SUBROUTINE * * * * DESCRIPTION * * This routine is called to retrieve information from the VIDF file that * * specifies the IDFS data source to use to determine the start of spin for * * the parent IDFS source. * * * * INPUT VARIABLES * * SDDAS_ULONG data_key key which uniquely identifies the data set * * being processed * * SDDAS_SHORT btime_yr the start time requested (year component) * * SDDAS_SHORT btime_day the start time requested (day component) * * SDDAS_LONG btime_sec the start time requested (seconds component)* * SDDAS_LONG btime_nsec the start time requested (nanoseconds) * * SDDAS_SHORT etime_yr the stop time requested (year component) * * SDDAS_SHORT etime_day the stop time requested (day component) * * SDDAS_LONG etime_sec the stop time requested (seconds component) * * SDDAS_LONG etime_nsec the stop time requested (nanoseconds) * * SDDAS_ULONG *spin_src_data_key key which uniquely identifies the data * * set to be used for the start of spin * * determination * * * * USAGE * * x = ir_start_spin_data_src (data_key, btime_yr, btime_day, btime_sec, * * btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, * * &spin_src_data_key) * * * * NECESSARY SUBPROGRAMS * * ReadVIDF() reads information from the VIDF file * * get_data_key () returns the data key for the IDFS source * * ir_get_spin_sinfo_rval () error code from IR_GET_SPIN_SRC_INFO() * * for each possible ReadVIDF() error code * * * * EXTERNAL VARIABLES * * None * * * * INTERNAL VARIABLES * * register SDDAS_CHAR *str_ptr pointer to the string being parsed * * SDDAS_LONG start_at_zero param. passed to ReadVIDF to avoid casting * * SDDAS_SHORT rval holds value returned by called module * * SDDAS_CHAR *proj name of project for start of spin source * * SDDAS_CHAR *mission name of mission for start of spin source * * SDDAS_CHAR *exper name of experiment for start of spin source * * SDDAS_CHAR *inst name of instrument for start of spin source * * SDDAS_CHAR *vinst name of virtual for start of spin source * * SDDAS_CHAR spin_src_def start of spin data source definition flag * * int ret_val holds value returned by called module * * * * SUBSYSTEM * * Display Level * * * ******************************************************************************/ SDDAS_SHORT ir_start_spin_data_src (SDDAS_ULONG data_key, SDDAS_SHORT btime_yr, SDDAS_SHORT btime_day, SDDAS_LONG btime_sec, SDDAS_LONG btime_nsec, SDDAS_SHORT etime_yr, SDDAS_SHORT etime_day, SDDAS_LONG etime_sec, SDDAS_LONG etime_nsec, SDDAS_ULONG *spin_src_data_key) { register SDDAS_CHAR *str_ptr; SDDAS_LONG start_at_zero; SDDAS_SHORT rval; SDDAS_CHAR *proj, *mission, *exper, *inst, *vinst, spin_src_def; /* Leave variable as is, no typedefs */ int ret_val; /**************************************************************************/ /* The following call for spin_src_def is redundant if this module is */ /* not called directly, but called as a result of a call to FILE_OPEN(). */ /**************************************************************************/ start_at_zero = 0; *spin_src_data_key = 0; ret_val = ReadVIDF (data_key, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, (SDDAS_CHAR *) &spin_src_def, _START_SPIN_DEFINED, 0, start_at_zero, -1); if (ret_val < 0) return (ir_get_spin_sinfo_rval (ret_val)); /***************************************************************************/ /* If start of spin data source is not defined for the main data set, */ /* simply return since spin_src_data_key is set to 0 to indicate no start */ /* of spin data key. */ /***************************************************************************/ if (!spin_src_def) return (ALL_OKAY); /**************************************************************************/ /* Retrieve pertinent information from the VIDF file for start of spin */ /* data source. */ /**************************************************************************/ ret_val = ReadVIDF (data_key, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, &proj, _START_SPIN_PROJECT, 0, start_at_zero, -1); if (ret_val < 0) return (ir_get_spin_sinfo_rval (ret_val)); ret_val = ReadVIDF (data_key, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, &mission, _START_SPIN_MISSION, 0, start_at_zero, -1); if (ret_val < 0) return (ir_get_spin_sinfo_rval (ret_val)); ret_val = ReadVIDF (data_key, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, &exper, _START_SPIN_EXPER, 0, start_at_zero, -1); if (ret_val < 0) return (ir_get_spin_sinfo_rval (ret_val)); ret_val = ReadVIDF (data_key, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, &inst, _START_SPIN_INST, 0, start_at_zero, -1); if (ret_val < 0) return (ir_get_spin_sinfo_rval (ret_val)); ret_val = ReadVIDF (data_key, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, &vinst, _START_SPIN_VINST, 0, start_at_zero, -1); if (ret_val < 0) return (ir_get_spin_sinfo_rval (ret_val)); /**************************************************************************/ /* Make sure string is null terminated for comparison reasons. */ /**************************************************************************/ str_ptr = proj; while (*str_ptr != ' ' && *str_ptr != 0) ++str_ptr; if (*str_ptr == ' ') *str_ptr = '\0'; str_ptr = mission; while (*str_ptr != ' ' && *str_ptr != 0) ++str_ptr; if (*str_ptr == ' ') *str_ptr = '\0'; str_ptr = exper; while (*str_ptr != ' ' && *str_ptr != 0) ++str_ptr; if (*str_ptr == ' ') *str_ptr = '\0'; str_ptr = inst; while (*str_ptr != ' ' && *str_ptr != 0) ++str_ptr; if (*str_ptr == ' ') *str_ptr = '\0'; str_ptr = vinst; while (*str_ptr != ' ' && *str_ptr != 0) ++str_ptr; if (*str_ptr == ' ') *str_ptr = '\0'; rval = get_data_key (proj, mission, exper, inst, vinst, spin_src_data_key); if (rval != ALL_OKAY) return (rval); return (ALL_OKAY); }