/* * 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: celestial_status.c 20891 2010-09-16 18:50:19Z carrie $ SwRI" #include "ret_codes.h" #include "libdb.h" #include "gen_defs.h" #include "user_defs.h" #include "libbase_idfs.h" #include "vidf_codes.h" /******************************************************************************* * * * IR_CELESTIAL_POSITION_SOURCE_STATUS SUBROUTINE * * * * DESCRIPTION * * This routine should be called to determine the state of the IDFS data * * set to be used for celestial position calculations for the data_key * * specified. This routine was written since it was decided that FILE_OPEN * * and RESET_EXPERIMENT_INFO would return ALL_OKAY if there was an error * * pertinent to the processing of any celestial position source so that the * * main data set could continue to be plotted (in many cases, plotting the * * main data set, not the celestial position data for the main data set). * * If it is determined that celestial position data is needed, the status of * * the celestial position IDFS source can be determined AFTER FILE_OPEN and * * RESET_EXPERIMENT_INFO are called. * * * * 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 *cp_status the status of the celestial position IDFS * * source defined for the specified data set * * SDDAS_ULONG *cp_data_key key which uniquely identifies the data set * * to be used for the celestial position * * calculations * * * * USAGE * * x = ir_celestial_position_source_status (data_key, exten, vnum, * * &cp_status, &cp_data_key) * * * * NECESSARY SUBPROGRAMS * * ir_locate_ex() determines if requested combination has * * already been pand points to the * * correct structure allocated for the combo * * * * EXTERNAL VARIABLES * * struct general_info structure holding 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 celestial_info a pointer to the structure that holds * * *cp_ptr celestial position information * * SDDAS_SHORT ret_val holds called routine status flags * * * * SUBSYSTEM * * Display Level * * * ******************************************************************************/ SDDAS_SHORT ir_celestial_position_source_status (SDDAS_ULONG data_key, SDDAS_CHAR *exten, SDDAS_USHORT vnum, SDDAS_SHORT *cp_status, SDDAS_ULONG *cp_data_key) { extern struct general_info ginfo; struct experiment_info *ex; struct celestial_info *cp_ptr; SDDAS_SHORT ret_val; /**********************************************************************/ /* Get the ex structure for the specified data set. */ /**********************************************************************/ *cp_data_key = 0; ret_val = ir_locate_ex (data_key, exten, vnum, 0); if (ret_val != ALL_OKAY) return (CP_MAIN_DATA_MISSING); /**********************************************************************/ /* Is celestial position data defined for this data set? */ /**********************************************************************/ ex = ginfo.expt; if (!ex->celestial_def) *cp_status = CP_NOT_APPLICABLE; else { /**********************************************************************/ /* Check for non-null memory location in main data source in case */ /* celestial position source also has celestial_def set in the VIDF */ /* file. */ /**********************************************************************/ if (ex->bmem.base_celestial_info != NO_MEMORY) { cp_ptr = ex->celestial_position; /*********************************************************************/ /* If the celestial position angles are defined as constants, */ /* there is no IDFS data source designated to compute the celestial */ /* position angles from. */ /*********************************************************************/ if (cp_ptr->cp_format == CELESTIAL_CONSTANT) *cp_status = CP_READY; else { *cp_data_key = cp_ptr->data_key; /*******************************************************************/ /* Data files are opened and ready to go. */ /*******************************************************************/ if (cp_ptr->file_status == ALL_OKAY) *cp_status = CP_READY; /*******************************************************************/ /* Database errors for designed celestial position IDFS source. */ /*******************************************************************/ else if (cp_ptr->file_status <= DB_START_neg && cp_ptr->file_status >= DB_STOP_neg) *cp_status = CP_DB_ERROR; /*******************************************************************/ /* Data not online for designed celestial position IDFS source. */ /* If there was an error opening the header and/or data file, let */ /* us assume that the file is not online and needs to be promoted.*/ /*******************************************************************/ else if (cp_ptr->file_status >= DB_START_plus || cp_ptr->file_status == PBACK_NO_HEADER || cp_ptr->file_status == PBACK_NO_DATA) *cp_status = CP_DATA_MISSING; /*******************************************************************/ /* VIDF file not online? */ /*******************************************************************/ else if (cp_ptr->file_status == VIDF_NOT_READABLE) *cp_status = CP_DATA_MISSING; /*******************************************************************/ /* IDFS routine returned error after datafiles were opened. */ /*******************************************************************/ else *cp_status = CP_IR_ERROR; } } /****************************************************************************/ /* No celestial position structure so no celestial position IDFS data set. */ /****************************************************************************/ else *cp_status = CP_NOT_APPLICABLE; } return (ALL_OKAY); }