/* * 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_src_tbls.c 1.1 05/08/19 SwRI" #include #include "gen_defs.h" #include "ret_codes.h" #include "libVIDF.h" #include "libbase_idfs.h" /******************************************************************************* * * * IR_START_SPIN_SRC_TBL_INFO SUBROUTINE * * * * DESCRIPTION * * This routine is called to retrieve the table information for the start * * of spin data source. This information is used to convert the start of * * spin designated sensor value into the correct units. In some cases, there * * may be no tables to apply; that is, the data may have been stored in * * "processed" units already. * * * * INPUT VARIABLES * * 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) * * * * USAGE * * x = ir_start_spin_src_tbl_info (btime_yr, btime_day, btime_sec, * * btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec)* * * * NECESSARY SUBPROGRAMS * * sizeof () the size of the specified object in bytes * * malloc() allocates memory * * ReadVIDF() reads information from the VIDF file * * ir_get_spin_sinfo_rval () error code from IR_GET_SPIN_SRC_INFO() * * for each possible ReadVIDF() error code * * * * EXTERNAL VARIABLES * * struct general_info ginfo structure that holds information concerning * * the experiment that is being processed * * * * INTERNAL VARIABLES * * struct experiment_info *ex a pointer to the structure that holds * * specific experiment information * * struct spin_src_info a pointer to the structure that holds * * *spin_src_ptr start of spin data source information * * register SDDAS_SHORT i looping variable * * SDDAS_ULONG data_key key which uniquely identifies the data set * * being processed * * SDDAS_LONG offset index into allocated memory * * SDDAS_LONG start_at_zero param. passed to ReadVIDF to avoid casting * * SDDAS_SHORT temp_var temporary variable * * size_t bytes the number of bytes to allocate * * size_t num_bytes_sshort the number of bytes needed for a SDDAS_SHORT* * int ret_val holds value returned by called module * * void *tmp_ptr pointer which holds address passed back by * * the call to the MALLOC routine * * * * SUBSYSTEM * * Display Level * * * ******************************************************************************/ SDDAS_SHORT ir_start_spin_src_tbl_info (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) { extern struct general_info ginfo; struct experiment_info *ex; struct spin_src_info *spin_src_ptr; register SDDAS_SHORT i; SDDAS_ULONG data_key; SDDAS_LONG offset, start_at_zero; SDDAS_SHORT temp_var; /* Leave variables as is, no typedefs */ size_t bytes; int ret_val; void *tmp_ptr; /*************************************************************************/ /* Retrieve the table information for start of spin data source. */ /* Allocate the space since the number of tables may vary. */ /*************************************************************************/ ex = ginfo.expt; data_key = ex->data_key; spin_src_ptr = ex->spin_src; start_at_zero = 0; ret_val = ReadVIDF (data_key, btime_yr, btime_day, btime_sec, btime_nsec, etime_yr, etime_day, etime_sec, etime_nsec, (SDDAS_CHAR *) &temp_var, _START_SPIN_APPS, 0, start_at_zero, -1); if (ret_val < 0) return (ir_get_spin_sinfo_rval (ret_val)); spin_src_ptr->num_tbls = (SDDAS_CHAR) temp_var; /*************************************************************************/ /* Make sure there are tables to be applied to convert the data into */ /* units, in case the data is not stored "raw". */ /*************************************************************************/ if (spin_src_ptr->num_tbls > 0) { size_t num_bytes_sshort; num_bytes_sshort = sizeof (SDDAS_SHORT); bytes = (num_bytes_sshort + sizeof (SDDAS_CHAR)) * spin_src_ptr->num_tbls; if ((tmp_ptr = malloc (bytes)) == NO_MEMORY) return (SPIN_SRC_TBL_MALLOC); spin_src_ptr->base_tbls = tmp_ptr; spin_src_ptr->tbl_oper = (SDDAS_SHORT *) spin_src_ptr->base_tbls; /* Cast base_tbls to char * since void * and offset is in bytes. */ offset = spin_src_ptr->num_tbls * num_bytes_sshort; spin_src_ptr->tbl_apply = (SDDAS_CHAR *) ((SDDAS_CHAR *) spin_src_ptr->base_tbls + offset); /**********************************************************************/ /* The IDFS software says tables to apply are chars BUT vidf defines */ /* START_SPIN_TBLS as shorts. Read into tbl_oper space and copy */ /* values into tbl_apply to save as chars. */ /**********************************************************************/ 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_ptr->tbl_oper, _START_SPIN_TBLS, 0, start_at_zero, -1); if (ret_val < 0) return (ir_get_spin_sinfo_rval (ret_val)); for (i = 0; i < spin_src_ptr->num_tbls; ++i) *(spin_src_ptr->tbl_apply + i) = (SDDAS_CHAR) *(spin_src_ptr->tbl_oper + i); 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_ptr->tbl_oper, _START_SPIN_OPS, 0, start_at_zero, -1); if (ret_val < 0) return (ir_get_spin_sinfo_rval (ret_val)); } return (ALL_OKAY); }