-
Notifications
You must be signed in to change notification settings - Fork 1
/
dat1GetAttrBool.c
141 lines (118 loc) · 4.21 KB
/
dat1GetAttrBool.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
/*
*+
* Name:
* dat1GetAttrBool
* Purpose:
* Retrieve boolean scalar from an attribute
* Language:
* Starlink ANSI C
* Type of Module:
* Library routine
* Invocation:
* dat1GetAttrBool( hid_t objid, const char * attrname, hdsbool_t usedef,
* hdsbool_t defval, int *status);
* Arguments:
* objid = hid_t (Given)
* HDF5 object containing the attribute.
* attrname = const char * (Given)
* Name of attribute.
* usedef = hdsbool_t (Given)
* If the attribute is missing, use the default value
* if this parameter is true.
* defval = hdsbool_t (Given)
* Default value to use for the attribute. Only used if
* usedef is true.
* status = int* (Given and Returned)
* Pointer to global status.
* Description:
* Read a scalar boolean from the named attribute and return it. Use
* a default value if the attribute is missing.
* Returned Value:
* Returns the hdsbool_t boolean from the attribute (or default).
* Authors:
* TIMJ: Tim Jenness (Cornell)
* {enter_new_authors_here}
* Notes:
* - Assuming there is not a bug in the HDSv5 library, the main reason
* the attribute could be missing is if an HDF5 file not created in HDS
* was given to the HDSv5 library.
* History:
* 2014-11-17 (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"
#include "dat_err.h"
hdsbool_t
dat1GetAttrBool( hid_t objid, const char * attrname, hdsbool_t usedef,
hdsbool_t defval, int *status) {
hdsbool_t existed = HDS_FALSE;
hdsbool_t retval = HDS_FALSE;
unsigned char bvalue;
hid_t attrtype = 0;
if (*status != SAI__OK) return retval;
CALLHDFE( hid_t, attrtype,
H5Tcopy(H5T_NATIVE_B8),
DAT__HDF5E,
emsRepf("dat1GetAttrBool_1", "Error copying data type during reading of attribute '%s'", status, attrname );
);
existed = dat1GetAttr( objid, attrname, attrtype, 1, &bvalue, NULL,
status );
if (*status == SAI__OK) {
if (!existed) {
if (usedef) {
retval = defval;
} else {
*status = DAT__OBJIN;
emsRepf("dat1GetAttrBool", "Could not retrieve mandatory boolean attribute from '%s'", status, attrname);
}
} else {
retval = ( bvalue == 0 ? HDS_FALSE : HDS_TRUE );
}
}
CLEANUP:
if (attrtype > 0) H5Tclose(attrtype);
return retval;
}