/* * 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 "@(#) $Id: new_idf_pot.c 21639 2011-12-01 22:28:43Z carrie $ SwRI" #include #include "gen_defs.h" #include "ret_codes.h" #include "libbase_idfs.h" /******************************************************************************* * * * IR_NEW_IDF_FILE_POTENTIAL SUBROUTINE * * * * DESCRIPTION * * This module is called when a new VIDF file is to be retrieved and the * * spacecraft potential information is to be picked up again in case of a * * change. * * * * INPUT VARIABLES * * SDDAS_SHORT btime_yr, start time for VIDF file to be retrieved * * btime_day * * SDDAS_LONG btime_sec, start time for VIDF file to be retrieved * * btime_nsec * * * * USAGE * * x = ir_new_idf_file_potential(btime_yr, btime_day, btime_sec, btime_nsec)* * * * NECESSARY SUBPROGRAMS * * strcpy() copies a string to another string variable * * file_pos() positions the data/header files for the * * data source at the desired start time * * ir_get_potential_info() retrieves spacecraft potential information * * from VIDF file * * ir_locate_ex() determines if the requested combination has * * already been processed and points to the * * correct structure allocated for the combo * * * * EXTERNAL VARIABLES * * struct general_info structure that holds information concerning * * ginfo the experiment that is being processed * * * * INTERNAL VARIABLES * * struct experiment_info ptr to the structure that holds info. * * *ex pertinent to the current IDFS data source * * being processed * * struct experiment_info a ptr to the structure that holds info. * * *pot_ex pertinent to the spacecraft potential data * * source associated with the current IDFS * * data source being processed * * struct potential_info a pointer to the structure that holds space-* * *potential_ptr craft potential information * * SDDAS_ULONG main_dkey data key for parent source * * SDDAS_LONG etime_sec, user-requested end time * * etime_nsec * * SDDAS_LONG hold_offset some applications use this value & file_pos * * will override this value * * SDDAS_USHORT main_version version number for parent source * * SDDAS_SHORT rval, ret_val the value returned by the called routine * * SDDAS_SHORT etime_yr, user-requested end time * * etime_day * * SDDAS_CHAR main_exten[] filename extension for parent source * * * * SUBSYSTEM * * Display Level * * * ******************************************************************************/ SDDAS_SHORT ir_new_idf_file_potential (SDDAS_SHORT btime_yr, SDDAS_SHORT btime_day, SDDAS_LONG btime_sec, SDDAS_LONG btime_nsec) { extern struct general_info ginfo; struct experiment_info *ex, *pot_ex; struct potential_info *potential_ptr; SDDAS_ULONG main_dkey; SDDAS_LONG etime_sec, etime_nsec, hold_offset; SDDAS_USHORT main_version; SDDAS_SHORT rval, ret_val, etime_yr, etime_day; SDDAS_CHAR main_exten[3]; /***************************************************************************/ /* Point to the parent ex structure. */ /***************************************************************************/ ex = ginfo.expt; main_dkey = ex->data_key; main_version = ex->version; strcpy (main_exten, ex->exten); etime_yr = ex->requested_time.etime_year; etime_day = ex->requested_time.etime_day; etime_sec = ex->requested_time.etime_sec; etime_nsec = ex->requested_time.etime_nsec; /********************************************************************/ /* Retrieve spacecraft potential information if still pertinent. */ /********************************************************************/ rval = ir_get_potential_info (btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec); if (rval != ALL_OKAY) { /*****************************************************************/ /* Reset ex pointer to parent source before returning on error. */ /* Shouldn't have to check but gets rid of compiler warning. */ /*****************************************************************/ ret_val = ir_locate_ex (main_dkey, main_exten, main_version, 0); if (ret_val == ALL_OKAY) { ex = ginfo.expt; ex->swp_times.pot_times = 0; } return (rval); } /**************************************************************************/ /* After calling previous module, current ex structure is the spacecraft */ /* potential source IF all went well; otherwise, pointing to same ex. */ /* Save the next_offset value since this element is used by some */ /* applications to know how many data parameters are tied to this */ /* ex structure (file_pos will overwrite this value). */ /**************************************************************************/ pot_ex = ginfo.expt; if (pot_ex != ex) { rval = ir_locate_ex (main_dkey, main_exten, main_version, 0); ex = ginfo.expt; potential_ptr = ex->potential; /*************************************************************************/ /* If the spacecraft potential source has been successfully identified, */ /* try to position it again if the spacecraft potential values are to */ /* be computed from an IDFS data source. */ /*************************************************************************/ if (potential_ptr->scpot_format == SCPOT_DSRC && potential_ptr->file_status == ALL_OKAY) { pot_ex->fnext = 0; hold_offset = pot_ex->next_offset; /*********************************************************************/ /* Position the data file at the requested start time. This is done*/ /* since spacecraft potential source may have changed from one VIDF */ /* to the next when multiple VIDF's are handled. */ /*********************************************************************/ rval = file_pos (potential_ptr->data_key, potential_ptr->exten, potential_ptr->version, potential_ptr->idf_data_ptr, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec); if (rval != ALL_OKAY) { /*****************************************************************/ /* Reset ex pointer to parent source before returning on error. */ /*****************************************************************/ ret_val = ir_locate_ex (main_dkey, main_exten, main_version, 0); return (rval); } /***********************************************************************/ /* Put back next_offset value in spacecraft potential structure since */ /* it was overwritten by file_pos (). */ /***********************************************************************/ ginfo.expt->next_offset = hold_offset; } } /*****************************************************************/ /* Reset ex pointer to parent source before returning. */ /*****************************************************************/ ret_val = ir_locate_ex (main_dkey, main_exten, main_version, 0); return (ALL_OKAY); }