next up previous 207
Next: NDG_FORMATPROV - Format the information in a provenance structure
Up: Routines for accessing NDF Provenance
Previous: NDG_COUNTPROV - Return the number of ancestors in a provenance structure


NDG_ENDPV - End an NDF provenance block

Description:
This routine should be called to mark the end of an NDF provenance block. The block should have been started by a matching call to NDG_BEGPV. Note, provenance blocks must not be nested.

During a provenance block, a list is maintained of all the existing NDFs that have had their Data array mapped (either in read or update mode) during the block. Another list is maintained of all the NDFs that have been written (either existing NDFs accessed in update mode or new NDFs) during the block.

When the block ends, the provenance information within each NDF in the second may be modified to include all the NDFs in the first list as parents. Whether or not this occurs is controlled by the AUTOPROV environment variable. If AUTOPROV is set to '1' then the input NDFs are added to the provenance information in the output NDF. If AUTOPROV is set to anything other than '1' then the output provenance is not updated. If AUTOPROV is not set at all, then the output provenance will be updated only if one or more of the input NDFs contains a PROVENANCE extension.


Invocation:
CALL NDG_ENDPV( CREATR, STATUS )

Arguments:

CREATR = CHARACTER $*$ ( $*$ ) (Given)
An identifier for the calling application. The format of the identifier is arbitrary, but the form "PACKAGE:COMMAND" is recommended.
STATUS = INTEGER (Given and Returned)
The global status.



next up previous 207
Next: NDG_FORMATPROV - Format the information in a provenance structure
Up: Routines for accessing NDF Provenance
Previous: NDG_COUNTPROV - Return the number of ancestors in a provenance structure

NDG [1ex
Starlink User Note 2
D.S. Berry
M.B. Taylor
22nd October 2009
E-mail:ussc@star.rl.ac.uk

Copyright © 2000 Council for the Central Laboratory of the Research Councils