source: XIOS/dev/dev_olga/src/declare_ref_func.hpp @ 983

Last change on this file since 983 was 962, checked in by mhnguyen, 8 years ago

Improving name-search in inheritance tree

+) If there is no name defined in a inheritance tree, id of the ancestor will be used

Test
+) Ok

  • Property svn:executable set to *
File size: 7.9 KB
Line 
1/*!
2   \file declare_ref_func.hpp
3   \author Ha NGUYEN
4   \date 02 Dec 2014
5   \since 02 Dec 2014
6
7   \brief Macros to add functions used to solve references in class CDomain, CAxis and CField
8 */
9#ifndef __XIOS_DECLARE_REF_FUNC_HPP__
10#define __XIOS_DECLARE_REF_FUNC_HPP__
11
12// Declarations
13
14#define DECLARE_REF_FUNC(type, name_)                       \
15public:                                                     \
16  void solveRefInheritance(bool apply = true);              \
17  void removeRefInheritance();                              \
18  bool hasDirect##type##Reference(void) const;              \
19  C##type* getDirect##type##Reference(void) const;          \
20  const StdString get##type##OutputName(void) const;        \
21  void setAttributesReference(bool apply = true);           \
22  bool hasRefTo(C##type* ref) const;                        \
23                                                                       \
24private:                                                               \
25  std::vector<C##type*> refObjects;
26
27// Definitions
28
29#define DEFINE_REF_FUNC(type, name_)                                   \
30void C##type::solveRefInheritance(bool apply)                          \
31{                                                                      \
32  std::set<C##type*> tmpRefObjects;                                    \
33  C##type* refer_ptr = this;                                           \
34  std::vector<C##type*>().swap(refObjects);                            \
35  refObjects.push_back(this);                                          \
36                                                                       \
37  while (refer_ptr->hasDirect##type##Reference())                      \
38  {                                                                    \
39    tmpRefObjects.insert(refer_ptr);                                   \
40                                                                       \
41    refer_ptr = refer_ptr->getDirect##type##Reference();               \
42                                                                       \
43    if (tmpRefObjects.end() != tmpRefObjects.find(refer_ptr))          \
44    {                                                                  \
45      ERROR("void C" #type "::solveRefInheritance(bool apply)",        \
46            << "Circular dependency stopped for " #name_ " object "    \
47            << "with id = \"" << refer_ptr->getId() << "\".");         \
48    }                                                                  \
49                                                                       \
50    refObjects.push_back(refer_ptr);                                   \
51    SuperClassAttribute::setAttributes(refer_ptr, apply);              \
52  }                                                                    \
53}                                                                      \
54                                                                       \
55void C##type::setAttributesReference(bool apply)                       \
56{                                                                      \
57  for (int i = 1; i < refObjects.size(); ++i)                          \
58    refObjects[i]->setAttributes(refObjects[i-1], apply);              \
59  if (refObjects.size() > 1)                                           \
60    refObjects[refObjects.size()-1]->removeRefInheritance();           \
61}                                                                      \
62                                                                       \
63void C##type::removeRefInheritance()                                   \
64{                                                                      \
65  if (!this->name_##_ref.isEmpty())                                    \
66    this->name_##_ref.reset();                                         \
67}                                                                      \
68                                                                       \
69bool C##type::hasDirect##type##Reference(void) const                   \
70{                                                                      \
71  return !this->name_##_ref.isEmpty();                                 \
72}                                                                      \
73                                                                       \
74C##type* C##type::getDirect##type##Reference(void) const               \
75{                                                                      \
76  if (this->name_##_ref.isEmpty())                                     \
77    ERROR("C" #type "* C" #type "::getDirect" #type "Reference(void)", \
78          << "The " #name_ " with id = '" << getId() << "'"            \
79          << " has no " #name_ "_ref.");                               \
80                                                                       \
81  if (!C##type::has(this->name_##_ref))                                \
82    ERROR("C" #type "* C" #type "::getDirect" #type "Reference(void)", \
83          << this->name_##_ref                                         \
84          << " refers to an unknown " #name_ " id.");                  \
85                                                                       \
86  return C##type::get(this->name_##_ref);                              \
87}                                                                      \
88                                                                       \
89const StdString C##type::get##type##OutputName(void) const            \
90{                                                                      \
91  if (!this->name.isEmpty())                                           \
92    return this->name;                                                 \
93  else if (hasDirect##type##Reference())                               \
94  {                                                                    \
95    const C##type* refer_ptr = this, *tmp_ptr;                         \
96    StdString nameRef = this->name_##_ref;                             \
97    std::set<const C##type*> tmpRefObjects;                                  \
98    while (refer_ptr->hasAutoGeneratedId() &&                          \
99          (C##type::has(nameRef)))                                     \
100    {                                                                  \
101      tmpRefObjects.insert(refer_ptr);                                 \
102      tmp_ptr = refer_ptr;                                             \
103      refer_ptr = tmp_ptr->getDirect##type##Reference();               \
104      if (refer_ptr->hasDirect##type##Reference())                     \
105        nameRef = refer_ptr->name_##_ref;                              \
106      if (tmpRefObjects.end() != tmpRefObjects.find(refer_ptr))        \
107      {                                                                \
108        ERROR("const StdString& C" #type "::get" #type "OutputName(void) const ",      \
109              << "Circular dependency stopped for " #name_ " object "  \
110              << "with id = \"" << refer_ptr->getId() << "\".");       \
111      }                                                                \
112    }                                                                  \
113    return nameRef;                                                    \
114  }                                                                    \
115  else                                                                 \
116    return getId();                                                    \
117}                                                                      \
118                                                                       \
119bool C##type::hasRefTo(C##type* ref) const                             \
120{                                                                      \
121  bool found = false;                                                  \
122  for (int idx = 0; idx < refObjects.size(); ++idx)                    \
123    if (ref == refObjects[idx]) { found = true; break; }                \
124  return found;                                                        \
125}
126
127#endif // __XIOS_DECLARE_REF_FUNC_HPP__
Note: See TracBrowser for help on using the repository browser.