/* * 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: open_ancillary.c 22018 2012-12-05 18:59:24Z carrie $ SwRI" #include "gen_defs.h" #include "libbase_idfs.h" #include "ret_codes.h" /******************************************************************************* * * * IR_OPEN_ANCILLARY SUBROUTINE * * * * DESCRIPTION * * This routine retrieves and opens the necessary header, data, and VIDF * * files for the time period and data set requested. For the playback * * scenario, if a filename extension is not given, the default data files * * will be retrieved and opened; otherwise, the data files for the time period* * and filename extension requested will be retrieved and opened. In * * addition, information that is needed from the VIDF file is retrieved, if * * necessary. In addition, the user must specify if mode processing is to be * * done for the data set in question since modes are NOT tied to * * sensor-specific data and need their own ex structure. * * * * 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) * * SDDAS_SHORT closest_btime_yr the start time closest to user-requested * * SDDAS_SHORT closest_btime_day the start time closest to user-requested * * SDDAS_LONG closest_btime_sec the start time closest to user-requested * * SDDAS_LONG closest_btime_nsec the start time closest to user-requested * * 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) * * * * USAGE * * x = ir_open_ancillary (data_key, exten, vnum, closest_btime_yr, * * closest_btime_day, closest_btime_sec, * * closest_btime_nsec, etime_yr, etime_day, * * etime_sec, etime_nsec) * * * * NECESSARY SUBPROGRAMS * * ir_locate_ex() determines if the requested combination has * * already been processed and points to the * * correct structure allocated for the combo * * ir_get_pitch_info() retrieves pitch angle info. from VIDF file * * ir_get_euler_info() retrieves euler angle info. from VIDF file * * ir_get_celestial_position_info() retrieves celestial position info. * * from VIDF file * * ir_get_spin_src_info () retrieves start of spin data source info. * * from the VIDF file * * ir_get_potential_info() retrieves spacecraft potential data source * * info. from VIDF file * * ir_get_background_info() retrieves background data source info from * * VIDF file * * * * EXTERNAL VARIABLES * * struct general_info structure that holds information concerning * * ginfo the experiment that is being processed * * * * INTERNAL VARIABLES * * reg struct experiment_info a pointer to the structure that holds * * *ex specific experiment information * * SDDAS_SHORT ret_val, rval the value returned by the called routine * * * * SUBSYSTEM * * Display Level * * * ******************************************************************************/ SDDAS_SHORT ir_open_ancillary (SDDAS_ULONG data_key, SDDAS_CHAR *exten, SDDAS_USHORT vnum, SDDAS_SHORT closest_btime_yr, SDDAS_SHORT closest_btime_day, SDDAS_LONG closest_btime_sec, SDDAS_LONG closest_btime_nsec, SDDAS_SHORT etime_yr, SDDAS_SHORT etime_day, SDDAS_LONG etime_sec, SDDAS_LONG etime_nsec) { extern struct general_info ginfo; register struct experiment_info *ex; SDDAS_SHORT ret_val, rval; ret_val = ir_locate_ex (data_key, exten, vnum, 0); ex = ginfo.expt; /********************************************************************/ /* Retrieve pitch angle information if we haven't already done so. */ /* After this is done, call LOCATE_EX to point back to original ex */ /* structure requested by the user. */ /********************************************************************/ if (ex->pa_def && ex->bmem.base_pitch_info == NO_MEMORY) { rval = ir_get_pitch_info (closest_btime_yr, closest_btime_day, closest_btime_sec, closest_btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec); ret_val = ir_locate_ex (data_key, exten, vnum, 0); ex = ginfo.expt; if (rval != ALL_OKAY) { ex->swp_times.pa_times = 0; return (rval); } } /********************************************************************/ /* Retrieve spacecraft potential information if we haven't already */ /* done so. After this is done, call LOCATE_EX to point back to */ /* original ex structure requested by the user. */ /********************************************************************/ if (ex->potential_def && ex->bmem.base_potential_info == NO_MEMORY) { rval = ir_get_potential_info (closest_btime_yr, closest_btime_day, closest_btime_sec, closest_btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec); ret_val = ir_locate_ex (data_key, exten, vnum, 0); ex = ginfo.expt; if (rval != ALL_OKAY) { ex->swp_times.pot_times = 0; return (rval); } } /********************************************************************/ /* Retrieve start of spin data source information if we haven't */ /* already done so. After this is done, call LOCATE_EX to point */ /* back to original ex structure requested by the user. */ /********************************************************************/ if (ex->spin_src_def && ex->bmem.base_spin_src == NO_MEMORY) { ret_val = ir_get_spin_src_info (closest_btime_yr, closest_btime_day, closest_btime_sec, closest_btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec); if (ret_val != ALL_OKAY) return (ret_val); ret_val = ir_locate_ex (data_key, exten, vnum, 0); ex = ginfo.expt; } /********************************************************************/ /* Retrieve euler angle information if we haven't already done so. */ /* After this is done, call LOCATE_EX to point back to original ex */ /* structure requested by the user. */ /********************************************************************/ if (ex->euler_def && ex->bmem.base_euler_info == NO_MEMORY) { rval = ir_get_euler_info (closest_btime_yr, closest_btime_day, closest_btime_sec, closest_btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec); ret_val = ir_locate_ex (data_key, exten, vnum, 0); ex = ginfo.expt; if (rval != ALL_OKAY) { ex->swp_times.euler_times = 0; return (rval); } } /********************************************************************/ /* Retrieve celestial position information if we haven't already */ /* done so. After this is done, call LOCATE_EX to point back to */ /* original ex structure requested by the user. */ /********************************************************************/ if (ex->celestial_def && ex->bmem.base_celestial_info == NO_MEMORY) { rval = ir_get_celestial_position_info (closest_btime_yr, closest_btime_day, closest_btime_sec, closest_btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec); ret_val = ir_locate_ex (data_key, exten, vnum, 0); ex = ginfo.expt; if (rval != ALL_OKAY) { ex->swp_times.celestial_times = 0; return (rval); } } /**********************************************************************/ /* Retrieve background information if we haven't already done so. */ /* After this is done, call LOCATE_EX to point back to original ex */ /* structure requested by the user. */ /**********************************************************************/ if (ex->background_def && ex->bmem.base_background_info == NO_MEMORY) { rval = ir_get_background_info (closest_btime_yr, closest_btime_day, closest_btime_sec, closest_btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec); ret_val = ir_locate_ex (data_key, exten, vnum, 0); ex = ginfo.expt; if (rval != ALL_OKAY) { ex->swp_times.background_times = 0; return (rval); } } return (ALL_OKAY); }