blob: 7b6cbead3b01a56410edff43c73cf0c1234cfffe (
plain)
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
|
// C++ informative line for the emacs editor: -*- C++ -*-
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* Copyright by the Board of Trustees of the University of Illinois. *
* All rights reserved. *
* *
* This file is part of HDF5. The full HDF5 copyright notice, including *
* terms governing use, modification, and redistribution, is contained in *
* the files COPYING and Copyright.html. COPYING can be found at the root *
* of the source code distribution tree; Copyright.html can be found at the *
* root level of an installed copy of the electronic HDF5 document set and *
* is linked from the top-level documents page. It can also be found at *
* http://hdf.ncsa.uiuc.edu/HDF5/doc/Copyright.html. If you do not have *
* access to either file, you may request a copy from hdfhelp@ncsa.uiuc.edu. *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
#ifndef _IdComponent_H
#define _IdComponent_H
// IdComponent provides a mechanism to handle
// reference counting for an identifier of any HDF5 object.
#ifndef H5_NO_NAMESPACE
namespace H5 {
#endif
class H5_DLLCPP IdComponent {
public:
// Parent classes must reset the current IdComponent copy
// before setting new id to control reference count
void setId( hid_t new_id );
// Pure virtual function so appropriate close function can
// be called by subclasses' for the corresponding object
virtual void p_close() const = 0;
// Creates an object to hold an HDF5 identifier
IdComponent( const hid_t h5_id );
// Copy constructor: makes copy of the original IdComponent object.
IdComponent( const IdComponent& original );
// Gets the value of IdComponent's data member
virtual hid_t getId () const;
// Increment reference counter
void incRefCount();
// Decrement reference counter
void decRefCount();
// Get the reference counter to this identifier
int getCounter();
// Decrements the reference counter then determines if there are no more
// reference to this object
bool noReference();
// Assignment operator
IdComponent& operator=( const IdComponent& rhs );
void reset();
void resetId();
// Destructor
virtual ~IdComponent();
protected:
hid_t id; // HDF5 object id
RefCounter* ref_count; // used to keep track of the
// number of copies of an object
// Default constructor
IdComponent();
// Gets the id of the H5 file in which the given object is located.
hid_t p_get_file_id();
// Creates a reference to an HDF5 object or a dataset region.
void* p_reference(const char* name, hid_t space_id, H5R_type_t ref_type) const;
// Retrieves the type of object that an object reference points to.
H5G_obj_t p_get_obj_type(void *ref, H5R_type_t ref_type) const;
// Retrieves a dataspace with the region pointed to selected.
hid_t p_get_region(void *ref, H5R_type_t ref_type) const;
}; // end class IdComponent
#ifndef H5_NO_NAMESPACE
}
#endif
#endif
|
