PDI 0.6.1

Data exchange made easy

data_descriptor.h
1 /*******************************************************************************
2  * Copyright (C) 2015-2019 Commissariat a l'energie atomique et aux energies alternatives (CEA)
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  * * Redistributions of source code must retain the above copyright
8  * notice, this list of conditions and the following disclaimer.
9  * * Redistributions in binary form must reproduce the above copyright
10  * notice, this list of conditions and the following disclaimer in the
11  * documentation and/or other materials provided with the distribution.
12  * * Neither the name of CEA nor the names of its contributors may be used to
13  * endorse or promote products derived from this software without specific
14  * prior written permission.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22  * THE SOFTWARE.
23  ******************************************************************************/
24 
25 #ifndef PDI_DATA_DESCRIPTOR_H_
26 #define PDI_DATA_DESCRIPTOR_H_
27 
28 #include <string>
29 
30 #include <paraconf.h>
31 
32 #include <pdi/pdi_fwd.h>
33 #include <pdi/datatype_template.h>
34 #include <pdi/ref_any.h>
35 
36 
37 namespace PDI {
38 
39 class PDI_EXPORT Data_descriptor
40 {
41 public:
42 
43  virtual ~Data_descriptor();
44 
50  virtual void default_type(Datatype_template_uptr type) = 0;
51 
57  virtual Datatype_template_uptr default_type() = 0;
58 
61  virtual bool metadata() const = 0;
62 
67  virtual void metadata(bool metadata) = 0;
68 
71  virtual const std::string& name() const = 0;
72 
75  virtual Ref ref() = 0;
76 
81  virtual bool empty() = 0;
82 
88  virtual void share(void* data, bool read, bool write) = 0;
89 
96  virtual void* share(Ref ref, bool read, bool write) = 0;
97 
101  virtual void release() = 0;
102 
107  virtual void* reclaim() = 0;
108 
109 }; // class Data_descriptor
110 
111 } // namespace PDI
112 
113 #endif // PDI_DATA_DESCRIPTOR_H_
A dynamically typed reference to data with automatic memory management and read/write locking semanti...
Definition: pdi_fwd.h:77
std::unique_ptr< Datatype_template > Datatype_template_uptr
Definition: pdi_fwd.h:58
Definition: data_descriptor.h:39
Definition: array_datatype.h:33