Next: The PROVENANCE Extension:
Up: Routines for accessing NDF Provenance
Previous: Routines for accessing NDF Provenance
The following public functions are available. There is an equivalent set
of F77 routines with names formed by converting the C name to upper case
and inserting an underscore after the initial ``NDG'' string (C and F77
versions are - for the most part - documented individually in separate
prologues below):
- ndgCopyProv: Create a deep copy of a provenance structure.
- ndgBegpv: Begin an NDF provenance block.
- ndgCountProv: Return the number of ancestors in a provenance structure.
- ndgFormatProv: Format all the information in a provenance structure.
- ndgEndpv: End an NDF provenance block.
- ndgFreeProv: Free the resources used by a provenance structure.
- ndgGetProv: Get information about a specific ancestor.
- ndgHideProv: Hide a specific ancestor.
- ndgHltpv: Temporarily stop recording NDFs within a provenance block
- ndgIsHiddenProv: See if an ancestor is hidden.
- ndgModifyProv: Modify information stored for a specific ancestor.
- ndgPutProv: Add a new ancestor NDF into a provenance structure.
- ndgReadProv: Create a new provenance structure by reading a given NDF.
- ndgRemoveProv: Remove ancestors from a provenance structure.
- ndgRootProv: Identify root ancestors in a provenance structure.
- ndgUnhideProv: Ensure an ancestor is not hidden.
- ndgWriteProv: Writes a provenance structure out to an NDF.
Note, within a provenance block, it is possible to prevent selected NDFs
receiving provenance by using ndgHltpv (NDG_HLTPV) to stop the recording
of NDF names before the NDFs are accessed, and then calling ndgHltpv
again afterwards to re-establish the recording of NDF names.
Next: The PROVENANCE Extension:
Up: Routines for accessing NDF Provenance
Previous: Routines for accessing NDF Provenance
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