ToBeReviewed/STRUCTURE/
chkstru.pro
check validity of a structure and test if necessary
fields are contained
chkstru
Utilities
result = chkstru(structure, fields, index=string, verbose=verbose, extract=extract)
Return value
CHKSTRU returns 1 if successful, otherwise 0.
Parameters
structure
in
required
type: struct
The structure to be tested. If STRUCTURE is
not of type structure, the function will return 0
fields
in
required
type: string
A string or string array with field names to
be contained in STRUCTURE. CHKSTRU returns 1 (true)
only if all field names are contained in STRUCTURE.
The entries of FIELDS may be upper or lowercase.
Keywords
index
type: string
A named variable that will contain the indices of
the required field names in the structure. They can then
be assessed through structure.(index[i]) . Index will
contain -1 for all fields entries that are not in the
structure.
verbose
set this keyword to return an error message
in case of an error.
extract
set this keyword to extract a fields from the
structure. -1 is return is fields or structure. are
incorrect.
Examples
test = { a:1, b:2, c:3 }
required = ['a','c']
if CHKSTRU(test,required) then print,'found a and c.'
IDL> print, CHKSTRU(test,'b')
1
IDL> print, CHKSTRU(test,'b',/extract)
2
Version history
Version
$Id: chkstru.pro 157 2006-08-21 09:01:50Z navarro $
History
mgs, 02 Mar 1998: VERSION 1.00
mgs, 07 Apr 1998: - second parameter (FIELDS) now optional
12 Jan 2001: EXTRACT keyword by S. Masson (smasson@lodyc.jussieu.fr)
Produced by IDLdoc 2.0 on Tue Aug 29 14:50:33 2006.
