PDI 1.1.0

Data exchange made easy

context.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_CONTEXT_H_
26 #define PDI_CONTEXT_H_
27 
28 #include <functional>
29 #include <memory>
30 #include <string>
31 #include <unordered_map>
32 
33 #include <pdi/pdi_fwd.h>
34 #include <pdi/callbacks.h>
35 #include <pdi/data_descriptor.h>
36 #include <pdi/datatype_template.h>
37 #include <pdi/ref_any.h>
38 
39 
40 namespace PDI {
41 
42 class PDI_EXPORT Context
43 {
44 public:
47  class Iterator
48  {
49  friend class Context;
51  std::unordered_map<std::string, std::unique_ptr<Data_descriptor>>::iterator m_data;
52  Iterator(const std::unordered_map<std::string, std::unique_ptr<Data_descriptor>>::iterator& data);
53  Iterator(std::unordered_map<std::string, std::unique_ptr<Data_descriptor>>::iterator&& data);
54  public:
55  Data_descriptor* operator-> ();
56  Data_descriptor& operator* ();
57  Iterator& operator++ ();
58  bool operator!= (const Iterator&);
59  };
60 
63  typedef std::function<Datatype_template_uptr(Context&, PC_tree_t)> Datatype_template_parser;
64 
65 protected:
66  Iterator get_iterator(const std::unordered_map<std::string, std::unique_ptr<Data_descriptor>>::iterator& data);
67 
68  Iterator get_iterator(std::unordered_map<std::string, std::unique_ptr<Data_descriptor>>::iterator&& data);
69 
70 public:
71  virtual ~Context();
72 
75  virtual Data_descriptor& desc(const std::string& name) = 0;
76 
79  virtual Data_descriptor& desc(const char* name) = 0;
80 
83  virtual Data_descriptor& operator[](const std::string& name) = 0;
84 
87  virtual Data_descriptor& operator[](const char* name) = 0;
88 
91  virtual Iterator begin() = 0;
92 
95  virtual Iterator end() = 0;
96 
100  virtual void event(const char* name) = 0;
101 
105  virtual Logger_sptr logger() const = 0;
106 
110  virtual Callbacks& callbacks() = 0;
111 
117  virtual Datatype_template_uptr datatype(PC_tree_t node) = 0;
118 
124  virtual void add_datatype(const std::string& name, Datatype_template_parser parser) = 0;
125 
127  virtual void finalize_and_exit() = 0;
128 };
129 
130 } // namespace PDI
131 
132 #endif // PDI_CONTEXT_H_
Definition: context.h:42
std::shared_ptr< spdlog::logger > Logger_sptr
A shared pointer to a logger instance.
Definition: pdi_fwd.h:83
std::unique_ptr< Datatype_template > Datatype_template_uptr
Definition: pdi_fwd.h:74
Definition: callbacks.h:38
Definition: data_descriptor.h:39
An iterator used to go through the descriptor store.
Definition: context.h:47
Definition: array_datatype.h:37
std::function< Datatype_template_uptr(Context &, PC_tree_t)> Datatype_template_parser
A function that parses a PC_tree_t to create a datatype_template.
Definition: context.h:63