Next: Abstract

HDS
Hierarchical Data System
Version 4.3
Programmer's Manual

Starlink User Note 92.12
R.F. Warren-Smith & M.D. Lawden
23rd February 1999

CCLRC / Rutherford Appleton Laboratory
Particle Physics & Astronomy Research Council

Starlink Project

Retrieve hardcopy

Abstract
INTRODUCTION
OBJECTS
- Name
- Type
- Shape
- State
- Group
- Value
- Illustration
ROUTINES AND CONSTANTS
- Routine Names
- Symbolic Names and Include Files
CREATING OBJECTS
WRITING AND READING OBJECTS
ACCESSING OBJECTS BY MAPPING
MAPPING CHARACTER DATA
COPYING AND DELETING OBJECTS
SUBSETS OF OBJECTS
TEMPORARY OBJECTS
USING LOCATORS
- Locator Validity
- Annulling Locators
- Cloning Locators
- Primary and Secondary Locators
- Container File Reference Counts
- Promoting and Demoting Locators
ENQUIRIES
PACKAGED ROUTINES
TUNING
- Setting HDS Tuning Parameters
- Tuning Parameters Available
- Tuning in Practice
COMPILING AND LINKING
ACKNOWLEDGEMENTS
ALPHABETICAL LIST OF HDS ROUTINES
ROUTINE DESCRIPTIONS
- CMP_GET0x - Read scalar component
- CMP_GET1x - Read vector component
- CMP_GETNx - Read array component
- CMP_GETVx - Read vectorised component
- CMP_LEN - Enquire component precision
- CMP_MAPN - Map array component
- CMP_MAPV - Map vectorised component
- CMP_MOD - Ensure component exists
- CMP_MODC - Ensure that string component exists
- CMP_PRIM - Enquire component primitive
- CMP_PUT0x - Write scalar component
- CMP_PUT1x - Write vector component
- CMP_PUTNx - Write array component
- CMP_PUTVx - Write vectorised component
- CMP_SHAPE - Enquire component shape
- CMP_SIZE - Enquire component size
- CMP_STRUC - Enquire component structure
- CMP_TYPE - Enquire component type
- CMP_UNMAP - Unmap component
- DAT_ALTER - Alter object size
- DAT_ANNUL - Annul locator
- DAT_BASIC - Map primitive as basic units
- DAT_CCOPY - Copy one structure level
- DAT_CCTYP - Create type string
- DAT_CELL - Locate cell
- DAT_CLEN - Obtain character string length
- DAT_CLONE - Clone locator
- DAT_COERC - Coerce object shape
- DAT_COPY - Copy object
- DAT_DREP - Obtain primitive data representation information
- DAT_ERASE - Erase component
- DAT_ERMSG - Translate a status value into an error message
- DAT_FIND - Find named component
- DAT_GET - Read primitive
- DAT_GETx - Read primitive
- DAT_GET0x - Read scalar primitive
- DAT_GET1x - Read vector primitive
- DAT_GETNx - Read array primitive
- DAT_GETVx - Read vectorised primitive
- DAT_INDEX - Index into component list
- DAT_LEN - Enquire primitive length
- DAT_MAP - Map primitive
- DAT_MAPx - Map primitive
- DAT_MAPN - Map array primitive
- DAT_MAPV - Map vectorised primitive
- DAT_MOULD - Alter object shape
- DAT_MOVE - Move object
- DAT_MSG - Assign the name of an HDS object to a message token
- DAT_NAME - Enquire object name
- DAT_NCOMP - Enquire number of components
- DAT_NEW - Create component
- DAT_NEW0x - Create scalar component
- DAT_NEW0C - Create scalar string component
- DAT_NEW1x - Create vector component
- DAT_NEW1C - Create vector string component
- DAT_NEWC - Create string component
- DAT_PAREN - Locate parent structure
- DAT_PREC - Enquire storage precision
- DAT_PRIM - Enquire object primitive
- DAT_PRMRY - Set or enquire primary/secondary locator status
- DAT_PUT - Write primitive
- DAT_PUTx - Write primitive
- DAT_PUT0x - Write scalar primitive
- DAT_PUT1x - Write vector primitive
- DAT_PUTNx - Write array primitive
- DAT_PUTVx - Write vectorised primitive
- DAT_REF - Obtain a reference for an HDS object
- DAT_REFCT - Enquire the reference count for a container file
- DAT_RENAM - Rename object
- DAT_RESET - Reset object state
- DAT_RETYP - Change object type
- DAT_SHAPE - Enquire object shape
- DAT_SIZE - Enquire object size
- DAT_SLICE - Locate slice
- DAT_STATE - Enquire object state
- DAT_STRUC - Enquire object structure
- DAT_TEMP - Create temporary object
- DAT_THERE - Enquire component existence
- DAT_TYPE - Enquire object type
- DAT_UNMAP - Unmap object
- DAT_VALID - Enquire locator valid
- DAT_VEC - Vectorise object
- DAT_WHERE - Find position of primitive in HDS file
- HDS_COPY - Copy an object to a new container file
- HDS_ERASE - Erase container file
- HDS_EWILD - End a wild-card search for HDS container files
- HDS_FLUSH - Flush locator group
- HDS_FREE - Free container file
- HDS_GROUP - Enquire locator group
- HDS_GTUNE - Obtain tuning parameter value
- HDS_LINK - Link locator group
- HDS_LOCK - Lock container file
- HDS_NEW - Create container file
- HDS_OPEN - Open container file
- HDS_SHOW - Show HDS statistics
- HDS_STATE - Enquire the current state of HDS
- HDS_STOP - Close down HDS
- HDS_TRACE - Trace object path
- HDS_TUNE - Set HDS tuning parameter
- HDS_WILD - Perform a wild-card search for HDS container files
OBSOLETE ROUTINES
- DAT_CONV - Enquire data conversion
- DAT_ERDSC - Report object error
- DAT_ERDSN - Report component error
- DAT_ERTXT - Report error
- DAT_RCERA - Recursive erase
- DAT_RCOPY - Recursive copy
- DAT_TUNE - Set HDS parameter
- HDS_CLOSE - Close container file
- HDS_RUN - Run an HDS application subroutine
- HDS_START - Start up HDS
ERROR CODES
- Error Code Descriptions
- Obsolete Error Codes
MACHINE-DEPENDENT FEATURES
- File Naming
- Wild-Card File Searching
- File Mapping
- Scratch Files
- File Locking
CHANGES AND NEW FEATURES
- Changes in V4.1
- Changes in V4.2
- Changes in V4.3
About this document ...

Next: Abstract

HDS Hierarchical Data System Version 4.3 Programmer's Manual

CCLRC / Rutherford Appleton Laboratory Particle Physics & Astronomy Research Council

Starlink Project

Contents

HDS
Hierarchical Data System
Version 4.3
Programmer's Manual

CCLRC / Rutherford Appleton Laboratory
Particle Physics & Astronomy Research Council