SUBROUTINE ADI2_GKEY0I( FID, HDU, KEY, MARK, GETCOM, VALUE,
: COMNT, STATUS )
*+
* Name:
* ADI2_GKEY0I
* Purpose:
* Get a keyword value from the buffer structures
* Language:
* Starlink Fortran
* Invocation:
* CALL ADI2_GKEY0I( FID, HDU, KEY, MARK, GETCOM, VALUE, COMNT, STATUS )
* Description:
* Get value of a keyword to be written to a FITS file object from its
* keyword buffer, and optionally mark it as committed to disk. The
* routine returns the keyword value and optionally the comment.
* Arguments:
* FID = INTEGER (given)
* ADI identifier of FITSfile object
* HDU = CHARACTER*(*) (given)
* Logical HDU whose keyword this is. Blank for primary
* KEY = CHARACTER*(*) (given)
* Name of the keyword. Same as the FITS keyword name, so should be
* less than 9 characters in length
* MARK = LOGICAL (given)
* Mark the keyword as committed to disk
* GETCOM = LOGICAL (given)
* Get the keyword comment value?
* VALUE = INTEGER (returned)
* The value for the keyword
* COMNT = CHARACTER*(*) (returned)
* The keyword comment, returned if GETCOM is true
* STATUS = INTEGER (given and returned)
* The global status.
* Examples:
* {routine_example_text}
* {routine_example_description}
* Pitfalls:
* {pitfall_description}...
* Notes:
* {routine_notes}...
* Prior Requirements:
* {routine_prior_requirements}...
* Side Effects:
* {routine_side_effects}...
* Algorithm:
* {algorithm_description}...
* Accuracy:
* {routine_accuracy}
* Timing:
* {routine_timing}
* External Routines Used:
* {name_of_facility_or_package}:
* {routine_used}...
* Implementation Deficiencies:
* {routine_deficiencies}...
* References:
* ADI Subroutine Guide : http://www.sr.bham.ac.uk/asterix-docs/Programmer/Guides/adi.html
* Keywords:
* package:adi, usage:private
* Copyright:
* Copyright (C) University of Birmingham, 1995
* Authors:
* DJA: David J. Allan (Jet-X, University of Birmingham)
* {enter_new_authors_here}
* History:
* 2 Feb 1995 (DJA):
* Original version.
* {enter_changes_here}
* Bugs:
* {note_any_bugs_here}
*-
* Type Definitions:
IMPLICIT NONE ! No implicit typing
* Global Constants:
INCLUDE 'SAE_PAR' ! Standard SAE constants
* Arguments Given:
INTEGER FID ! File identifier
CHARACTER*(*) HDU ! HDU name
CHARACTER*(*) KEY ! Keyword name
LOGICAL MARK ! Mark as committed
LOGICAL GETCOM ! Retrieve comment?
* Arguments Returned:
INTEGER VALUE ! Value of the keyword
CHARACTER*(*) COMNT ! Keyword comment
* Status:
INTEGER STATUS ! Global status
* Local Variables:
INTEGER HID ! HDU identifier
INTEGER KID ! Keyword identifier
INTEGER KSID ! Keyword structure id
LOGICAL THERE ! Object exists?
*.
* Check inherited global status.
IF ( STATUS .NE. SAI__OK ) RETURN
* Locate the HDU structure to contain the keyword
CALL ADI2_LOCHDU( FID, HDU, HID, STATUS )
* Locate the HDU's keyword list
CALL ADI_FIND( HID, 'Keys', KSID, STATUS )
* Does the keyword already exist?
CALL ADI_THERE( KSID, KEY, THERE, STATUS )
IF ( THERE ) THEN
* Get the value
CALL ADI_CGET0I( KSID, KEY, VALUE, STATUS )
* Need to locate the key object?
IF ( MARK .OR. GETCOM ) THEN
* Locate the keyword
CALL ADI_FIND( KSID, KEY, KID, STATUS )
* Mark as committed?
IF ( MARK ) THEN
CALL ADI_CPUT0L( KID, '.COMMITTED', .TRUE., STATUS )
END IF
* User wants the comment?
IF ( GETCOM ) THEN
CALL ADI_THERE( KID, '.COMMENT', THERE, STATUS )
IF ( THERE ) THEN
CALL ADI_CGET0C( KID, '.COMMENT', COMNT, STATUS )
ELSE
CALL ADI2_STDCMT( KEY, COMNT, STATUS )
END IF
END IF
* Release the keyword
CALL ADI_ERASE( KID, STATUS )
END IF
* Do some checks here? Committed to disk? Same value etc?
ELSE
CALL MSG_SETC( 'KEY', KEY )
CALL ERR_REP( ' ', 'Keyword ^KEY has not been defined', STATUS )
END IF
* Free the identifiers
CALL ADI_ERASE( KSID, STATUS )
CALL ADI_ERASE( HID, STATUS )
* Report any errors
IF ( STATUS .NE. SAI__OK )
: CALL AST_REXIT( 'ADI2_PKEY0I', STATUS )
END