Next: NDG_PUTPROV - Add an NDF to the list of ancestors
Up: Routines for accessing NDF Provenance
Previous: NDG_ISHIDDENPROV - See if an ancestor in a provenance structure is hidden
NDG_MODIFYPROV
- Modify the information stored for a particular ancestor
- Description:
- This routine modifies the information stored for a given ancestor
in the supplied provenance structure. The new values to store
are supplied in an AST KeyMap such as returned by NDG_GETPROV.
- Invocation:
- CALL NDG_MODIFYPROV( IPROV, IANC, KM, MORE, STATUS )
- Arguments:
-
-
IPROV = INTEGER (Given)
-
An identifier for a structure holding the provenance information
read from an NDF, as returned by NDG_READPROV.
-
IANC = INTEGER (Given)
-
The index of the ancestor NDF for which information should be
modified. A value of zero will result in information about the NDF
specified by INDF being modified. Otherwise, the IANC value
is used as an index into the ANCESTORS array. An error is reported
if IANC is too large.
-
KM = INTEGER (Given)
-
A pointer to an AST KeyMap containing the values to store. Entries
with the following keys are recognised:
- "PATH": A string holding the path of the ancestor NDF.
- "DATE": A string holding the formatted UTC date and time at
which the provenance information for the ancestor NDF was
recorded.
- "CREATOR": A string identifying the software that created the
ancestor NDF.
- "MORE": A KeyMap containing extra information to store at the
top level of the MORE component for the ancestor. Only entries
holding primitive data values (scalar or vector) are used -
entries holding nested KeyMaps, etc, are ignored. If an entry in
this KeyMap has the same name as a component in the supplied
MORE HDS structure, then the KeyMap value is used in preference to
the HDS value.
If the "DATE" or "CREATOR" components are missing then the
corresponding item of information will be deleted from the
provenance extension. To delete the "MORE" component in the
provenance extension, supply a KeyMap without a MORE entry, and
also supply DAT_NOLOC for the "more" argument. An error is
reported if the supplied KeyMap has no "PATH" entry. Note, the
PARENTS list and HISTORY information stored with the specified
ancestor cannot be modified (any "PARENTS" or "HISTORY"
component in the supplied HDS structure will be ignored).
-
MORE = CHARACTER
(DAT__SZLOC) (Given)
-
A locator for an HDS object containing additional information to
be associated with the requested ancestor. DAT__NOLOC may be
supplied for this argument. The contents of the MORE component
in the provenance extension will be the union of any structure
supplied through this argument, and any values supplied through
the MORE entry in the supplied KeyMap. If the same component
name occurs in both, then the KeyMap value takes precedence.
-
STATUS = INTEGER (Given and Returned)
-
The global status.
Next: NDG_PUTPROV - Add an NDF to the list of ancestors
Up: Routines for accessing NDF Provenance
Previous: NDG_ISHIDDENPROV - See if an ancestor in a provenance structure is hidden
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