![[attach.png]](../../idldoc-resources/attach.png)
external/CDAWlib/
LIST_mystruct.pro
NAME: LIST_mystruct.pro PURPOSE: Generates a list output for CDAWweb CALLING SEQUENCE: FUNCTION LIST_mystruct, a,NOGATT=nogatt,NOVATT=novatt,NORV=norv,$ NONRV=nonrv,NO2DRV=no2drv,FILENAME=filename,$ TSTART=TSTART,TSTOP=TSTOP,MAXRECS=maxrecs VARIABLES: Input: a - an IDL structure Keyword Parameters: nogatt - Global attributes output: =0 (print), =1 (no print) novatt - Variable attributes output: =0 (print), =1 (no print) norv - Record varying output: =0 (print), =1 (no print) nonrv - Non record varying output: =0 (print), =1 (no print) no2drv - 2D record varying output: =0 (print), =1 (no print) filename - Output filename maxrecs - Maximum record output REQUIRED PROCEDURES: HISTORY Initial version: 1.0 R. Baldwin HSTX 2/9/96 Copyright 1996-2013 United States Government as represented by the Administrator of the National Aeronautics and Space Administration. All Rights Reserved.
Routines
Routines from LIST_mystruct.pro
result = remove_excl_pnt(units)NAME: remove_excl_pnt PURPOSE: remove !N, !E, etc from string, so list labels look better Initially written for RBSP data units.
result = ffo_string(format, value)NAME: ffo_string - substitute for string() PURPOSE: allows override of free format I/O specifications INPUT: format - a format specification, value - a value to be string'ed Examples: newstring = ffo_string( 'F10.2', 354.9985 ) newstring = ffo_string( struct.format, struct.dat ) NOTE: this function wraps the format string in parenthesis original version - JWJ 08/08/2000
delete, varNAME: delete.pro PURPOSE: Frees memory INPUT; var - any variable
result = reform_strc(astrc)NAME: reform_strc.pro PURPOSE: Reforms the data array from a (1,N) to a (N).
result = reform_mystruct(astrc)NAME: reform_mystruc.pro PURPOSE: Reforms the data array from a (i,j,k) to a (i*j,k) and (i,j,k,l) to a (i*j*k,l) astrc - Input structure
result = ord_mystruct(astrc, vorder, is)NAME: ord_mystruc.pro PURPOSE: Reorders the given structure so that the dimension of the data variables is increasing w/ each entry.
result = dependn_search(a, i, d)result = label_search(a, sz, i, k)result = unit_search(a, sz, i, k)result = list_header(a, unit, ntags)result = ex_prt(unit, var, var2, slen, k)result = wrt_hybd_strct(a, unit, convar, maxrecs, depend0, mega_num)NAME: wrt_hybd_strct.pro PURPOSE: Prints ascii file of RV or NRV variables
result = form_bld(col_sz, label, units, dat_len, dep_col_sz, depend1_labels, dep2_col_sz, depend2_labels, dep3_col_sz, depend3_labels, form, shft)NAME: form_bld.pro PURPOSE: Builds format statements shft - 0= left justified field; 1= right justified field
result = data_len(format, fillval)NAME: data_len.pro PURPOSE: Determines the length of the data field given FORMAT, FILLVAL
result = ep_conv(b, depd0, HANDLE=HANDLE, sec_of_year=sec_of_year)result = LIST_mystruct(a, NOGATT=NOGATT, NOVATT=NOVATT, NORV=NORV, NONRV=NONRV, NO2DRV=NO2DRV, FILENAME=FILENAME, TSTART=TSTART, TSTOP=TSTOP, START_msec=START_msec, STOP_msec=STOP_msec, MAXRECS=MAXRECS, SEC_OF_YEAR=SEC_OF_YEAR, REPORT=REPORT, STATUS=STATUS, DEBUG=DEBUG)
Routine details
top source remove_excl_pnt
result = remove_excl_pnt(units)
NAME: remove_excl_pnt PURPOSE: remove !N, !E, etc from string, so list labels look better Initially written for RBSP data units. INPUT: units - string OUTPUT: units - cleaned up string Example: newunits = remove_excl_pnt('s!E-1!Ncm!E-2!Nster!E-1!NkeV!E-1!N')
Parameters
- units
top source ffo_string
result = ffo_string(format, value)
NAME: ffo_string - substitute for string() PURPOSE: allows override of free format I/O specifications INPUT: format - a format specification, value - a value to be string'ed Examples: newstring = ffo_string( 'F10.2', 354.9985 ) newstring = ffo_string( struct.format, struct.dat ) NOTE: this function wraps the format string in parenthesis original version - JWJ 08/08/2000
Parameters
- format
- value
top source delete
delete, var
NAME: delete.pro PURPOSE: Frees memory INPUT; var - any variable
Parameters
- var
top source reform_strc
result = reform_strc(astrc)
NAME: reform_strc.pro PURPOSE: Reforms the data array from a (1,N) to a (N). astrc - Input structure
Parameters
- astrc
top source reform_mystruct
result = reform_mystruct(astrc)
NAME: reform_mystruc.pro PURPOSE: Reforms the data array from a (i,j,k) to a (i*j,k) and (i,j,k,l) to a (i*j*k,l) astrc - Input structure
Parameters
- astrc
top source ord_mystruct
result = ord_mystruct(astrc, vorder, is)
NAME: ord_mystruc.pro PURPOSE: Reorders the given structure so that the dimension of the data variables is increasing w/ each entry. astrc - Input structure vorder - An array of the dimension of each variable in the structure RCJ 04/24/2008 Before the structure is reordered, look for vars w/ uncertainties associated w/ them, create and index and reorder the structure according to this index. This will make var and uncertainty be listed side by side.
Parameters
- astrc
- vorder
- is
top source wrt_hybd_strct
result = wrt_hybd_strct(a, unit, convar, maxrecs, depend0, mega_num)
NAME: wrt_hybd_strct.pro PURPOSE: Prints ascii file of RV or NRV variables
Parameters
- a
- unit
- convar
- maxrecs
- depend0
- mega_num
top source form_bld
result = form_bld(col_sz, label, units, dat_len, dep_col_sz, depend1_labels, dep2_col_sz, depend2_labels, dep3_col_sz, depend3_labels, form, shft)
NAME: form_bld.pro PURPOSE: Builds format statements shft - 0= left justified field; 1= right justified field
Parameters
- col_sz
- label
- units
- dat_len
- dep_col_sz
- depend1_labels
- dep2_col_sz
- depend2_labels
- dep3_col_sz
- depend3_labels
- form
- shft
top source data_len
result = data_len(format, fillval)
NAME: data_len.pro PURPOSE: Determines the length of the data field given FORMAT, FILLVAL
Parameters
- format
- fillval
top source ep_conv
result = ep_conv(b, depd0, HANDLE=HANDLE, sec_of_year=sec_of_year)
Parameters
- b
- depd0
Keywords
- HANDLE
- sec_of_year
top source LIST_mystruct
result = LIST_mystruct(a, NOGATT=NOGATT, NOVATT=NOVATT, NORV=NORV, NONRV=NONRV, NO2DRV=NO2DRV, FILENAME=FILENAME, TSTART=TSTART, TSTOP=TSTOP, START_msec=START_msec, STOP_msec=STOP_msec, MAXRECS=MAXRECS, SEC_OF_YEAR=SEC_OF_YEAR, REPORT=REPORT, STATUS=STATUS, DEBUG=DEBUG)
Parameters
- a
Keywords
- NOGATT
- NOVATT
- NORV
- NONRV
- NO2DRV
- FILENAME
- TSTART
- TSTOP
- START_msec
- STOP_msec
- MAXRECS
- SEC_OF_YEAR
- REPORT
- STATUS
- DEBUG
File attributes
| Modification date: | Tue Oct 21 13:53:46 2014 |
| Lines: | 2,142 |