No longer use an attribute for structure dimensionality

If the dimensionality attribute is missing the structure
is scalar. Else read the dimensionality attribute and the
number of elements in that tells you the dimensionality.

This saves one attribute per HDF5 group.

Author: timj

Makefile.am

@@ -155,6 +155,7 @@ dat1GetBounds.c \
 dat1Getenv.c \
 dat1GetFullName.c \
 dat1GetParentID.c \
+dat1GetStructureDims.c \
 dat1H5EtoEMS.c \
 dat1ImportDims.c \
 dat1ImportFloc.c \

dat1.h

@@ -135,7 +135,6 @@ typedef enum {
 /* Names of attributes */
 #define HDS__ATTR_DEFINED "HDS_DATASET_IS_DEFINED?"
 #define HDS__ATTR_STRUCT_TYPE "CLASS"
-#define HDS__ATTR_STRUCT_NDIMS "HDS_STRUCTURE_NDIMS"
 #define HDS__ATTR_STRUCT_DIMS "HDS_STRUCTURE_DIMS"
 
 /* Private definition of the HDS locator struct */
@@ -393,5 +392,8 @@ int dat1Annul( HDSLoc *locator, int * status );
 
 hid_t dat1GetParentID( hid_t objid, hdsbool_t allow_root, int *status );
 
+int
+dat1GetStructureDims( const HDSLoc * locator, int maxdims, hdsdim dims[], int *status );
+
 /* DAT1_H_INCLUDED */
 #endif

dat1CreateStructureCell.c

@@ -120,12 +120,10 @@ dat1CreateStructureCell( hid_t group_id, size_t index, const char * typestr, con
            emsRepf("dat1New_4", "Error creating structure/group '%s'", status, parentstr)
            );
 
-  /* Actual data type of the structure/group must be stored in an attribute */
+  /* Actual data type of the structure/group must be stored in an attribute.
+     Do not need to store dimensions as each cell is itself scalar. */
   dat1SetAttrString( cellgroup_id, HDS__ATTR_STRUCT_TYPE, typestr, status );
 
-  /* Also store the number of dimensions */
-  dat1SetAttrInt( cellgroup_id, HDS__ATTR_STRUCT_NDIMS, scalardims, status );
-
  CLEANUP:
   if (*status != SAI__OK) {
     if (cellgroup_id > 0) {

dat1GetBounds.c

@@ -43,6 +43,8 @@
 *  History:
 *     2014-09-15 (TIMJ):
 *        Initial version
+*     2014-11-21 (TIMJ):
+*        Use dat1GetStructDims
 *     {enter_further_changes_here}
 
 *  Copyright:
@@ -127,22 +129,12 @@ dat1GetBounds( const HDSLoc * locator, hdsdim lower[DAT__MXDIM],
   }
 
   if (dat1IsStructure( locator, status ) ) {
-    /* Assume scalar structure if we are missing the attribute */
-    rank = dat1GetAttrInt( locator->group_id, HDS__ATTR_STRUCT_NDIMS, HDS_TRUE, 0, status );
+
+    /* Query the dimensions of the structure */
+    rank = dat1GetStructureDims( locator, DAT__MXDIM, upper, status );
 
     if (rank > 0) {
       int i;
-      size_t actvals = 0; /* sanity check */
-      dat1GetAttrHdsdims( locator->group_id, HDS__ATTR_STRUCT_DIMS, HDS_FALSE,
-                          0, NULL, DAT__MXDIM, upper, &actvals, status );
-
-      if (rank != (int)actvals) {
-        *status = DAT__DIMIN;
-        emsRepf("datshape_1b", "datBounds: Inconsistency in object dimensions of structure (%d != %zu)",
-                status, rank, actvals);
-        goto CLEANUP;
-      }
-
       for (i=0; i<rank; i++) {
         lower[i] = 1;
       }

dat1GetStructureDims.c

@@ -0,0 +1,110 @@
+/*
+*+
+*  Name:
+*     dat1GetStructureDims
+
+*  Purpose:
+*     Obtains dimensions of a structure
+
+*  Language:
+*     Starlink ANSI C
+
+*  Type of Module:
+*     Library routine
+
+*  Invocation:
+*     rank = dat1GetStructureDims( const HDSLoc * locator, int maxdims, hdsdim dims[],
+*                                  int *status );
+
+*  Arguments:
+*     locator = const HDSLoc * (Given)
+*        Locator to structure object.
+*     maxdims = int (Given)
+*        Allocated size of dims[]
+*     dims = hdsdim (Given & Returned)
+*        On exit will contain the dimensions of the structure. Will not
+*        be touched if rank is 0. Only rank elements will be stored.
+*     status = int* (Given and Returned)
+*        Pointer to global status.
+
+*  Description:
+*     Calculates the dimensionality or rank of a structure and returns
+*     the appropriate dimensions.
+
+*  Returned Value:
+*     rank = int
+*        Dimensionality of the structure. Can be 0 for a scalar structure.
+
+*  Authors:
+*     TIMJ: Tim Jenness (Cornell)
+*     {enter_new_authors_here}
+
+*  Notes:
+*     
+
+*  History:
+*     2014-11-21 (TIMJ):
+*        Initial version
+*     {enter_further_changes_here}
+
+*  Copyright:
+*     Copyright (C) 2014 Cornell University
+*     All Rights Reserved.
+
+*  Licence:
+*     Redistribution and use in source and binary forms, with or
+*     without modification, are permitted provided that the following
+*     conditions are met:
+*
+*     - Redistributions of source code must retain the above copyright
+*       notice, this list of conditions and the following disclaimer.
+*
+*     - Redistributions in binary form must reproduce the above
+*       copyright notice, this list of conditions and the following
+*       disclaimer in the documentation and/or other materials
+*       provided with the distribution.
+*
+*     - Neither the name of the {organization} nor the names of its
+*       contributors may be used to endorse or promote products
+*       derived from this software without specific prior written
+*       permission.
+*
+*     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
+*     CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
+*     INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+*     MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+*     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+*     CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+*     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+*     LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+*     USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+*     AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+*     LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
+*     IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
+*     THE POSSIBILITY OF SUCH DAMAGE.
+
+*  Bugs:
+*     {note_any_bugs_here}
+*-
+*/
+
+#include "hdf5.h"
+
+#include "ems.h"
+#include "sae_par.h"
+
+#include "hds1.h"
+#include "dat1.h"
+#include "hds.h"
+
+int
+dat1GetStructureDims( const HDSLoc * locator, int maxdims, hdsdim dims[], int *status ) {
+
+  size_t actdims = 0;
+  if (*status != SAI__OK) return actdims;
+  if (!H5Aexists(locator->group_id, HDS__ATTR_STRUCT_DIMS)) return actdims;
+
+  dat1GetAttrHdsdims( locator->group_id, HDS__ATTR_STRUCT_DIMS, HDS_FALSE,
+                      0, NULL, maxdims, dims, &actdims, status );
+  return actdims;
+}

dat1New.c

@@ -177,9 +177,6 @@ dat1New( const HDSLoc    *locator,
     /* Actual data type of the structure/group must be stored in an attribute */
     dat1SetAttrString( group_id, HDS__ATTR_STRUCT_TYPE, groupstr, status );
 
-    /* Also store the number of dimensions */
-    dat1SetAttrInt( group_id, HDS__ATTR_STRUCT_NDIMS, ndim, status );
-
     if (ndim > 0) {
       /* HDF5 can not define an array of structures so we create a collection
          of groups below the parent group. */

datCell.c

@@ -152,11 +152,12 @@ datCell(const HDSLoc *locator1, int ndim, const hdsdim subs[],
     hdsdim groupsub[DAT__MXDIM];
 
     if (locator1->vectorized > 0) {
-
+      hdsdim structdims[DAT__MXDIM];
       /* If this locator is vectorized then the name will be incorrect
          if we naively calculate the name. */
-      /* Assume scalar structure if we are missing the attribute */
-      rank = dat1GetAttrInt( locator1->group_id, HDS__ATTR_STRUCT_NDIMS, HDS_TRUE, 0, status );
+
+      /* Get the dimensionality */
+      rank = dat1GetStructureDims( locator1, DAT__MXDIM, structdims, status );
 
       if (rank == 0) {
         /* So the group is really a scalar so we just need to clone the
@@ -169,16 +170,6 @@ datCell(const HDSLoc *locator1, int ndim, const hdsdim subs[],
 
       } else if (rank > 1) {
         /* Map vectorized index to underlying dimensionality */
-        size_t actvals;
-        hdsdim structdims[DAT__MXDIM];
-        dat1GetAttrHdsdims( locator1->group_id, HDS__ATTR_STRUCT_DIMS, HDS_FALSE,
-                            0, NULL, DAT__MXDIM, structdims, &actvals, status );
-        if (rank != (int)actvals) {
-          *status = DAT__DIMIN;
-          emsRepf("datshape_1b", "datCell: Inconsistency in object dimensions of structure (%d != %zu)",
-                  status, rank, actvals);
-          goto CLEANUP;
-        }
         dat1Index2Coords( subs[0], rank, structdims, groupsub, status );
         ndim = rank;
       } else {